armdeviceprovisioningservices

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2021 License: MIT Imports: 16 Imported by: 8

README

Azure Device Provisioning Service Module for Go

PkgGoDev

The armdeviceprovisioningservices module provides operations for working with Azure Device Provisioning Service.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Device Provisioning Service module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Device Provisioning Service. 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 Device Provisioning Service 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 := armdeviceprovisioningservices.NewIotDpsResourceClient(<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 := armdeviceprovisioningservices.NewIotDpsResourceClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Device Provisioning Service 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 AccessRightsDescription 

type AccessRightsDescription string

AccessRightsDescription - Rights that this key has. 

const (
	AccessRightsDescriptionDeviceConnect           AccessRightsDescription = "DeviceConnect"
	AccessRightsDescriptionEnrollmentRead          AccessRightsDescription = "EnrollmentRead"
	AccessRightsDescriptionEnrollmentWrite         AccessRightsDescription = "EnrollmentWrite"
	AccessRightsDescriptionRegistrationStatusRead  AccessRightsDescription = "RegistrationStatusRead"
	AccessRightsDescriptionRegistrationStatusWrite AccessRightsDescription = "RegistrationStatusWrite"
	AccessRightsDescriptionServiceConfig           AccessRightsDescription = "ServiceConfig"
)

func PossibleAccessRightsDescriptionValues 

func PossibleAccessRightsDescriptionValues() []AccessRightsDescription

PossibleAccessRightsDescriptionValues returns the possible values for the AccessRightsDescription const type.

func (AccessRightsDescription) ToPtr 

func (c AccessRightsDescription) ToPtr() *AccessRightsDescription

ToPtr returns a *AccessRightsDescription pointing to the current value.

type AllocationPolicy 

type AllocationPolicy string

AllocationPolicy - Allocation policy to be used by this provisioning service. 

const (
	AllocationPolicyGeoLatency AllocationPolicy = "GeoLatency"
	AllocationPolicyHashed     AllocationPolicy = "Hashed"
	AllocationPolicyStatic     AllocationPolicy = "Static"
)

func PossibleAllocationPolicyValues 

func PossibleAllocationPolicyValues() []AllocationPolicy

PossibleAllocationPolicyValues returns the possible values for the AllocationPolicy const type.

func (AllocationPolicy) ToPtr 

func (c AllocationPolicy) ToPtr() *AllocationPolicy

ToPtr returns a *AllocationPolicy pointing to the current value.

type AsyncOperationResult 

type AsyncOperationResult struct {
	// Error message containing code, description and details
	Error *ErrorMesssage `json:"error,omitempty"`

	// current status of a long running operation.
	Status *string `json:"status,omitempty"`
}

AsyncOperationResult - Result of a long running operation.

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 CertificateListDescription 

type CertificateListDescription struct {
	// The array of Certificate objects.
	Value []*CertificateResponse `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 {
	// READ-ONLY; base-64 representation of X509 certificate .cer file or just .pem file content.
	Certificate []byte `json:"certificate,omitempty" azure:"ro"`

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

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

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

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

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

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

CertificateProperties - The description of an X509 CA Certificate.

func (CertificateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateProperties.

func (*CertificateProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateProperties.

type CertificatePurpose 

type CertificatePurpose string
const (
	CertificatePurposeClientAuthentication CertificatePurpose = "clientAuthentication"
	CertificatePurposeServerAuthentication CertificatePurpose = "serverAuthentication"
)

func PossibleCertificatePurposeValues 

func PossibleCertificatePurposeValues() []CertificatePurpose

PossibleCertificatePurposeValues returns the possible values for the CertificatePurpose const type.

func (CertificatePurpose) ToPtr 

func (c CertificatePurpose) ToPtr() *CertificatePurpose

ToPtr returns a *CertificatePurpose pointing to the current value.

type CertificateResponse 

type CertificateResponse struct {
	// properties of a 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"`
}

CertificateResponse - The X509 Certificate.

type DpsCertificateClient 

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

DpsCertificateClient contains the methods for the DpsCertificate group. Don't use this type directly, use NewDpsCertificateClient() instead.

func NewDpsCertificateClient 

func NewDpsCertificateClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DpsCertificateClient

NewDpsCertificateClient creates a new instance of DpsCertificateClient with the specified values.

func (*DpsCertificateClient) CreateOrUpdate 

func (client *DpsCertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, certificateName string, certificateDescription CertificateBodyDescription, options *DpsCertificateCreateOrUpdateOptions) (DpsCertificateCreateOrUpdateResponse, error)

CreateOrUpdate - Add new certificate or update an existing certificate. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSCertificateCreateOrUpdate.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewDpsCertificateClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<provisioning-service-name>",
		"<certificate-name>",
		armdeviceprovisioningservices.CertificateBodyDescription{
			Certificate: to.StringPtr("<certificate>"),
		},
		&armdeviceprovisioningservices.DpsCertificateCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("CertificateResponse.ID: %s\n", *res.ID)
}

Output:

func (*DpsCertificateClient) Delete 

func (client *DpsCertificateClient) Delete(ctx context.Context, resourceGroupName string, ifMatch string, provisioningServiceName string, certificateName string, options *DpsCertificateDeleteOptions) (DpsCertificateDeleteResponse, error)

Delete - Deletes the specified certificate associated with the Provisioning Service If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSDeleteCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewDpsCertificateClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<if-match>",
		"<provisioning-service-name>",
		"<certificate-name>",
		&armdeviceprovisioningservices.DpsCertificateDeleteOptions{CertificateName1: nil,
			CertificateIsVerified:    nil,
			CertificatePurpose:       nil,
			CertificateCreated:       nil,
			CertificateLastUpdated:   nil,
			CertificateHasPrivateKey: nil,
			CertificateNonce:         nil,
		})
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DpsCertificateClient) GenerateVerificationCode 

func (client *DpsCertificateClient) GenerateVerificationCode(ctx context.Context, certificateName string, ifMatch string, resourceGroupName string, provisioningServiceName string, options *DpsCertificateGenerateVerificationCodeOptions) (DpsCertificateGenerateVerificationCodeResponse, error)

GenerateVerificationCode - Generate verification code for Proof of Possession. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGenerateVerificationCode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewDpsCertificateClient("<subscription-id>", cred, nil)
	res, err := client.GenerateVerificationCode(ctx,
		"<certificate-name>",
		"<if-match>",
		"<resource-group-name>",
		"<provisioning-service-name>",
		&armdeviceprovisioningservices.DpsCertificateGenerateVerificationCodeOptions{CertificateName1: nil,
			CertificateIsVerified:    nil,
			CertificatePurpose:       nil,
			CertificateCreated:       nil,
			CertificateLastUpdated:   nil,
			CertificateHasPrivateKey: nil,
			CertificateNonce:         nil,
		})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("VerificationCodeResponse.ID: %s\n", *res.ID)
}

