iothub

package
v99.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jul 18, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package iothub implements the Azure ARM Iothub service API version 2021-10-15.

API for using the Azure IoT Hub Device Provisioning Service features.

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type AccessRightsDescription 

type AccessRightsDescription string

AccessRightsDescription enumerates the values for access rights description. 

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

func PossibleAccessRightsDescriptionValues 

func PossibleAccessRightsDescriptionValues() []AccessRightsDescription

PossibleAccessRightsDescriptionValues returns an array of possible values for the AccessRightsDescription const type.

type AllocationPolicy 

type AllocationPolicy string

AllocationPolicy enumerates the values for allocation policy. 

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

func PossibleAllocationPolicyValues 

func PossibleAllocationPolicyValues() []AllocationPolicy

PossibleAllocationPolicyValues returns an array of possible values for the AllocationPolicy const type.

type AsyncOperationResult 

type AsyncOperationResult struct {
	autorest.Response `json:"-"`
	// Status - current status of a long running operation.
	Status *string `json:"status,omitempty"`
	// Error - Error message containing code, description and details
	Error *ErrorMesssage `json:"error,omitempty"`
}

AsyncOperationResult result of a long running operation.

type BaseClient 

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

BaseClient is the base client for Iothub.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CertificateBodyDescription 

type CertificateBodyDescription struct {
	// Certificate - Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
	Certificate *string `json:"certificate,omitempty"`
	// IsVerified - 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 {
	autorest.Response `json:"-"`
	// Value - The array of Certificate objects.
	Value *[]CertificateResponse `json:"value,omitempty"`
}

CertificateListDescription the JSON-serialized array of Certificate objects.

type CertificateProperties 

type CertificateProperties struct {
	// Subject - READ-ONLY; The certificate's subject name.
	Subject *string `json:"subject,omitempty"`
	// Expiry - READ-ONLY; The certificate's expiration date and time.
	Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
	// Thumbprint - READ-ONLY; The certificate's thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// IsVerified - READ-ONLY; Determines whether certificate has been verified.
	IsVerified *bool `json:"isVerified,omitempty"`
	// Certificate - READ-ONLY; base-64 representation of X509 certificate .cer file or just .pem file content.
	Certificate *[]byte `json:"certificate,omitempty"`
	// Created - READ-ONLY; The certificate's creation date and time.
	Created *date.TimeRFC1123 `json:"created,omitempty"`
	// Updated - READ-ONLY; The certificate's last update date and time.
	Updated *date.TimeRFC1123 `json:"updated,omitempty"`
}

CertificateProperties the description of an X509 CA Certificate.