Output:

func (*DpsCertificateClient) Get 

func (client *DpsCertificateClient) Get(ctx context.Context, certificateName string, resourceGroupName string, provisioningServiceName string, options *DpsCertificateGetOptions) (DpsCertificateGetResponse, error)

Get - Get the certificate from the provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewDpsCertificateClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<certificate-name>",
		"<resource-group-name>",
		"<provisioning-service-name>",
		&armdeviceprovisioningservices.DpsCertificateGetOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("CertificateResponse.ID: %s\n", *res.ID)
}

Output:

func (*DpsCertificateClient) List 

func (client *DpsCertificateClient) List(ctx context.Context, resourceGroupName string, provisioningServiceName string, options *DpsCertificateListOptions) (DpsCertificateListResponse, error)

List - Get all the certificates tied to the provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetCertificates.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

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

Output:

func (*DpsCertificateClient) VerifyCertificate 

func (client *DpsCertificateClient) VerifyCertificate(ctx context.Context, certificateName string, ifMatch string, resourceGroupName string, provisioningServiceName string, request VerificationCodeRequest, options *DpsCertificateVerifyCertificateOptions) (DpsCertificateVerifyCertificateResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSVerifyCertificate.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewDpsCertificateClient("<subscription-id>", cred, nil)
	res, err := client.VerifyCertificate(ctx,
		"<certificate-name>",
		"<if-match>",
		"<resource-group-name>",
		"<provisioning-service-name>",
		armdeviceprovisioningservices.VerificationCodeRequest{
			Certificate: to.StringPtr("<certificate>"),
		},
		&armdeviceprovisioningservices.DpsCertificateVerifyCertificateOptions{CertificateName1: nil,
			CertificateIsVerified:    nil,
			CertificatePurpose:       nil,
			CertificateCreated:       nil,
			CertificateLastUpdated:   nil,
			CertificateHasPrivateKey: nil,
			CertificateNonce:         nil,
		})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("CertificateResponse.ID: %s\n", *res.ID)
}

Output:

type DpsCertificateCreateOrUpdateOptions 

type DpsCertificateCreateOrUpdateOptions struct {
	// ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
	IfMatch *string
}

DpsCertificateCreateOrUpdateOptions contains the optional parameters for the DpsCertificate.CreateOrUpdate method.

type DpsCertificateCreateOrUpdateResponse 

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

DpsCertificateCreateOrUpdateResponse contains the response from method DpsCertificate.CreateOrUpdate.

type DpsCertificateCreateOrUpdateResult 

type DpsCertificateCreateOrUpdateResult struct {
	CertificateResponse
}

DpsCertificateCreateOrUpdateResult contains the result from method DpsCertificate.CreateOrUpdate.

type DpsCertificateDeleteOptions 

type DpsCertificateDeleteOptions struct {
	// Time the certificate is created.
	CertificateCreated *time.Time
	// Indicates if the certificate contains a private key.
	CertificateHasPrivateKey *bool
	// Indicates if certificate has been verified by owner of the private key.
	CertificateIsVerified *bool
	// Time the certificate is last updated.
	CertificateLastUpdated *time.Time
	// This is optional, and it is the Common Name of the certificate.
	CertificateName1 *string
	// Random number generated to indicate Proof of Possession.
	CertificateNonce *string
	// A description that mentions the purpose of the certificate.
	CertificatePurpose *CertificatePurpose
	// Raw data within the certificate.
	CertificateRawBytes []byte
}

DpsCertificateDeleteOptions contains the optional parameters for the DpsCertificate.Delete method.

type DpsCertificateDeleteResponse 

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

DpsCertificateDeleteResponse contains the response from method DpsCertificate.Delete.

type DpsCertificateGenerateVerificationCodeOptions 

type DpsCertificateGenerateVerificationCodeOptions struct {
	// Certificate creation time.
	CertificateCreated *time.Time
	// Indicates if the certificate contains private key.
	CertificateHasPrivateKey *bool
	// Indicates if the certificate has been verified by owner of the private key.
	CertificateIsVerified *bool
	// Certificate last updated time.
	CertificateLastUpdated *time.Time
	// Common Name for the certificate.
	CertificateName1 *string
	// Random number generated to indicate Proof of Possession.
	CertificateNonce *string
	// Description mentioning the purpose of the certificate.
	CertificatePurpose *CertificatePurpose
	// Raw data of certificate.
	CertificateRawBytes []byte
}

DpsCertificateGenerateVerificationCodeOptions contains the optional parameters for the DpsCertificate.GenerateVerificationCode method.

type DpsCertificateGenerateVerificationCodeResponse 

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

DpsCertificateGenerateVerificationCodeResponse contains the response from method DpsCertificate.GenerateVerificationCode.

type DpsCertificateGenerateVerificationCodeResult 

type DpsCertificateGenerateVerificationCodeResult struct {
	VerificationCodeResponse
}

DpsCertificateGenerateVerificationCodeResult contains the result from method DpsCertificate.GenerateVerificationCode.

type DpsCertificateGetOptions 

type DpsCertificateGetOptions struct {
	// ETag of the certificate.
	IfMatch *string
}

DpsCertificateGetOptions contains the optional parameters for the DpsCertificate.Get method.

type DpsCertificateGetResponse 

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

DpsCertificateGetResponse contains the response from method DpsCertificate.Get.

type DpsCertificateGetResult 

type DpsCertificateGetResult struct {
	CertificateResponse
}

DpsCertificateGetResult contains the result from method DpsCertificate.Get.

type DpsCertificateListOptions 

type DpsCertificateListOptions struct {
}

DpsCertificateListOptions contains the optional parameters for the DpsCertificate.List method.

type DpsCertificateListResponse 

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

DpsCertificateListResponse contains the response from method DpsCertificate.List.

type DpsCertificateListResult 

type DpsCertificateListResult struct {
	CertificateListDescription
}

DpsCertificateListResult contains the result from method DpsCertificate.List.

type DpsCertificateVerifyCertificateOptions 

type DpsCertificateVerifyCertificateOptions struct {
	// Certificate creation time.
	CertificateCreated *time.Time
	// Indicates if the certificate contains private key.
	CertificateHasPrivateKey *bool
	// Indicates if the certificate has been verified by owner of the private key.
	CertificateIsVerified *bool
	// Certificate last updated time.
	CertificateLastUpdated *time.Time
	// Common Name for the certificate.
	CertificateName1 *string
	// Random number generated to indicate Proof of Possession.
	CertificateNonce *string
	// Describe the purpose of the certificate.
	CertificatePurpose *CertificatePurpose
	// Raw data of certificate.
	CertificateRawBytes []byte
}