func (CertificateProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for CertificateProperties.

type CertificatePurpose 

type CertificatePurpose string

CertificatePurpose enumerates the values for certificate purpose. 

const (
	// CertificatePurposeClientAuthentication ...
	CertificatePurposeClientAuthentication CertificatePurpose = "clientAuthentication"
	// CertificatePurposeServerAuthentication ...
	CertificatePurposeServerAuthentication CertificatePurpose = "serverAuthentication"
)

func PossibleCertificatePurposeValues 

func PossibleCertificatePurposeValues() []CertificatePurpose

PossibleCertificatePurposeValues returns an array of possible values for the CertificatePurpose const type.

type CertificateResponse 

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

CertificateResponse the X509 Certificate.

func (CertificateResponse) MarshalJSON 

func (cr CertificateResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateResponse.

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type DefinitionDescription 

type DefinitionDescription struct {
	// ApplyAllocationPolicy - flag for applying allocationPolicy or not for a given iot hub.
	ApplyAllocationPolicy *bool `json:"applyAllocationPolicy,omitempty"`
	// AllocationWeight - weight to apply for a given iot h.
	AllocationWeight *int32 `json:"allocationWeight,omitempty"`
	// Name - READ-ONLY; Host name of the IoT hub.
	Name *string `json:"name,omitempty"`
	// ConnectionString - Connection string of the IoT hub.
	ConnectionString *string `json:"connectionString,omitempty"`
	// Location - ARM region of the IoT hub.
	Location *string `json:"location,omitempty"`
}

DefinitionDescription description of the IoT hub.

func (DefinitionDescription) MarshalJSON 

func (dd DefinitionDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DefinitionDescription.

type DpsCertificateClient 

type DpsCertificateClient struct {
	BaseClient
}

DpsCertificateClient is the API for using the Azure IoT Hub Device Provisioning Service features.

func NewDpsCertificateClient 

func NewDpsCertificateClient(subscriptionID string) DpsCertificateClient

NewDpsCertificateClient creates an instance of the DpsCertificateClient client.

func NewDpsCertificateClientWithBaseURI 

func NewDpsCertificateClientWithBaseURI(baseURI string, subscriptionID string) DpsCertificateClient

NewDpsCertificateClientWithBaseURI creates an instance of the DpsCertificateClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DpsCertificateClient) CreateOrUpdate 

func (client DpsCertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, certificateName string, certificateDescription CertificateBodyDescription, ifMatch string) (result CertificateResponse, err error)

CreateOrUpdate add new certificate or update an existing certificate. Parameters: resourceGroupName - resource group identifier. provisioningServiceName - the name of the provisioning service. certificateName - the name of the certificate create or update. certificateDescription - the certificate body. ifMatch - eTag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.

func (DpsCertificateClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DpsCertificateClient) CreateOrUpdateResponder 

func (client DpsCertificateClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateResponse, err error)

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

func (DpsCertificateClient) CreateOrUpdateSender 

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

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

func (DpsCertificateClient) Delete 

func (client DpsCertificateClient) Delete(ctx context.Context, resourceGroupName string, ifMatch string, provisioningServiceName string, certificateName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (result autorest.Response, err error)

Delete deletes the specified certificate associated with the Provisioning Service Parameters: resourceGroupName - resource group identifier. ifMatch - eTag of the certificate provisioningServiceName - the name of the provisioning service. certificateName - this is a mandatory field, and is the logical name of the certificate that the provisioning service will access by. certificatename - this is optional, and it is the Common Name of the certificate. certificaterawBytes - raw data within the certificate. certificateisVerified - indicates if certificate has been verified by owner of the private key. certificatepurpose - a description that mentions the purpose of the certificate. certificatecreated - time the certificate is created. certificatelastUpdated - time the certificate is last updated. certificatehasPrivateKey - indicates if the certificate contains a private key. certificatenonce - random number generated to indicate Proof of Possession.

func (DpsCertificateClient) DeletePreparer 

func (client DpsCertificateClient) DeletePreparer(ctx context.Context, resourceGroupName string, ifMatch string, provisioningServiceName string, certificateName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DpsCertificateClient) DeleteResponder 

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

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

func (DpsCertificateClient) DeleteSender 

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

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

func (DpsCertificateClient) GenerateVerificationCode 

func (client DpsCertificateClient) GenerateVerificationCode(ctx context.Context, certificateName string, ifMatch string, resourceGroupName string, provisioningServiceName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (result VerificationCodeResponse, err error)

GenerateVerificationCode generate verification code for Proof of Possession. Parameters: certificateName - the mandatory logical name of the certificate, that the provisioning service uses to access. ifMatch - eTag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. resourceGroupName - name of resource group. provisioningServiceName - name of provisioning service. certificatename - common Name for the certificate. certificaterawBytes - raw data of certificate. certificateisVerified - indicates if the certificate has been verified by owner of the private key. certificatepurpose - description mentioning the purpose of the certificate. certificatecreated - certificate creation time. certificatelastUpdated - certificate last updated time. certificatehasPrivateKey - indicates if the certificate contains private key. certificatenonce - random number generated to indicate Proof of Possession.

func (DpsCertificateClient) GenerateVerificationCodePreparer 

func (client DpsCertificateClient) GenerateVerificationCodePreparer(ctx context.Context, certificateName string, ifMatch string, resourceGroupName string, provisioningServiceName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (*http.Request, error)

GenerateVerificationCodePreparer prepares the GenerateVerificationCode request.

func (DpsCertificateClient) GenerateVerificationCodeResponder 

func (client DpsCertificateClient) GenerateVerificationCodeResponder(resp *http.Response) (result VerificationCodeResponse, err error)

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

func (DpsCertificateClient) GenerateVerificationCodeSender 

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

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

func (DpsCertificateClient) Get 

func (client DpsCertificateClient) Get(ctx context.Context, certificateName string, resourceGroupName string, provisioningServiceName string, ifMatch string) (result CertificateResponse, err error)

Get get the certificate from the provisioning service. Parameters: certificateName - name of the certificate to retrieve. resourceGroupName - resource group identifier. provisioningServiceName - name of the provisioning service the certificate is associated with. ifMatch - eTag of the certificate.

func (DpsCertificateClient) GetPreparer 

func (client DpsCertificateClient) GetPreparer(ctx context.Context, certificateName string, resourceGroupName string, provisioningServiceName string, ifMatch string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DpsCertificateClient) GetResponder 

func (client DpsCertificateClient) GetResponder(resp *http.Response) (result CertificateResponse, err error)

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

func (DpsCertificateClient) GetSender 

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

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

func (DpsCertificateClient) List 

func (client DpsCertificateClient) List(ctx context.Context, resourceGroupName string, provisioningServiceName string) (result CertificateListDescription, err error)

List get all the certificates tied to the provisioning service. Parameters: resourceGroupName - name of resource group. provisioningServiceName - name of provisioning service to retrieve certificates for.

func (DpsCertificateClient) ListPreparer 

func (client DpsCertificateClient) ListPreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (DpsCertificateClient) ListResponder 

func (client DpsCertificateClient) ListResponder(resp *http.Response) (result CertificateListDescription, err error)

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

func (DpsCertificateClient) ListSender 

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

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

func (DpsCertificateClient) VerifyCertificate 

func (client DpsCertificateClient) VerifyCertificate(ctx context.Context, certificateName string, ifMatch string, request VerificationCodeRequest, resourceGroupName string, provisioningServiceName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (result CertificateResponse, err error)

VerifyCertificate verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. Parameters: certificateName - the mandatory logical name of the certificate, that the provisioning service uses to access. ifMatch - eTag of the certificate. request - the name of the certificate resourceGroupName - resource group name. provisioningServiceName - provisioning service name. certificatename - common Name for the certificate. certificaterawBytes - raw data of certificate. certificateisVerified - indicates if the certificate has been verified by owner of the private key. certificatepurpose - describe the purpose of the certificate. certificatecreated - certificate creation time. certificatelastUpdated - certificate last updated time. certificatehasPrivateKey - indicates if the certificate contains private key. certificatenonce - random number generated to indicate Proof of Possession.

func (DpsCertificateClient) VerifyCertificatePreparer 

func (client DpsCertificateClient) VerifyCertificatePreparer(ctx context.Context, certificateName string, ifMatch string, request VerificationCodeRequest, resourceGroupName string, provisioningServiceName string, certificatename string, certificaterawBytes []byte, certificateisVerified *bool, certificatepurpose CertificatePurpose, certificatecreated *date.Time, certificatelastUpdated *date.Time, certificatehasPrivateKey *bool, certificatenonce string) (*http.Request, error)

VerifyCertificatePreparer prepares the VerifyCertificate request.

func (DpsCertificateClient) VerifyCertificateResponder 

func (client DpsCertificateClient) VerifyCertificateResponder(resp *http.Response) (result CertificateResponse, err error)

VerifyCertificateResponder handles the response to the VerifyCertificate request. The method always closes the http.Response Body.

func (DpsCertificateClient) VerifyCertificateSender 

func (client DpsCertificateClient) VerifyCertificateSender(req *http.Request) (*http.Response, error)

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

type ErrorDetails 

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

ErrorDetails error details.

func (ErrorDetails) MarshalJSON 

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

MarshalJSON is the custom marshaler for ErrorDetails.

type ErrorMesssage 

type ErrorMesssage struct {
	// Code - standard error code
	Code *string `json:"code,omitempty"`
	// Message - standard error description
	Message *string `json:"message,omitempty"`
	// Details - detailed summary of error
	Details *string `json:"details,omitempty"`
}

ErrorMesssage error response containing message and code.

type GroupIDInformation 

type GroupIDInformation struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Properties - The properties for a group information object
	Properties *GroupIDInformationProperties `json:"properties,omitempty"`
}

GroupIDInformation the group information for creating a private endpoint on a provisioning service

func (GroupIDInformation) MarshalJSON 

func (gii GroupIDInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupIDInformation.

type GroupIDInformationProperties 

type GroupIDInformationProperties struct {
	// GroupID - The group id
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - The required members for a specific group id
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - The required DNS zones for a specific group id
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

GroupIDInformationProperties the properties for a group information object

type IPFilterActionType 

type IPFilterActionType string

IPFilterActionType enumerates the values for ip filter action type. 

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

func PossibleIPFilterActionTypeValues 

func PossibleIPFilterActionTypeValues() []IPFilterActionType

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

type IPFilterRule 

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

IPFilterRule the IP filter rules for a provisioning Service.

type IPFilterTargetType 

type IPFilterTargetType string

IPFilterTargetType enumerates the values for ip filter target type. 

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

func PossibleIPFilterTargetTypeValues 

func PossibleIPFilterTargetTypeValues() []IPFilterTargetType

PossibleIPFilterTargetTypeValues returns an array of possible values for the IPFilterTargetType const type.

type IotDpsPropertiesDescription 

type IotDpsPropertiesDescription struct {
	// State - Current state of the provisioning service. Possible values include: 'StateActivating', 'StateActive', 'StateDeleting', 'StateDeleted', 'StateActivationFailed', 'StateDeletionFailed', 'StateTransitioning', 'StateSuspending', 'StateSuspended', 'StateResuming', 'StateFailingOver', 'StateFailoverFailed'
	State State `json:"state,omitempty"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// IPFilterRules - The IP filter rules.
	IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"`
	// PrivateEndpointConnections - Private endpoint connections created on this IotHub
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	// ProvisioningState - The ARM provisioning state of the provisioning service.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// IotHubs - List of IoT hubs associated with this provisioning service.
	IotHubs *[]DefinitionDescription `json:"iotHubs,omitempty"`
	// AllocationPolicy - Allocation policy to be used by this provisioning service. Possible values include: 'AllocationPolicyHashed', 'AllocationPolicyGeoLatency', 'AllocationPolicyStatic'
	AllocationPolicy AllocationPolicy `json:"allocationPolicy,omitempty"`
	// ServiceOperationsHostName - READ-ONLY; Service endpoint for provisioning service.
	ServiceOperationsHostName *string `json:"serviceOperationsHostName,omitempty"`
	// DeviceProvisioningHostName - READ-ONLY; Device endpoint for this provisioning service.
	DeviceProvisioningHostName *string `json:"deviceProvisioningHostName,omitempty"`
	// IDScope - READ-ONLY; Unique identifier of this provisioning service.
	IDScope *string `json:"idScope,omitempty"`
	// AuthorizationPolicies - List of authorization keys for a provisioning service.
	AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"`
	// EnableDataResidency - Optional.
	// Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
	EnableDataResidency *bool `json:"enableDataResidency,omitempty"`
}

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

MarshalJSON is the custom marshaler for IotDpsPropertiesDescription.

type IotDpsResourceClient 

type IotDpsResourceClient struct {
	BaseClient
}

IotDpsResourceClient is the API for using the Azure IoT Hub Device Provisioning Service features.

func NewIotDpsResourceClient 

func NewIotDpsResourceClient(subscriptionID string) IotDpsResourceClient

NewIotDpsResourceClient creates an instance of the IotDpsResourceClient client.

func NewIotDpsResourceClientWithBaseURI 

func NewIotDpsResourceClientWithBaseURI(baseURI string, subscriptionID string) IotDpsResourceClient

NewIotDpsResourceClientWithBaseURI creates an instance of the IotDpsResourceClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailability 

func (client IotDpsResourceClient) CheckProvisioningServiceNameAvailability(ctx context.Context, arguments OperationInputs) (result NameAvailabilityInfo, err 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 Parameters: arguments - set the name parameter in the OperationInputs structure to the name of the provisioning service to check.

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailabilityPreparer 

func (client IotDpsResourceClient) CheckProvisioningServiceNameAvailabilityPreparer(ctx context.Context, arguments OperationInputs) (*http.Request, error)

CheckProvisioningServiceNameAvailabilityPreparer prepares the CheckProvisioningServiceNameAvailability request.

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailabilityResponder 

func (client IotDpsResourceClient) CheckProvisioningServiceNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityInfo, err error)

CheckProvisioningServiceNameAvailabilityResponder handles the response to the CheckProvisioningServiceNameAvailability request. The method always closes the http.Response Body.

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailabilitySender 

func (client IotDpsResourceClient) CheckProvisioningServiceNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) CreateOrUpdate 

func (client IotDpsResourceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, iotDpsDescription ProvisioningServiceDescription) (result IotDpsResourceCreateOrUpdateFuture, err error)

CreateOrUpdate 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. Parameters: resourceGroupName - resource group identifier. provisioningServiceName - name of provisioning service to create or update. iotDpsDescription - description of the provisioning service to create or update.

func (IotDpsResourceClient) CreateOrUpdatePreparer 

func (client IotDpsResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string, iotDpsDescription ProvisioningServiceDescription) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnection 

func (client IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (result IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture, err error)

CreateOrUpdatePrivateEndpointConnection create or update the status of a private endpoint connection with the specified name Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service. privateEndpointConnectionName - the name of the private endpoint connection privateEndpointConnection - the private endpoint connection with updated properties

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionPreparer 

func (client IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (*http.Request, error)

CreateOrUpdatePrivateEndpointConnectionPreparer prepares the CreateOrUpdatePrivateEndpointConnection request.

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionResponder 

func (client IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

CreateOrUpdatePrivateEndpointConnectionResponder handles the response to the CreateOrUpdatePrivateEndpointConnection request. The method always closes the http.Response Body.

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionSender 

func (client IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionSender(req *http.Request) (future IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture, err error)

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

func (IotDpsResourceClient) CreateOrUpdateResponder 

func (client IotDpsResourceClient) CreateOrUpdateResponder(resp *http.Response) (result ProvisioningServiceDescription, err error)

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

func (IotDpsResourceClient) CreateOrUpdateSender 

func (client IotDpsResourceClient) CreateOrUpdateSender(req *http.Request) (future IotDpsResourceCreateOrUpdateFuture, err error)

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

func (IotDpsResourceClient) Delete 

func (client IotDpsResourceClient) Delete(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsResourceDeleteFuture, err error)

Delete deletes the Provisioning Service. Parameters: provisioningServiceName - name of provisioning service to delete. resourceGroupName - resource group identifier.

func (IotDpsResourceClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (IotDpsResourceClient) DeletePrivateEndpointConnection 

func (client IotDpsResourceClient) DeletePrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result IotDpsResourceDeletePrivateEndpointConnectionFuture, err error)

DeletePrivateEndpointConnection delete private endpoint connection with the specified name Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service. privateEndpointConnectionName - the name of the private endpoint connection

func (IotDpsResourceClient) DeletePrivateEndpointConnectionPreparer 

func (client IotDpsResourceClient) DeletePrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (*http.Request, error)

DeletePrivateEndpointConnectionPreparer prepares the DeletePrivateEndpointConnection request.

func (IotDpsResourceClient) DeletePrivateEndpointConnectionResponder 

func (client IotDpsResourceClient) DeletePrivateEndpointConnectionResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

DeletePrivateEndpointConnectionResponder handles the response to the DeletePrivateEndpointConnection request. The method always closes the http.Response Body.

func (IotDpsResourceClient) DeletePrivateEndpointConnectionSender 

func (client IotDpsResourceClient) DeletePrivateEndpointConnectionSender(req *http.Request) (future IotDpsResourceDeletePrivateEndpointConnectionFuture, err error)

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

func (IotDpsResourceClient) DeleteResponder 

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

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

func (IotDpsResourceClient) DeleteSender 

func (client IotDpsResourceClient) DeleteSender(req *http.Request) (future IotDpsResourceDeleteFuture, err error)

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

func (IotDpsResourceClient) Get 

func (client IotDpsResourceClient) Get(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result ProvisioningServiceDescription, err error)

Get get the metadata of the provisioning service without SAS keys. Parameters: provisioningServiceName - name of the provisioning service to retrieve. resourceGroupName - resource group name.

func (IotDpsResourceClient) GetOperationResult 

func (client IotDpsResourceClient) GetOperationResult(ctx context.Context, operationID string, resourceGroupName string, provisioningServiceName string, asyncinfo string) (result AsyncOperationResult, err error)

GetOperationResult gets the status of a long running operation, such as create, update or delete a provisioning service. Parameters: operationID - operation id corresponding to long running operation. Use this to poll for the status. resourceGroupName - resource group identifier. provisioningServiceName - name of provisioning service that the operation is running on. asyncinfo - async header used to poll on the status of the operation, obtained while creating the long running operation.

func (IotDpsResourceClient) GetOperationResultPreparer 

func (client IotDpsResourceClient) GetOperationResultPreparer(ctx context.Context, operationID string, resourceGroupName string, provisioningServiceName string, asyncinfo string) (*http.Request, error)

GetOperationResultPreparer prepares the GetOperationResult request.

func (IotDpsResourceClient) GetOperationResultResponder 

func (client IotDpsResourceClient) GetOperationResultResponder(resp *http.Response) (result AsyncOperationResult, err error)

GetOperationResultResponder handles the response to the GetOperationResult request. The method always closes the http.Response Body.

func (IotDpsResourceClient) GetOperationResultSender 

func (client IotDpsResourceClient) GetOperationResultSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (IotDpsResourceClient) GetPrivateEndpointConnection 

func (client IotDpsResourceClient) GetPrivateEndpointConnection(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

GetPrivateEndpointConnection get private endpoint connection properties Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service. privateEndpointConnectionName - the name of the private endpoint connection

func (IotDpsResourceClient) GetPrivateEndpointConnectionPreparer 

func (client IotDpsResourceClient) GetPrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (*http.Request, error)

GetPrivateEndpointConnectionPreparer prepares the GetPrivateEndpointConnection request.

func (IotDpsResourceClient) GetPrivateEndpointConnectionResponder 

func (client IotDpsResourceClient) GetPrivateEndpointConnectionResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

GetPrivateEndpointConnectionResponder handles the response to the GetPrivateEndpointConnection request. The method always closes the http.Response Body.

func (IotDpsResourceClient) GetPrivateEndpointConnectionSender 

func (client IotDpsResourceClient) GetPrivateEndpointConnectionSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) GetPrivateLinkResources 

func (client IotDpsResourceClient) GetPrivateLinkResources(ctx context.Context, resourceGroupName string, resourceName string, groupID string) (result GroupIDInformation, err error)

GetPrivateLinkResources get the specified private link resource for the given provisioning service Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service. groupID - the name of the private link resource

func (IotDpsResourceClient) GetPrivateLinkResourcesPreparer 

func (client IotDpsResourceClient) GetPrivateLinkResourcesPreparer(ctx context.Context, resourceGroupName string, resourceName string, groupID string) (*http.Request, error)

GetPrivateLinkResourcesPreparer prepares the GetPrivateLinkResources request.

func (IotDpsResourceClient) GetPrivateLinkResourcesResponder 

func (client IotDpsResourceClient) GetPrivateLinkResourcesResponder(resp *http.Response) (result GroupIDInformation, err error)

GetPrivateLinkResourcesResponder handles the response to the GetPrivateLinkResources request. The method always closes the http.Response Body.

func (IotDpsResourceClient) GetPrivateLinkResourcesSender 

func (client IotDpsResourceClient) GetPrivateLinkResourcesSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) GetResponder 

func (client IotDpsResourceClient) GetResponder(resp *http.Response) (result ProvisioningServiceDescription, err error)

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

func (IotDpsResourceClient) GetSender 

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

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

func (IotDpsResourceClient) ListByResourceGroup 

func (client IotDpsResourceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProvisioningServiceDescriptionListResultPage, err error)

ListByResourceGroup get a list of all provisioning services in the given resource group. Parameters: resourceGroupName - resource group identifier.

func (IotDpsResourceClient) ListByResourceGroupComplete 

func (client IotDpsResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProvisioningServiceDescriptionListResultIterator, err error)

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

func (IotDpsResourceClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (IotDpsResourceClient) ListByResourceGroupResponder 

func (client IotDpsResourceClient) ListByResourceGroupResponder(resp *http.Response) (result ProvisioningServiceDescriptionListResult, err error)

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

func (IotDpsResourceClient) ListByResourceGroupSender 

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

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

func (IotDpsResourceClient) ListBySubscription 

func (client IotDpsResourceClient) ListBySubscription(ctx context.Context) (result ProvisioningServiceDescriptionListResultPage, err error)

ListBySubscription list all the provisioning services for a given subscription id.

func (IotDpsResourceClient) ListBySubscriptionComplete 

func (client IotDpsResourceClient) ListBySubscriptionComplete(ctx context.Context) (result ProvisioningServiceDescriptionListResultIterator, err error)

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

func (IotDpsResourceClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (IotDpsResourceClient) ListBySubscriptionResponder 

func (client IotDpsResourceClient) ListBySubscriptionResponder(resp *http.Response) (result ProvisioningServiceDescriptionListResult, err error)

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

func (IotDpsResourceClient) ListBySubscriptionSender 

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

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

func (IotDpsResourceClient) ListKeys 

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

ListKeys list the primary and secondary keys for a provisioning service. Parameters: provisioningServiceName - the provisioning service name to get the shared access keys for. resourceGroupName - resource group name

func (IotDpsResourceClient) ListKeysComplete 

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

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

func (IotDpsResourceClient) ListKeysForKeyName 

func (client IotDpsResourceClient) ListKeysForKeyName(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, err error)

ListKeysForKeyName list primary and secondary keys for a specific key name Parameters: provisioningServiceName - name of the provisioning service. keyName - logical key name to get key-values for. resourceGroupName - the name of the resource group that contains the provisioning service.

func (IotDpsResourceClient) ListKeysForKeyNamePreparer 

func (client IotDpsResourceClient) ListKeysForKeyNamePreparer(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string) (*http.Request, error)

ListKeysForKeyNamePreparer prepares the ListKeysForKeyName request.

func (IotDpsResourceClient) ListKeysForKeyNameResponder 

func (client IotDpsResourceClient) ListKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, err error)

ListKeysForKeyNameResponder handles the response to the ListKeysForKeyName request. The method always closes the http.Response Body.

func (IotDpsResourceClient) ListKeysForKeyNameSender 

func (client IotDpsResourceClient) ListKeysForKeyNameSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) ListKeysPreparer 

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

ListKeysPreparer prepares the ListKeys request.

func (IotDpsResourceClient) ListKeysResponder 

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

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

func (IotDpsResourceClient) ListKeysSender 

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

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

func (IotDpsResourceClient) ListPrivateEndpointConnections 

func (client IotDpsResourceClient) ListPrivateEndpointConnections(ctx context.Context, resourceGroupName string, resourceName string) (result ListPrivateEndpointConnection, err error)

ListPrivateEndpointConnections list private endpoint connection properties Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service.

func (IotDpsResourceClient) ListPrivateEndpointConnectionsPreparer 

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

ListPrivateEndpointConnectionsPreparer prepares the ListPrivateEndpointConnections request.

func (IotDpsResourceClient) ListPrivateEndpointConnectionsResponder 

func (client IotDpsResourceClient) ListPrivateEndpointConnectionsResponder(resp *http.Response) (result ListPrivateEndpointConnection, err error)

ListPrivateEndpointConnectionsResponder handles the response to the ListPrivateEndpointConnections request. The method always closes the http.Response Body.

func (IotDpsResourceClient) ListPrivateEndpointConnectionsSender 

func (client IotDpsResourceClient) ListPrivateEndpointConnectionsSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) ListPrivateLinkResources 

func (client IotDpsResourceClient) ListPrivateLinkResources(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateLinkResources, err error)

ListPrivateLinkResources list private link resources for the given provisioning service Parameters: resourceGroupName - the name of the resource group that contains the provisioning service. resourceName - the name of the provisioning service.

func (IotDpsResourceClient) ListPrivateLinkResourcesPreparer 

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

ListPrivateLinkResourcesPreparer prepares the ListPrivateLinkResources request.

func (IotDpsResourceClient) ListPrivateLinkResourcesResponder 

func (client IotDpsResourceClient) ListPrivateLinkResourcesResponder(resp *http.Response) (result PrivateLinkResources, err error)

ListPrivateLinkResourcesResponder handles the response to the ListPrivateLinkResources request. The method always closes the http.Response Body.

func (IotDpsResourceClient) ListPrivateLinkResourcesSender 

func (client IotDpsResourceClient) ListPrivateLinkResourcesSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) ListValidSkus 

func (client IotDpsResourceClient) ListValidSkus(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsSkuDefinitionListResultPage, err error)

ListValidSkus gets the list of valid SKUs and tiers for a provisioning service. Parameters: provisioningServiceName - name of provisioning service. resourceGroupName - name of resource group.

func (IotDpsResourceClient) ListValidSkusComplete 

func (client IotDpsResourceClient) ListValidSkusComplete(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsSkuDefinitionListResultIterator, err error)

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

func (IotDpsResourceClient) ListValidSkusPreparer 

func (client IotDpsResourceClient) ListValidSkusPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)

ListValidSkusPreparer prepares the ListValidSkus request.

func (IotDpsResourceClient) ListValidSkusResponder 

func (client IotDpsResourceClient) ListValidSkusResponder(resp *http.Response) (result IotDpsSkuDefinitionListResult, err error)

ListValidSkusResponder handles the response to the ListValidSkus request. The method always closes the http.Response Body.

func (IotDpsResourceClient) ListValidSkusSender 

func (client IotDpsResourceClient) ListValidSkusSender(req *http.Request) (*http.Response, error)

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

func (IotDpsResourceClient) Update 

func (client IotDpsResourceClient) Update(ctx context.Context, resourceGroupName string, provisioningServiceName string, provisioningServiceTags TagsResource) (result IotDpsResourceUpdateFuture, err error)

Update update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method Parameters: resourceGroupName - resource group identifier. provisioningServiceName - name of provisioning service to create or update. provisioningServiceTags - updated tag information to set into the provisioning service instance.

func (IotDpsResourceClient) UpdatePreparer 

func (client IotDpsResourceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string, provisioningServiceTags TagsResource) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (IotDpsResourceClient) UpdateResponder 

func (client IotDpsResourceClient) UpdateResponder(resp *http.Response) (result ProvisioningServiceDescription, err error)

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

func (IotDpsResourceClient) UpdateSender 

func (client IotDpsResourceClient) UpdateSender(req *http.Request) (future IotDpsResourceUpdateFuture, err error)

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

type IotDpsResourceCreateOrUpdateFuture 

type IotDpsResourceCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotDpsResourceClient) (ProvisioningServiceDescription, error)
}

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

func (*IotDpsResourceCreateOrUpdateFuture) UnmarshalJSON 

func (future *IotDpsResourceCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture 

type IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotDpsResourceClient) (PrivateEndpointConnection, error)
}

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

func (*IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture) UnmarshalJSON 

func (future *IotDpsResourceCreateOrUpdatePrivateEndpointConnectionFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotDpsResourceDeleteFuture 

type IotDpsResourceDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotDpsResourceClient) (autorest.Response, error)
}

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

func (*IotDpsResourceDeleteFuture) UnmarshalJSON 

func (future *IotDpsResourceDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotDpsResourceDeletePrivateEndpointConnectionFuture 

type IotDpsResourceDeletePrivateEndpointConnectionFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotDpsResourceClient) (PrivateEndpointConnection, error)
}

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

func (*IotDpsResourceDeletePrivateEndpointConnectionFuture) UnmarshalJSON 

func (future *IotDpsResourceDeletePrivateEndpointConnectionFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotDpsResourceUpdateFuture 

type IotDpsResourceUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotDpsResourceClient) (ProvisioningServiceDescription, error)
}

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

func (*IotDpsResourceUpdateFuture) UnmarshalJSON 

func (future *IotDpsResourceUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotDpsSku 

type IotDpsSku string

IotDpsSku enumerates the values for iot dps sku. 

const (
	// IotDpsSkuS1 ...
	IotDpsSkuS1 IotDpsSku = "S1"
)

func PossibleIotDpsSkuValues 

func PossibleIotDpsSkuValues() []IotDpsSku

PossibleIotDpsSkuValues returns an array of possible values for the IotDpsSku const type.

type IotDpsSkuDefinition 

type IotDpsSkuDefinition struct {
	// Name - Sku name. Possible values include: 'IotDpsSkuS1'
	Name IotDpsSku `json:"name,omitempty"`
}

IotDpsSkuDefinition available SKUs of tier and units.

type IotDpsSkuDefinitionListResult 

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

IotDpsSkuDefinitionListResult list of available SKUs.

func (IotDpsSkuDefinitionListResult) IsEmpty 

func (idsdlr IotDpsSkuDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (IotDpsSkuDefinitionListResult) MarshalJSON 

func (idsdlr IotDpsSkuDefinitionListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotDpsSkuDefinitionListResult.

type IotDpsSkuDefinitionListResultIterator 

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

IotDpsSkuDefinitionListResultIterator provides access to a complete listing of IotDpsSkuDefinition values.

func NewIotDpsSkuDefinitionListResultIterator 

func NewIotDpsSkuDefinitionListResultIterator(page IotDpsSkuDefinitionListResultPage) IotDpsSkuDefinitionListResultIterator

Creates a new instance of the IotDpsSkuDefinitionListResultIterator type.

func (*IotDpsSkuDefinitionListResultIterator) Next 

func (iter *IotDpsSkuDefinitionListResultIterator) Next() error

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

func (*IotDpsSkuDefinitionListResultIterator) NextWithContext 

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

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

func (IotDpsSkuDefinitionListResultIterator) NotDone 

func (iter IotDpsSkuDefinitionListResultIterator) NotDone() bool

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

func (IotDpsSkuDefinitionListResultIterator) Response 

func (iter IotDpsSkuDefinitionListResultIterator) Response() IotDpsSkuDefinitionListResult

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

func (IotDpsSkuDefinitionListResultIterator) Value 

func (iter IotDpsSkuDefinitionListResultIterator) Value() IotDpsSkuDefinition

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

type IotDpsSkuDefinitionListResultPage 

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

IotDpsSkuDefinitionListResultPage contains a page of IotDpsSkuDefinition values.

func NewIotDpsSkuDefinitionListResultPage 

func NewIotDpsSkuDefinitionListResultPage(cur IotDpsSkuDefinitionListResult, getNextPage func(context.Context, IotDpsSkuDefinitionListResult) (IotDpsSkuDefinitionListResult, error)) IotDpsSkuDefinitionListResultPage

Creates a new instance of the IotDpsSkuDefinitionListResultPage type.

func (*IotDpsSkuDefinitionListResultPage) Next 

func (page *IotDpsSkuDefinitionListResultPage) Next() error

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

func (*IotDpsSkuDefinitionListResultPage) NextWithContext 

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

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

func (IotDpsSkuDefinitionListResultPage) NotDone 

func (page IotDpsSkuDefinitionListResultPage) NotDone() bool

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

func (IotDpsSkuDefinitionListResultPage) Response 

func (page IotDpsSkuDefinitionListResultPage) Response() IotDpsSkuDefinitionListResult

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

func (IotDpsSkuDefinitionListResultPage) Values 

func (page IotDpsSkuDefinitionListResultPage) Values() []IotDpsSkuDefinition

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

type IotDpsSkuInfo 

type IotDpsSkuInfo struct {
	// Name - Sku name. Possible values include: 'IotDpsSkuS1'
	Name IotDpsSku `json:"name,omitempty"`
	// Tier - READ-ONLY; Pricing tier name of the provisioning service.
	Tier *string `json:"tier,omitempty"`
	// Capacity - The number of units to provision
	Capacity *int64 `json:"capacity,omitempty"`
}

IotDpsSkuInfo list of possible provisioning service SKUs.

func (IotDpsSkuInfo) MarshalJSON 

func (idsi IotDpsSkuInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotDpsSkuInfo.

type ListPrivateEndpointConnection 

type ListPrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	Value             *[]PrivateEndpointConnection `json:"value,omitempty"`
}

ListPrivateEndpointConnection ...

type NameAvailabilityInfo 

type NameAvailabilityInfo struct {
	autorest.Response `json:"-"`
	// NameAvailable - specifies if a name is available or not
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - specifies the reason a name is unavailable. Possible values include: 'NameUnavailabilityReasonInvalid', 'NameUnavailabilityReasonAlreadyExists'
	Reason NameUnavailabilityReason `json:"reason,omitempty"`
	// Message - message containing a detailed reason name is unavailable
	Message *string `json:"message,omitempty"`
}

NameAvailabilityInfo description of name availability.

type NameUnavailabilityReason 

type NameUnavailabilityReason string

NameUnavailabilityReason enumerates the values for name unavailability reason. 

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

func PossibleNameUnavailabilityReasonValues 

func PossibleNameUnavailabilityReasonValues() []NameUnavailabilityReason

PossibleNameUnavailabilityReasonValues returns an array of possible values for the NameUnavailabilityReason const type.

type Operation 

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

Operation provisioning Service REST API operation.

func (Operation) MarshalJSON 

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

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

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

OperationDisplay the object that represents the operation.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationInputs 

type OperationInputs struct {
	// Name - 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 {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; Provisioning service operations supported by the Microsoft.Devices resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

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

func (*OperationListResultIterator) NextWithContext 

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

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

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

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

func (*OperationListResultPage) NextWithContext 

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

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

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the API for using the Azure IoT Hub Device Provisioning Service features.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

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

List lists all of the available Microsoft.Devices REST API operations.

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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

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

func (OperationsClient) ListSender 

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

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

type PrivateEndpoint 

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

PrivateEndpoint the private endpoint property of a private endpoint connection

func (PrivateEndpoint) MarshalJSON 

func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Properties - The properties of a private endpoint connection
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY
	SystemData *SystemData `json:"systemData,omitempty"`
}

PrivateEndpointConnection the private endpoint connection of a provisioning service

func (PrivateEndpointConnection) MarshalJSON 

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// PrivateEndpoint - The private endpoint property of a private endpoint connection
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
	// PrivateLinkServiceConnectionState - The current state of a private endpoint connection
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

PrivateEndpointConnectionProperties the properties of a private endpoint connection

type PrivateLinkResources 

type PrivateLinkResources struct {
	autorest.Response `json:"-"`
	// Value - 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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// Status - The status of a private endpoint connection. Possible values include: 'PrivateLinkServiceConnectionStatusPending', 'PrivateLinkServiceConnectionStatusApproved', 'PrivateLinkServiceConnectionStatusRejected', 'PrivateLinkServiceConnectionStatusDisconnected'
	Status PrivateLinkServiceConnectionStatus `json:"status,omitempty"`
	// Description - The description for the current state of a private endpoint connection
	Description *string `json:"description,omitempty"`
	// ActionsRequired - 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 enumerates the values for private link service connection status. 

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

func PossiblePrivateLinkServiceConnectionStatusValues 

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.

type ProvisioningServiceDescription 

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

ProvisioningServiceDescription the description of the provisioning service.

func (ProvisioningServiceDescription) MarshalJSON 

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

MarshalJSON is the custom marshaler for ProvisioningServiceDescription.

type ProvisioningServiceDescriptionListResult 

type ProvisioningServiceDescriptionListResult struct {
	autorest.Response `json:"-"`
	// Value - List of provisioning service descriptions.
	Value *[]ProvisioningServiceDescription `json:"value,omitempty"`
	// NextLink - READ-ONLY; the next link
	NextLink *string `json:"nextLink,omitempty"`
}

ProvisioningServiceDescriptionListResult list of provisioning service descriptions.

func (ProvisioningServiceDescriptionListResult) IsEmpty 

func (psdlr ProvisioningServiceDescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ProvisioningServiceDescriptionListResult) MarshalJSON 

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

MarshalJSON is the custom marshaler for ProvisioningServiceDescriptionListResult.

type ProvisioningServiceDescriptionListResultIterator 

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

ProvisioningServiceDescriptionListResultIterator provides access to a complete listing of ProvisioningServiceDescription values.

func NewProvisioningServiceDescriptionListResultIterator 

func NewProvisioningServiceDescriptionListResultIterator(page ProvisioningServiceDescriptionListResultPage) ProvisioningServiceDescriptionListResultIterator

Creates a new instance of the ProvisioningServiceDescriptionListResultIterator type.

func (*ProvisioningServiceDescriptionListResultIterator) Next 

func (iter *ProvisioningServiceDescriptionListResultIterator) Next() error

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

func (*ProvisioningServiceDescriptionListResultIterator) NextWithContext 

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

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

func (ProvisioningServiceDescriptionListResultIterator) NotDone 

func (iter ProvisioningServiceDescriptionListResultIterator) NotDone() bool

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

func (ProvisioningServiceDescriptionListResultIterator) Response 

func (iter ProvisioningServiceDescriptionListResultIterator) Response() ProvisioningServiceDescriptionListResult

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

func (ProvisioningServiceDescriptionListResultIterator) Value 

func (iter ProvisioningServiceDescriptionListResultIterator) Value() ProvisioningServiceDescription

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

type ProvisioningServiceDescriptionListResultPage 

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

ProvisioningServiceDescriptionListResultPage contains a page of ProvisioningServiceDescription values.

func NewProvisioningServiceDescriptionListResultPage 

func NewProvisioningServiceDescriptionListResultPage(cur ProvisioningServiceDescriptionListResult, getNextPage func(context.Context, ProvisioningServiceDescriptionListResult) (ProvisioningServiceDescriptionListResult, error)) ProvisioningServiceDescriptionListResultPage

Creates a new instance of the ProvisioningServiceDescriptionListResultPage type.

func (*ProvisioningServiceDescriptionListResultPage) Next 

func (page *ProvisioningServiceDescriptionListResultPage) Next() error

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

func (*ProvisioningServiceDescriptionListResultPage) NextWithContext 

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

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

func (ProvisioningServiceDescriptionListResultPage) NotDone 

func (page ProvisioningServiceDescriptionListResultPage) NotDone() bool

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

func (ProvisioningServiceDescriptionListResultPage) Response 

func (page ProvisioningServiceDescriptionListResultPage) Response() ProvisioningServiceDescriptionListResult

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

func (ProvisioningServiceDescriptionListResultPage) Values 

func (page ProvisioningServiceDescriptionListResultPage) Values() []ProvisioningServiceDescription

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

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess enumerates the values for public network access. 

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

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.

type Resource 

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

Resource the common properties of an Azure resource.

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription 

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription struct {
	autorest.Response `json:"-"`
	// KeyName - Name of the key.
	KeyName *string `json:"keyName,omitempty"`
	// PrimaryKey - Primary SAS key value.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - Secondary SAS key value.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
	// Rights - Rights that this key has. Possible values include: 'AccessRightsDescriptionServiceConfig', 'AccessRightsDescriptionEnrollmentRead', 'AccessRightsDescriptionEnrollmentWrite', 'AccessRightsDescriptionDeviceConnect', 'AccessRightsDescriptionRegistrationStatusRead', 'AccessRightsDescriptionRegistrationStatusWrite'
	Rights AccessRightsDescription `json:"rights,omitempty"`
}

SharedAccessSignatureAuthorizationRuleAccessRightsDescription description of the shared access key.

type SharedAccessSignatureAuthorizationRuleListResult 

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

SharedAccessSignatureAuthorizationRuleListResult list of shared access keys.

func (SharedAccessSignatureAuthorizationRuleListResult) IsEmpty 

func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON 

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

MarshalJSON is the custom marshaler for SharedAccessSignatureAuthorizationRuleListResult.

type SharedAccessSignatureAuthorizationRuleListResultIterator 

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

SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRuleAccessRightsDescription values.

func NewSharedAccessSignatureAuthorizationRuleListResultIterator 

func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.

func (*SharedAccessSignatureAuthorizationRuleListResultIterator) Next 

func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) Next() error

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

func (*SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext 

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

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

func (SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone 

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool

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

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Response 

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult

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

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Value 

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

type SharedAccessSignatureAuthorizationRuleListResultPage 

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

SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRuleAccessRightsDescription values.

func NewSharedAccessSignatureAuthorizationRuleListResultPage 

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

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.

func (*SharedAccessSignatureAuthorizationRuleListResultPage) Next 

func (page *SharedAccessSignatureAuthorizationRuleListResultPage) Next() error

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

func (*SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext 

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

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

func (SharedAccessSignatureAuthorizationRuleListResultPage) NotDone 

func (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool

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

func (SharedAccessSignatureAuthorizationRuleListResultPage) Response 

func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult

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

func (SharedAccessSignatureAuthorizationRuleListResultPage) Values 

func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

type State 

type State string

State enumerates the values for state. 

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

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TagsResource 

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

TagsResource a container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance.

func (TagsResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TagsResource.

type VerificationCodeRequest 

type VerificationCodeRequest struct {
	// Certificate - 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 {
	autorest.Response `json:"-"`
	// Name - READ-ONLY; Name of certificate.
	Name *string `json:"name,omitempty"`
	// Etag - READ-ONLY; Request etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type       *string                             `json:"type,omitempty"`
	Properties *VerificationCodeResponseProperties `json:"properties,omitempty"`
}

VerificationCodeResponse description of the response of the verification code.

func (VerificationCodeResponse) MarshalJSON 

func (vcr VerificationCodeResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VerificationCodeResponse.

type VerificationCodeResponseProperties 

type VerificationCodeResponseProperties struct {
	// VerificationCode - Verification code.
	VerificationCode *string `json:"verificationCode,omitempty"`
	// Subject - Certificate subject.
	Subject *string `json:"subject,omitempty"`
	// Expiry - Code expiry.
	Expiry *string `json:"expiry,omitempty"`
	// Thumbprint - Certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// IsVerified - Indicate if the certificate is verified by owner of private key.
	IsVerified *bool `json:"isVerified,omitempty"`
	// Certificate - base-64 representation of X509 certificate .cer file or just .pem file content.
	Certificate *[]byte `json:"certificate,omitempty"`
	// Created - Certificate created time.
	Created *string `json:"created,omitempty"`
	// Updated - Certificate updated time.
	Updated *string `json:"updated,omitempty"`
}

VerificationCodeResponseProperties ...

Source Files

View all Source files

Directories

Path Synopsis

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.