DpsCertificateVerifyCertificateOptions contains the optional parameters for the DpsCertificate.VerifyCertificate method.

type DpsCertificateVerifyCertificateResponse 

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

DpsCertificateVerifyCertificateResponse contains the response from method DpsCertificate.VerifyCertificate.

type DpsCertificateVerifyCertificateResult 

type DpsCertificateVerifyCertificateResult struct {
	CertificateResponse
}

DpsCertificateVerifyCertificateResult contains the result from method DpsCertificate.VerifyCertificate.

type ErrorDetails 

type ErrorDetails struct {

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

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

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

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

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

func (ErrorDetails) Error 

func (e ErrorDetails) Error() string

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

type ErrorMesssage 

type ErrorMesssage struct {
	// standard error code
	Code *string `json:"code,omitempty"`

	// detailed summary of error
	Details *string `json:"details,omitempty"`

	// standard error description
	Message *string `json:"message,omitempty"`
}

ErrorMesssage - Error response containing message and code.

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 a provisioning service

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

	// Target for requests captured by this rule.
	Target *IPFilterTargetType `json:"target,omitempty"`
}

IPFilterRule - The IP filter rules for a provisioning Service.

type IPFilterTargetType 

type IPFilterTargetType string

IPFilterTargetType - Target for requests captured by this rule. 

const (
	IPFilterTargetTypeAll        IPFilterTargetType = "all"
	IPFilterTargetTypeServiceAPI IPFilterTargetType = "serviceApi"
	IPFilterTargetTypeDeviceAPI  IPFilterTargetType = "deviceApi"
)

func PossibleIPFilterTargetTypeValues 

func PossibleIPFilterTargetTypeValues() []IPFilterTargetType

PossibleIPFilterTargetTypeValues returns the possible values for the IPFilterTargetType const type.

func (IPFilterTargetType) ToPtr 

func (c IPFilterTargetType) ToPtr() *IPFilterTargetType

ToPtr returns a *IPFilterTargetType pointing to the current value.

type IotDpsPropertiesDescription 

type IotDpsPropertiesDescription struct {
	// Allocation policy to be used by this provisioning service.
	AllocationPolicy *AllocationPolicy `json:"allocationPolicy,omitempty"`

	// List of authorization keys for a provisioning service.
	AuthorizationPolicies []*SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"`

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

	// List of IoT hubs associated with this provisioning service.
	IotHubs []*IotHubDefinitionDescription `json:"iotHubs,omitempty"`

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

	// The ARM provisioning state of the provisioning service.
	ProvisioningState *string `json:"provisioningState,omitempty"`

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

	// Current state of the provisioning service.
	State *State `json:"state,omitempty"`

	// READ-ONLY; Device endpoint for this provisioning service.
	DeviceProvisioningHostName *string `json:"deviceProvisioningHostName,omitempty" azure:"ro"`

	// READ-ONLY; Unique identifier of this provisioning service.
	IDScope *string `json:"idScope,omitempty" azure:"ro"`

	// READ-ONLY; Service endpoint for provisioning service.
	ServiceOperationsHostName *string `json:"serviceOperationsHostName,omitempty" azure:"ro"`
}

IotDpsPropertiesDescription - the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope

func (IotDpsPropertiesDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IotDpsPropertiesDescription.

type IotDpsResourceBeginCreateOrUpdateOptions 

type IotDpsResourceBeginCreateOrUpdateOptions struct {
}

IotDpsResourceBeginCreateOrUpdateOptions contains the optional parameters for the IotDpsResource.BeginCreateOrUpdate method.

type IotDpsResourceBeginCreateOrUpdatePrivateEndpointConnectionOptions 

type IotDpsResourceBeginCreateOrUpdatePrivateEndpointConnectionOptions struct {
}

IotDpsResourceBeginCreateOrUpdatePrivateEndpointConnectionOptions contains the optional parameters for the IotDpsResource.BeginCreateOrUpdatePrivateEndpointConnection method.

type IotDpsResourceBeginDeleteOptions 

type IotDpsResourceBeginDeleteOptions struct {
}

IotDpsResourceBeginDeleteOptions contains the optional parameters for the IotDpsResource.BeginDelete method.

type IotDpsResourceBeginDeletePrivateEndpointConnectionOptions 

type IotDpsResourceBeginDeletePrivateEndpointConnectionOptions struct {
}

IotDpsResourceBeginDeletePrivateEndpointConnectionOptions contains the optional parameters for the IotDpsResource.BeginDeletePrivateEndpointConnection method.

type IotDpsResourceBeginUpdateOptions 

type IotDpsResourceBeginUpdateOptions struct {
}

IotDpsResourceBeginUpdateOptions contains the optional parameters for the IotDpsResource.BeginUpdate method.

type IotDpsResourceCheckProvisioningServiceNameAvailabilityOptions 

type IotDpsResourceCheckProvisioningServiceNameAvailabilityOptions struct {
}

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptions contains the optional parameters for the IotDpsResource.CheckProvisioningServiceNameAvailability method.

type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse 

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

IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse contains the response from method IotDpsResource.CheckProvisioningServiceNameAvailability.

type IotDpsResourceCheckProvisioningServiceNameAvailabilityResult 

type IotDpsResourceCheckProvisioningServiceNameAvailabilityResult struct {
	NameAvailabilityInfo
}

IotDpsResourceCheckProvisioningServiceNameAvailabilityResult contains the result from method IotDpsResource.CheckProvisioningServiceNameAvailability.

type IotDpsResourceClient 

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

IotDpsResourceClient contains the methods for the IotDpsResource group. Don't use this type directly, use NewIotDpsResourceClient() instead.

func NewIotDpsResourceClient 

func NewIotDpsResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IotDpsResourceClient

NewIotDpsResourceClient creates a new instance of IotDpsResourceClient with the specified values.

func (*IotDpsResourceClient) BeginCreateOrUpdate 

func (client *IotDpsResourceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, iotDpsDescription ProvisioningServiceDescription, options *IotDpsResourceBeginCreateOrUpdateOptions) (IotDpsResourceCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSCreate.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<provisioning-service-name>",
		armdeviceprovisioningservices.ProvisioningServiceDescription{
			Resource: armdeviceprovisioningservices.Resource{
				Location: to.StringPtr("<location>"),
				Tags:     map[string]*string{},
			},
			Properties: &armdeviceprovisioningservices.IotDpsPropertiesDescription{},
			SKU: &armdeviceprovisioningservices.IotDpsSKUInfo{
				Name:     armdeviceprovisioningservices.IotDpsSKUS1.ToPtr(),
				Capacity: to.Int64Ptr(1),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ProvisioningServiceDescription.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) BeginCreateOrUpdatePrivateEndpointConnection 

func (client *IotDpsResourceClient) BeginCreateOrUpdatePrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, options *IotDpsResourceBeginCreateOrUpdatePrivateEndpointConnectionOptions) (IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse, error)

BeginCreateOrUpdatePrivateEndpointConnection - Create or update the status of a private endpoint connection with the specified name If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSCreateOrUpdatePrivateEndpointConnection.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

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

Output:

func (*IotDpsResourceClient) BeginDelete 

func (client *IotDpsResourceClient) BeginDelete(ctx context.Context, provisioningServiceName string, resourceGroupName string, options *IotDpsResourceBeginDeleteOptions) (IotDpsResourceDeletePollerResponse, error)

BeginDelete - Deletes the Provisioning Service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSDelete.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<provisioning-service-name>",
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IotDpsResourceClient) BeginDeletePrivateEndpointConnection 

func (client *IotDpsResourceClient) BeginDeletePrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *IotDpsResourceBeginDeletePrivateEndpointConnectionOptions) (IotDpsResourceDeletePrivateEndpointConnectionPollerResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSDeletePrivateEndpointConnection.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDeletePrivateEndpointConnection(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("PrivateEndpointConnection.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) BeginUpdate 

func (client *IotDpsResourceClient) BeginUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, provisioningServiceTags TagsResource, options *IotDpsResourceBeginUpdateOptions) (IotDpsResourceUpdatePollerResponse, error)

BeginUpdate - Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSPatch.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<provisioning-service-name>",
		armdeviceprovisioningservices.TagsResource{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ProvisioningServiceDescription.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) CheckProvisioningServiceNameAvailability 

func (client *IotDpsResourceClient) CheckProvisioningServiceNameAvailability(ctx context.Context, arguments OperationInputs, options *IotDpsResourceCheckProvisioningServiceNameAvailabilityOptions) (IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse, error)

CheckProvisioningServiceNameAvailability - Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSCheckNameAvailability.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/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	_, err = client.CheckProvisioningServiceNameAvailability(ctx,
		armdeviceprovisioningservices.OperationInputs{
			Name: to.StringPtr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IotDpsResourceClient) Get 

func (client *IotDpsResourceClient) Get(ctx context.Context, provisioningServiceName string, resourceGroupName string, options *IotDpsResourceGetOptions) (IotDpsResourceGetResponse, error)

Get - Get the metadata of the provisioning service without SAS keys. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<provisioning-service-name>",
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ProvisioningServiceDescription.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) GetOperationResult 

func (client *IotDpsResourceClient) GetOperationResult(ctx context.Context, operationID string, resourceGroupName string, provisioningServiceName string, asyncinfo string, options *IotDpsResourceGetOperationResultOptions) (IotDpsResourceGetOperationResultResponse, error)

GetOperationResult - Gets the status of a long running operation, such as create, update or delete a provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetOperationResult.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	_, err = client.GetOperationResult(ctx,
		"<operation-id>",
		"<resource-group-name>",
		"<provisioning-service-name>",
		"<asyncinfo>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IotDpsResourceClient) GetPrivateEndpointConnection 

func (client *IotDpsResourceClient) GetPrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *IotDpsResourceGetPrivateEndpointConnectionOptions) (IotDpsResourceGetPrivateEndpointConnectionResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetPrivateEndpointConnection(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PrivateEndpointConnection.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) GetPrivateLinkResources 

func (client *IotDpsResourceClient) GetPrivateLinkResources(ctx context.Context, resourceGroupName string, resourceName string, groupID string, options *IotDpsResourceGetPrivateLinkResourcesOptions) (IotDpsResourceGetPrivateLinkResourcesResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetPrivateLinkResources(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<group-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("GroupIDInformation.ID: %s\n", *res.ID)
}

Output:

func (*IotDpsResourceClient) ListByResourceGroup 

func (client *IotDpsResourceClient) ListByResourceGroup(resourceGroupName string, options *IotDpsResourceListByResourceGroupOptions) *IotDpsResourceListByResourceGroupPager

ListByResourceGroup - Get a list of all provisioning services in the given resource group. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

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

Output:

func (*IotDpsResourceClient) ListBySubscription 

func (client *IotDpsResourceClient) ListBySubscription(options *IotDpsResourceListBySubscriptionOptions) *IotDpsResourceListBySubscriptionPager

ListBySubscription - List all the provisioning services for a given subscription id. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("ProvisioningServiceDescription.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*IotDpsResourceClient) ListKeys 

func (client *IotDpsResourceClient) ListKeys(provisioningServiceName string, resourceGroupName string, options *IotDpsResourceListKeysOptions) *IotDpsResourceListKeysPager

ListKeys - List the primary and secondary keys for a provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSListKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	pager := client.ListKeys("<provisioning-service-name>",
		"<resource-group-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

func (*IotDpsResourceClient) ListKeysForKeyName 

func (client *IotDpsResourceClient) ListKeysForKeyName(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string, options *IotDpsResourceListKeysForKeyNameOptions) (IotDpsResourceListKeysForKeyNameResponse, error)

ListKeysForKeyName - List primary and secondary keys for a specific key name If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	_, err = client.ListKeysForKeyName(ctx,
		"<provisioning-service-name>",
		"<key-name>",
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IotDpsResourceClient) ListPrivateEndpointConnections 

func (client *IotDpsResourceClient) ListPrivateEndpointConnections(ctx context.Context, resourceGroupName string, resourceName string, options *IotDpsResourceListPrivateEndpointConnectionsOptions) (IotDpsResourceListPrivateEndpointConnectionsResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSListPrivateEndpointConnections.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

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

Output:

func (*IotDpsResourceClient) ListPrivateLinkResources 

func (client *IotDpsResourceClient) ListPrivateLinkResources(ctx context.Context, resourceGroupName string, resourceName string, options *IotDpsResourceListPrivateLinkResourcesOptions) (IotDpsResourceListPrivateLinkResourcesResponse, error)

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSListPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

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

Output:

func (*IotDpsResourceClient) ListValidSKUs 

func (client *IotDpsResourceClient) ListValidSKUs(provisioningServiceName string, resourceGroupName string, options *IotDpsResourceListValidSKUsOptions) *IotDpsResourceListValidSKUsPager

ListValidSKUs - Gets the list of valid SKUs and tiers for a provisioning service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSGetValidSku.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewIotDpsResourceClient("<subscription-id>", cred, nil)
	pager := client.ListValidSKUs("<provisioning-service-name>",
		"<resource-group-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type IotDpsResourceCreateOrUpdatePoller 

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

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

func (*IotDpsResourceCreateOrUpdatePoller) Done 

func (p *IotDpsResourceCreateOrUpdatePoller) Done() bool

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

func (*IotDpsResourceCreateOrUpdatePoller) FinalResponse 

func (p *IotDpsResourceCreateOrUpdatePoller) FinalResponse(ctx context.Context) (IotDpsResourceCreateOrUpdateResponse, 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 IotDpsResourceCreateOrUpdateResponse will be returned.

func (*IotDpsResourceCreateOrUpdatePoller) Poll 

func (p *IotDpsResourceCreateOrUpdatePoller) 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 (*IotDpsResourceCreateOrUpdatePoller) ResumeToken 

func (p *IotDpsResourceCreateOrUpdatePoller) 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 IotDpsResourceCreateOrUpdatePollerResponse 

type IotDpsResourceCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotDpsResourceCreateOrUpdatePoller

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

IotDpsResourceCreateOrUpdatePollerResponse contains the response from method IotDpsResource.CreateOrUpdate.

func (IotDpsResourceCreateOrUpdatePollerResponse) PollUntilDone 

func (l IotDpsResourceCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IotDpsResourceCreateOrUpdateResponse, 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 (*IotDpsResourceCreateOrUpdatePollerResponse) Resume 

func (l *IotDpsResourceCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *IotDpsResourceClient, token string) error

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

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller 

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

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

func (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) Done 

func (p *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) Done() bool

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

func (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) FinalResponse 

func (p *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) FinalResponse(ctx context.Context) (IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse, 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 IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse will be returned.

func (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) Poll 

func (p *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) 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 (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) ResumeToken 

func (p *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller) 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 IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse 

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPoller

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

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse contains the response from method IotDpsResource.CreateOrUpdatePrivateEndpointConnection.

func (IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse) PollUntilDone 

func (l IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse, 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 (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse) Resume 

func (l *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionPollerResponse) Resume(ctx context.Context, client *IotDpsResourceClient, token string) error

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

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse 

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

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse contains the response from method IotDpsResource.CreateOrUpdatePrivateEndpointConnection.

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResult 

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResult struct {
	PrivateEndpointConnection
}

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResult contains the result from method IotDpsResource.CreateOrUpdatePrivateEndpointConnection.

type IotDpsResourceCreateOrUpdateResponse 

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

IotDpsResourceCreateOrUpdateResponse contains the response from method IotDpsResource.CreateOrUpdate.

type IotDpsResourceCreateOrUpdateResult 

type IotDpsResourceCreateOrUpdateResult struct {
	ProvisioningServiceDescription
}

IotDpsResourceCreateOrUpdateResult contains the result from method IotDpsResource.CreateOrUpdate.

type IotDpsResourceDeletePoller 

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

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

func (*IotDpsResourceDeletePoller) Done 

func (p *IotDpsResourceDeletePoller) Done() bool

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

func (*IotDpsResourceDeletePoller) FinalResponse 

func (p *IotDpsResourceDeletePoller) FinalResponse(ctx context.Context) (IotDpsResourceDeleteResponse, 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 IotDpsResourceDeleteResponse will be returned.

func (*IotDpsResourceDeletePoller) Poll 

func (p *IotDpsResourceDeletePoller) 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 (*IotDpsResourceDeletePoller) ResumeToken 

func (p *IotDpsResourceDeletePoller) 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 IotDpsResourceDeletePollerResponse 

type IotDpsResourceDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotDpsResourceDeletePoller

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

IotDpsResourceDeletePollerResponse contains the response from method IotDpsResource.Delete.

func (IotDpsResourceDeletePollerResponse) PollUntilDone 

func (l IotDpsResourceDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IotDpsResourceDeleteResponse, 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 (*IotDpsResourceDeletePollerResponse) Resume 

func (l *IotDpsResourceDeletePollerResponse) Resume(ctx context.Context, client *IotDpsResourceClient, token string) error

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

type IotDpsResourceDeletePrivateEndpointConnectionPoller 

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

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

func (*IotDpsResourceDeletePrivateEndpointConnectionPoller) Done 

func (p *IotDpsResourceDeletePrivateEndpointConnectionPoller) Done() bool

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

func (*IotDpsResourceDeletePrivateEndpointConnectionPoller) FinalResponse 

func (p *IotDpsResourceDeletePrivateEndpointConnectionPoller) FinalResponse(ctx context.Context) (IotDpsResourceDeletePrivateEndpointConnectionResponse, 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 IotDpsResourceDeletePrivateEndpointConnectionResponse will be returned.

func (*IotDpsResourceDeletePrivateEndpointConnectionPoller) Poll 

func (p *IotDpsResourceDeletePrivateEndpointConnectionPoller) 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 (*IotDpsResourceDeletePrivateEndpointConnectionPoller) ResumeToken 

func (p *IotDpsResourceDeletePrivateEndpointConnectionPoller) 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 IotDpsResourceDeletePrivateEndpointConnectionPollerResponse 

type IotDpsResourceDeletePrivateEndpointConnectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotDpsResourceDeletePrivateEndpointConnectionPoller

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

IotDpsResourceDeletePrivateEndpointConnectionPollerResponse contains the response from method IotDpsResource.DeletePrivateEndpointConnection.

func (IotDpsResourceDeletePrivateEndpointConnectionPollerResponse) PollUntilDone 

func (l IotDpsResourceDeletePrivateEndpointConnectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IotDpsResourceDeletePrivateEndpointConnectionResponse, 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 (*IotDpsResourceDeletePrivateEndpointConnectionPollerResponse) Resume 

func (l *IotDpsResourceDeletePrivateEndpointConnectionPollerResponse) Resume(ctx context.Context, client *IotDpsResourceClient, token string) error

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

type IotDpsResourceDeletePrivateEndpointConnectionResponse 

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

IotDpsResourceDeletePrivateEndpointConnectionResponse contains the response from method IotDpsResource.DeletePrivateEndpointConnection.

type IotDpsResourceDeletePrivateEndpointConnectionResult 

type IotDpsResourceDeletePrivateEndpointConnectionResult struct {
	PrivateEndpointConnection
}

IotDpsResourceDeletePrivateEndpointConnectionResult contains the result from method IotDpsResource.DeletePrivateEndpointConnection.

type IotDpsResourceDeleteResponse 

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

IotDpsResourceDeleteResponse contains the response from method IotDpsResource.Delete.

type IotDpsResourceGetOperationResultOptions 

type IotDpsResourceGetOperationResultOptions struct {
}

IotDpsResourceGetOperationResultOptions contains the optional parameters for the IotDpsResource.GetOperationResult method.

type IotDpsResourceGetOperationResultResponse 

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

IotDpsResourceGetOperationResultResponse contains the response from method IotDpsResource.GetOperationResult.

type IotDpsResourceGetOperationResultResult 

type IotDpsResourceGetOperationResultResult struct {
	AsyncOperationResult
}

IotDpsResourceGetOperationResultResult contains the result from method IotDpsResource.GetOperationResult.

type IotDpsResourceGetOptions 

type IotDpsResourceGetOptions struct {
}

IotDpsResourceGetOptions contains the optional parameters for the IotDpsResource.Get method.

type IotDpsResourceGetPrivateEndpointConnectionOptions 

type IotDpsResourceGetPrivateEndpointConnectionOptions struct {
}

IotDpsResourceGetPrivateEndpointConnectionOptions contains the optional parameters for the IotDpsResource.GetPrivateEndpointConnection method.

type IotDpsResourceGetPrivateEndpointConnectionResponse 

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

IotDpsResourceGetPrivateEndpointConnectionResponse contains the response from method IotDpsResource.GetPrivateEndpointConnection.

type IotDpsResourceGetPrivateEndpointConnectionResult 

type IotDpsResourceGetPrivateEndpointConnectionResult struct {
	PrivateEndpointConnection
}

IotDpsResourceGetPrivateEndpointConnectionResult contains the result from method IotDpsResource.GetPrivateEndpointConnection.

type IotDpsResourceGetPrivateLinkResourcesOptions 

type IotDpsResourceGetPrivateLinkResourcesOptions struct {
}

IotDpsResourceGetPrivateLinkResourcesOptions contains the optional parameters for the IotDpsResource.GetPrivateLinkResources method.

type IotDpsResourceGetPrivateLinkResourcesResponse 

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

IotDpsResourceGetPrivateLinkResourcesResponse contains the response from method IotDpsResource.GetPrivateLinkResources.

type IotDpsResourceGetPrivateLinkResourcesResult 

type IotDpsResourceGetPrivateLinkResourcesResult struct {
	GroupIDInformation
}

IotDpsResourceGetPrivateLinkResourcesResult contains the result from method IotDpsResource.GetPrivateLinkResources.

type IotDpsResourceGetResponse 

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

IotDpsResourceGetResponse contains the response from method IotDpsResource.Get.

type IotDpsResourceGetResult 

type IotDpsResourceGetResult struct {
	ProvisioningServiceDescription
}

IotDpsResourceGetResult contains the result from method IotDpsResource.Get.

type IotDpsResourceListByResourceGroupOptions 

type IotDpsResourceListByResourceGroupOptions struct {
}

IotDpsResourceListByResourceGroupOptions contains the optional parameters for the IotDpsResource.ListByResourceGroup method.

type IotDpsResourceListByResourceGroupPager 

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

IotDpsResourceListByResourceGroupPager provides operations for iterating over paged responses.

func (*IotDpsResourceListByResourceGroupPager) Err 

func (p *IotDpsResourceListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*IotDpsResourceListByResourceGroupPager) NextPage 

func (p *IotDpsResourceListByResourceGroupPager) 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 (*IotDpsResourceListByResourceGroupPager) PageResponse 

func (p *IotDpsResourceListByResourceGroupPager) PageResponse() IotDpsResourceListByResourceGroupResponse

PageResponse returns the current IotDpsResourceListByResourceGroupResponse page.

type IotDpsResourceListByResourceGroupResponse 

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

IotDpsResourceListByResourceGroupResponse contains the response from method IotDpsResource.ListByResourceGroup.

type IotDpsResourceListByResourceGroupResult 

type IotDpsResourceListByResourceGroupResult struct {
	ProvisioningServiceDescriptionListResult
}

IotDpsResourceListByResourceGroupResult contains the result from method IotDpsResource.ListByResourceGroup.

type IotDpsResourceListBySubscriptionOptions 

type IotDpsResourceListBySubscriptionOptions struct {
}

IotDpsResourceListBySubscriptionOptions contains the optional parameters for the IotDpsResource.ListBySubscription method.

type IotDpsResourceListBySubscriptionPager 

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

IotDpsResourceListBySubscriptionPager provides operations for iterating over paged responses.

func (*IotDpsResourceListBySubscriptionPager) Err 

func (p *IotDpsResourceListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*IotDpsResourceListBySubscriptionPager) NextPage 

func (p *IotDpsResourceListBySubscriptionPager) 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 (*IotDpsResourceListBySubscriptionPager) PageResponse 

func (p *IotDpsResourceListBySubscriptionPager) PageResponse() IotDpsResourceListBySubscriptionResponse

PageResponse returns the current IotDpsResourceListBySubscriptionResponse page.

type IotDpsResourceListBySubscriptionResponse 

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

IotDpsResourceListBySubscriptionResponse contains the response from method IotDpsResource.ListBySubscription.

type IotDpsResourceListBySubscriptionResult 

type IotDpsResourceListBySubscriptionResult struct {
	ProvisioningServiceDescriptionListResult
}

IotDpsResourceListBySubscriptionResult contains the result from method IotDpsResource.ListBySubscription.

type IotDpsResourceListKeysForKeyNameOptions 

type IotDpsResourceListKeysForKeyNameOptions struct {
}

IotDpsResourceListKeysForKeyNameOptions contains the optional parameters for the IotDpsResource.ListKeysForKeyName method.

type IotDpsResourceListKeysForKeyNameResponse 

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

IotDpsResourceListKeysForKeyNameResponse contains the response from method IotDpsResource.ListKeysForKeyName.

type IotDpsResourceListKeysForKeyNameResult 

type IotDpsResourceListKeysForKeyNameResult struct {
	SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

IotDpsResourceListKeysForKeyNameResult contains the result from method IotDpsResource.ListKeysForKeyName.

type IotDpsResourceListKeysOptions 

type IotDpsResourceListKeysOptions struct {
}

IotDpsResourceListKeysOptions contains the optional parameters for the IotDpsResource.ListKeys method.

type IotDpsResourceListKeysPager 

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

IotDpsResourceListKeysPager provides operations for iterating over paged responses.

func (*IotDpsResourceListKeysPager) Err 

func (p *IotDpsResourceListKeysPager) Err() error

Err returns the last error encountered while paging.

func (*IotDpsResourceListKeysPager) NextPage 

func (p *IotDpsResourceListKeysPager) 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 (*IotDpsResourceListKeysPager) PageResponse 

func (p *IotDpsResourceListKeysPager) PageResponse() IotDpsResourceListKeysResponse

PageResponse returns the current IotDpsResourceListKeysResponse page.

type IotDpsResourceListKeysResponse 

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

IotDpsResourceListKeysResponse contains the response from method IotDpsResource.ListKeys.

type IotDpsResourceListKeysResult 

type IotDpsResourceListKeysResult struct {
	SharedAccessSignatureAuthorizationRuleListResult
}

IotDpsResourceListKeysResult contains the result from method IotDpsResource.ListKeys.

type IotDpsResourceListPrivateEndpointConnectionsOptions 

type IotDpsResourceListPrivateEndpointConnectionsOptions struct {
}

IotDpsResourceListPrivateEndpointConnectionsOptions contains the optional parameters for the IotDpsResource.ListPrivateEndpointConnections method.

type IotDpsResourceListPrivateEndpointConnectionsResponse 

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

IotDpsResourceListPrivateEndpointConnectionsResponse contains the response from method IotDpsResource.ListPrivateEndpointConnections.

type IotDpsResourceListPrivateEndpointConnectionsResult 

type IotDpsResourceListPrivateEndpointConnectionsResult struct {
	// The list of private endpoint connections for a provisioning service
	PrivateEndpointConnectionArray []*PrivateEndpointConnection
}

IotDpsResourceListPrivateEndpointConnectionsResult contains the result from method IotDpsResource.ListPrivateEndpointConnections.

type IotDpsResourceListPrivateLinkResourcesOptions 

type IotDpsResourceListPrivateLinkResourcesOptions struct {
}

IotDpsResourceListPrivateLinkResourcesOptions contains the optional parameters for the IotDpsResource.ListPrivateLinkResources method.

type IotDpsResourceListPrivateLinkResourcesResponse 

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

IotDpsResourceListPrivateLinkResourcesResponse contains the response from method IotDpsResource.ListPrivateLinkResources.

type IotDpsResourceListPrivateLinkResourcesResult 

type IotDpsResourceListPrivateLinkResourcesResult struct {
	PrivateLinkResources
}

IotDpsResourceListPrivateLinkResourcesResult contains the result from method IotDpsResource.ListPrivateLinkResources.

type IotDpsResourceListValidSKUsOptions 

type IotDpsResourceListValidSKUsOptions struct {
}

IotDpsResourceListValidSKUsOptions contains the optional parameters for the IotDpsResource.ListValidSKUs method.

type IotDpsResourceListValidSKUsPager 

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

IotDpsResourceListValidSKUsPager provides operations for iterating over paged responses.

func (*IotDpsResourceListValidSKUsPager) Err 

func (p *IotDpsResourceListValidSKUsPager) Err() error

Err returns the last error encountered while paging.

func (*IotDpsResourceListValidSKUsPager) NextPage 

func (p *IotDpsResourceListValidSKUsPager) 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 (*IotDpsResourceListValidSKUsPager) PageResponse 

func (p *IotDpsResourceListValidSKUsPager) PageResponse() IotDpsResourceListValidSKUsResponse

PageResponse returns the current IotDpsResourceListValidSKUsResponse page.

type IotDpsResourceListValidSKUsResponse 

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

IotDpsResourceListValidSKUsResponse contains the response from method IotDpsResource.ListValidSKUs.

type IotDpsResourceListValidSKUsResult 

type IotDpsResourceListValidSKUsResult struct {
	IotDpsSKUDefinitionListResult
}

IotDpsResourceListValidSKUsResult contains the result from method IotDpsResource.ListValidSKUs.

type IotDpsResourceUpdatePoller 

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

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

func (*IotDpsResourceUpdatePoller) Done 

func (p *IotDpsResourceUpdatePoller) Done() bool

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

func (*IotDpsResourceUpdatePoller) FinalResponse 

func (p *IotDpsResourceUpdatePoller) FinalResponse(ctx context.Context) (IotDpsResourceUpdateResponse, 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 IotDpsResourceUpdateResponse will be returned.

func (*IotDpsResourceUpdatePoller) Poll 

func (p *IotDpsResourceUpdatePoller) 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 (*IotDpsResourceUpdatePoller) ResumeToken 

func (p *IotDpsResourceUpdatePoller) 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 IotDpsResourceUpdatePollerResponse 

type IotDpsResourceUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotDpsResourceUpdatePoller

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

IotDpsResourceUpdatePollerResponse contains the response from method IotDpsResource.Update.

func (IotDpsResourceUpdatePollerResponse) PollUntilDone 

func (l IotDpsResourceUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IotDpsResourceUpdateResponse, 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 (*IotDpsResourceUpdatePollerResponse) Resume 

func (l *IotDpsResourceUpdatePollerResponse) Resume(ctx context.Context, client *IotDpsResourceClient, token string) error

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

type IotDpsResourceUpdateResponse 

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

IotDpsResourceUpdateResponse contains the response from method IotDpsResource.Update.

type IotDpsResourceUpdateResult 

type IotDpsResourceUpdateResult struct {
	ProvisioningServiceDescription
}

IotDpsResourceUpdateResult contains the result from method IotDpsResource.Update.

type IotDpsSKU 

type IotDpsSKU string

IotDpsSKU - Sku name. 

const (
	IotDpsSKUS1 IotDpsSKU = "S1"
)

func PossibleIotDpsSKUValues 

func PossibleIotDpsSKUValues() []IotDpsSKU

PossibleIotDpsSKUValues returns the possible values for the IotDpsSKU const type.

func (IotDpsSKU) ToPtr 

func (c IotDpsSKU) ToPtr() *IotDpsSKU

ToPtr returns a *IotDpsSKU pointing to the current value.

type IotDpsSKUDefinition 

type IotDpsSKUDefinition struct {
	// Sku name.
	Name *IotDpsSKU `json:"name,omitempty"`
}

IotDpsSKUDefinition - Available SKUs of tier and units.

type IotDpsSKUDefinitionListResult 

type IotDpsSKUDefinitionListResult struct {
	// The list of SKUs
	Value []*IotDpsSKUDefinition `json:"value,omitempty"`

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

IotDpsSKUDefinitionListResult - List of available SKUs.

func (IotDpsSKUDefinitionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IotDpsSKUDefinitionListResult.

type IotDpsSKUInfo 

type IotDpsSKUInfo struct {
	// The number of units to provision
	Capacity *int64 `json:"capacity,omitempty"`

	// Sku name.
	Name *IotDpsSKU `json:"name,omitempty"`

	// READ-ONLY; Pricing tier name of the provisioning service.
	Tier *string `json:"tier,omitempty" azure:"ro"`
}

IotDpsSKUInfo - List of possible provisioning service SKUs.

type IotHubDefinitionDescription 

type IotHubDefinitionDescription struct {
	// REQUIRED; Connection string of the IoT hub.
	ConnectionString *string `json:"connectionString,omitempty"`

	// REQUIRED; ARM region of the IoT hub.
	Location *string `json:"location,omitempty"`

	// weight to apply for a given iot h.
	AllocationWeight *int32 `json:"allocationWeight,omitempty"`

	// flag for applying allocationPolicy or not for a given iot hub.
	ApplyAllocationPolicy *bool `json:"applyAllocationPolicy,omitempty"`

	// READ-ONLY; Host name of the IoT hub.
	Name *string `json:"name,omitempty" azure:"ro"`
}

IotHubDefinitionDescription - Description of the IoT hub.

type NameAvailabilityInfo 

type NameAvailabilityInfo struct {
	// message containing a detailed reason name is unavailable
	Message *string `json:"message,omitempty"`

	// specifies if a name is available or not
	NameAvailable *bool `json:"nameAvailable,omitempty"`

	// specifies the reason a name is unavailable
	Reason *NameUnavailabilityReason `json:"reason,omitempty"`
}

NameAvailabilityInfo - Description of name availability.

type NameUnavailabilityReason 

type NameUnavailabilityReason string

NameUnavailabilityReason - specifies the reason a name is unavailable 

const (
	NameUnavailabilityReasonAlreadyExists NameUnavailabilityReason = "AlreadyExists"
	NameUnavailabilityReasonInvalid       NameUnavailabilityReason = "Invalid"
)

func PossibleNameUnavailabilityReasonValues 

func PossibleNameUnavailabilityReasonValues() []NameUnavailabilityReason

PossibleNameUnavailabilityReasonValues returns the possible values for the NameUnavailabilityReason const type.

func (NameUnavailabilityReason) ToPtr 

func (c NameUnavailabilityReason) ToPtr() *NameUnavailabilityReason

ToPtr returns a *NameUnavailabilityReason pointing to the current value.

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 - Provisioning Service REST API operation.

type OperationDisplay 

type OperationDisplay struct {
	// 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: ProvisioningServices.
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplay - The object that represents the operation.

type OperationInputs 

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

OperationInputs - Input values for operation results call.

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; Provisioning service operations supported by the Microsoft.Devices resource provider.
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

OperationListResult - Result of the request to list provisioning service 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.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsListOptions) *OperationsListPager

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

Example

x-ms-original-file: specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/examples/DPSOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceprovisioningservices/armdeviceprovisioningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdeviceprovisioningservices.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type OperationsListOptions 

type OperationsListOptions struct {
}

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

type OperationsListPager 

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err 

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage 

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

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

func (*OperationsListPager) PageResponse 

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse 

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

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List.

type PrivateEndpoint 

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

PrivateEndpoint - The private endpoint property of a private endpoint connection

type PrivateEndpointConnection 

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

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

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

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

PrivateEndpointConnection - The private endpoint connection of a provisioning service

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 PrivateLinkResources 

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

PrivateLinkResources - The available private link resources for a provisioning service

func (PrivateLinkResources) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResources.

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 ProvisioningServiceDescription 

type ProvisioningServiceDescription struct {
	Resource
	// REQUIRED; Service specific properties for a provisioning service
	Properties *IotDpsPropertiesDescription `json:"properties,omitempty"`

	// REQUIRED; Sku info for a provisioning Service.
	SKU *IotDpsSKUInfo `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"`
}

ProvisioningServiceDescription - The description of the provisioning service.

func (ProvisioningServiceDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProvisioningServiceDescription.

type ProvisioningServiceDescriptionListResult 

type ProvisioningServiceDescriptionListResult struct {
	// List of provisioning service descriptions.
	Value []*ProvisioningServiceDescription `json:"value,omitempty"`

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

ProvisioningServiceDescriptionListResult - List of provisioning service descriptions.

func (ProvisioningServiceDescriptionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProvisioningServiceDescriptionListResult.

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

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription struct {
	// REQUIRED; Name of the key.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; Rights that this key has.
	Rights *AccessRightsDescription `json:"rights,omitempty"`

	// Primary SAS key value.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Secondary SAS key value.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

SharedAccessSignatureAuthorizationRuleAccessRightsDescription - Description of the shared access key.

type SharedAccessSignatureAuthorizationRuleListResult 

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

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

SharedAccessSignatureAuthorizationRuleListResult - List of shared access keys.

func (SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SharedAccessSignatureAuthorizationRuleListResult.

type State 

type State string

State - Current state of the provisioning service. 

const (
	StateActivating       State = "Activating"
	StateActivationFailed State = "ActivationFailed"
	StateActive           State = "Active"
	StateDeleted          State = "Deleted"
	StateDeleting         State = "Deleting"
	StateDeletionFailed   State = "DeletionFailed"
	StateFailingOver      State = "FailingOver"
	StateFailoverFailed   State = "FailoverFailed"
	StateResuming         State = "Resuming"
	StateSuspended        State = "Suspended"
	StateSuspending       State = "Suspending"
	StateTransitioning    State = "Transitioning"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns the possible values for the State const type.

func (State) ToPtr 

func (c State) ToPtr() *State

ToPtr returns a *State pointing to the current value.

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 a Provisioning Service instance.

func (TagsResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TagsResource.

type VerificationCodeRequest 

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

VerificationCodeRequest - The JSON-serialized leaf certificate

type VerificationCodeResponse 

type VerificationCodeResponse struct {
	Properties *VerificationCodeResponseProperties `json:"properties,omitempty"`

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

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

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

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

VerificationCodeResponse - Description of the response of the verification code.

type VerificationCodeResponseProperties 

type VerificationCodeResponseProperties struct {
	// base-64 representation of X509 certificate .cer file or just .pem file content.
	Certificate []byte `json:"certificate,omitempty"`

	// Certificate created time.
	Created *string `json:"created,omitempty"`

	// Code expiry.
	Expiry *string `json:"expiry,omitempty"`

	// Indicate if the certificate is verified by owner of private key.
	IsVerified *bool `json:"isVerified,omitempty"`

	// Certificate subject.
	Subject *string `json:"subject,omitempty"`

	// Certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`

	// Certificate updated time.
	Updated *string `json:"updated,omitempty"`

	// Verification code.
	VerificationCode *string `json:"verificationCode,omitempty"`
}

func (VerificationCodeResponseProperties) MarshalJSON 

func (v VerificationCodeResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerificationCodeResponseProperties.

func (*VerificationCodeResponseProperties) UnmarshalJSON 

func (v *VerificationCodeResponseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerificationCodeResponseProperties.

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.