Documentation ¶
Overview ¶
Package iothub implements the Azure ARM Iothub service API version 2017-08-21-preview.
API for using the Azure IoT Hub Device Provisioning Service features.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AccessRightsDescription
- type AllocationPolicy
- type AsyncOperationResult
- type BaseClient
- type CertificateBodyDescription
- type CertificateListDescription
- type CertificateProperties
- type CertificatePurpose
- type CertificateResponse
- type DefinitionDescription
- type DpsCertificateClient
- func (client DpsCertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, ...) (result CertificateResponse, err error)
- func (client DpsCertificateClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string, ...) (*http.Request, error)
- func (client DpsCertificateClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateResponse, err error)
- func (client DpsCertificateClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client DpsCertificateClient) Delete(ctx context.Context, resourceGroupName string, ifMatch string, ...) (result autorest.Response, err error)
- func (client DpsCertificateClient) DeletePreparer(ctx context.Context, resourceGroupName string, ifMatch string, ...) (*http.Request, error)
- func (client DpsCertificateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DpsCertificateClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client DpsCertificateClient) GenerateVerificationCode(ctx context.Context, certificateName string, ifMatch string, ...) (result VerificationCodeResponse, err error)
- func (client DpsCertificateClient) GenerateVerificationCodePreparer(ctx context.Context, certificateName string, ifMatch string, ...) (*http.Request, error)
- func (client DpsCertificateClient) GenerateVerificationCodeResponder(resp *http.Response) (result VerificationCodeResponse, err error)
- func (client DpsCertificateClient) GenerateVerificationCodeSender(req *http.Request) (*http.Response, error)
- func (client DpsCertificateClient) Get(ctx context.Context, certificateName string, resourceGroupName string, ...) (result CertificateResponse, err error)
- func (client DpsCertificateClient) GetPreparer(ctx context.Context, certificateName string, resourceGroupName string, ...) (*http.Request, error)
- func (client DpsCertificateClient) GetResponder(resp *http.Response) (result CertificateResponse, err error)
- func (client DpsCertificateClient) GetSender(req *http.Request) (*http.Response, error)
- func (client DpsCertificateClient) VerifyCertificate(ctx context.Context, certificateName string, ifMatch string, ...) (result CertificateResponse, err error)
- func (client DpsCertificateClient) VerifyCertificatePreparer(ctx context.Context, certificateName string, ifMatch string, ...) (*http.Request, error)
- func (client DpsCertificateClient) VerifyCertificateResponder(resp *http.Response) (result CertificateResponse, err error)
- func (client DpsCertificateClient) VerifyCertificateSender(req *http.Request) (*http.Response, error)
- type DpsCertificatesClient
- func (client DpsCertificatesClient) List(ctx context.Context, resourceGroupName string, provisioningServiceName string) (result CertificateListDescription, err error)
- func (client DpsCertificatesClient) ListPreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string) (*http.Request, error)
- func (client DpsCertificatesClient) ListResponder(resp *http.Response) (result CertificateListDescription, err error)
- func (client DpsCertificatesClient) ListSender(req *http.Request) (*http.Response, error)
- type ErrorDetails
- type ErrorMesssage
- type IotDpsPropertiesDescription
- type IotDpsResourceClient
- func (client IotDpsResourceClient) CheckNameAvailability(ctx context.Context, arguments OperationInputs) (result NameAvailabilityInfo, err error)
- func (client IotDpsResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, arguments OperationInputs) (*http.Request, error)
- func (client IotDpsResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityInfo, err error)
- func (client IotDpsResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, provisioningServiceName string, ...) (result IotDpsResourceCreateOrUpdateFuture, err error)
- func (client IotDpsResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string, ...) (*http.Request, error)
- func (client IotDpsResourceClient) CreateOrUpdateResponder(resp *http.Response) (result ProvisioningServiceDescription, err error)
- func (client IotDpsResourceClient) CreateOrUpdateSender(req *http.Request) (future IotDpsResourceCreateOrUpdateFuture, err error)
- func (client IotDpsResourceClient) Delete(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsResourceDeleteFuture, err error)
- func (client IotDpsResourceClient) DeletePreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
- func (client IotDpsResourceClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client IotDpsResourceClient) DeleteSender(req *http.Request) (future IotDpsResourceDeleteFuture, err error)
- func (client IotDpsResourceClient) Get(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result ProvisioningServiceDescription, err error)
- func (client IotDpsResourceClient) GetKeysForKeyName(ctx context.Context, provisioningServiceName string, keyName string, ...) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, ...)
- func (client IotDpsResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, provisioningServiceName string, keyName string, ...) (*http.Request, error)
- func (client IotDpsResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, ...)
- func (client IotDpsResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) GetOperationResult(ctx context.Context, operationID string, resourceGroupName string, ...) (result AsyncOperationResult, err error)
- func (client IotDpsResourceClient) GetOperationResultPreparer(ctx context.Context, operationID string, resourceGroupName string, ...) (*http.Request, error)
- func (client IotDpsResourceClient) GetOperationResultResponder(resp *http.Response) (result AsyncOperationResult, err error)
- func (client IotDpsResourceClient) GetOperationResultSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) GetPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
- func (client IotDpsResourceClient) GetResponder(resp *http.Response) (result ProvisioningServiceDescription, err error)
- func (client IotDpsResourceClient) GetSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProvisioningServiceDescriptionListResultPage, err error)
- func (client IotDpsResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProvisioningServiceDescriptionListResultIterator, err error)
- func (client IotDpsResourceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client IotDpsResourceClient) ListByResourceGroupResponder(resp *http.Response) (result ProvisioningServiceDescriptionListResult, err error)
- func (client IotDpsResourceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) ListBySubscription(ctx context.Context) (result ProvisioningServiceDescriptionListResultPage, err error)
- func (client IotDpsResourceClient) ListBySubscriptionComplete(ctx context.Context) (result ProvisioningServiceDescriptionListResultIterator, err error)
- func (client IotDpsResourceClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client IotDpsResourceClient) ListBySubscriptionResponder(resp *http.Response) (result ProvisioningServiceDescriptionListResult, err error)
- func (client IotDpsResourceClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) ListKeys(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result SharedAccessSignatureAuthorizationRuleListResultPage, err error)
- func (client IotDpsResourceClient) ListKeysComplete(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result SharedAccessSignatureAuthorizationRuleListResultIterator, err error)
- func (client IotDpsResourceClient) ListKeysPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
- func (client IotDpsResourceClient) ListKeysResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
- func (client IotDpsResourceClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client IotDpsResourceClient) ListValidSkus(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsSkuDefinitionListResultPage, err error)
- func (client IotDpsResourceClient) ListValidSkusComplete(ctx context.Context, provisioningServiceName string, resourceGroupName string) (result IotDpsSkuDefinitionListResultIterator, err error)
- func (client IotDpsResourceClient) ListValidSkusPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
- func (client IotDpsResourceClient) ListValidSkusResponder(resp *http.Response) (result IotDpsSkuDefinitionListResult, err error)
- func (client IotDpsResourceClient) ListValidSkusSender(req *http.Request) (*http.Response, error)
- type IotDpsResourceCreateOrUpdateFuture
- type IotDpsResourceDeleteFuture
- type IotDpsSku
- type IotDpsSkuDefinition
- type IotDpsSkuDefinitionListResult
- type IotDpsSkuDefinitionListResultIterator
- type IotDpsSkuDefinitionListResultPage
- type IotDpsSkuInfo
- type NameAvailabilityInfo
- type NameUnavailabilityReason
- type Operation
- type OperationDisplay
- type OperationInputs
- type OperationListResult
- type OperationListResultIterator
- type OperationListResultPage
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProvisioningServiceDescription
- type ProvisioningServiceDescriptionListResult
- type ProvisioningServiceDescriptionListResultIterator
- func (iter *ProvisioningServiceDescriptionListResultIterator) Next() error
- func (iter ProvisioningServiceDescriptionListResultIterator) NotDone() bool
- func (iter ProvisioningServiceDescriptionListResultIterator) Response() ProvisioningServiceDescriptionListResult
- func (iter ProvisioningServiceDescriptionListResultIterator) Value() ProvisioningServiceDescription
- type ProvisioningServiceDescriptionListResultPage
- func (page *ProvisioningServiceDescriptionListResultPage) Next() error
- func (page ProvisioningServiceDescriptionListResultPage) NotDone() bool
- func (page ProvisioningServiceDescriptionListResultPage) Response() ProvisioningServiceDescriptionListResult
- func (page ProvisioningServiceDescriptionListResultPage) Values() []ProvisioningServiceDescription
- type Resource
- type SharedAccessSignatureAuthorizationRuleAccessRightsDescription
- type SharedAccessSignatureAuthorizationRuleListResult
- type SharedAccessSignatureAuthorizationRuleListResultIterator
- func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) Next() error
- func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool
- func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult
- func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRuleAccessRightsDescription
- type SharedAccessSignatureAuthorizationRuleListResultPage
- func (page *SharedAccessSignatureAuthorizationRuleListResultPage) Next() error
- func (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool
- func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult
- func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRuleAccessRightsDescription
- type State
- type VerificationCodeRequest
- type VerificationCodeResponse
Constants ¶
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 ( // DeviceConnect ... DeviceConnect AccessRightsDescription = "DeviceConnect" // EnrollmentRead ... EnrollmentRead AccessRightsDescription = "EnrollmentRead" // EnrollmentWrite ... EnrollmentWrite AccessRightsDescription = "EnrollmentWrite" // RegistrationStatusRead ... RegistrationStatusRead AccessRightsDescription = "RegistrationStatusRead" // RegistrationStatusWrite ... RegistrationStatusWrite AccessRightsDescription = "RegistrationStatusWrite" // ServiceConfig ... ServiceConfig 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 ( // GeoLatency ... GeoLatency AllocationPolicy = "GeoLatency" // Hashed ... Hashed AllocationPolicy = "Hashed" // Static ... Static 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 *string `json:"status,omitempty"` Error *ErrorMesssage `json:"error,omitempty"` }
AsyncOperationResult result of a long running operation.
type BaseClient ¶
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.
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"` }
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 - The certificate's subject name. Subject *string `json:"subject,omitempty"` // Expiry - The certificate's expiration date and time. Expiry *date.TimeRFC1123 `json:"expiry,omitempty"` // Thumbprint - The certificate's thumbprint. Thumbprint *string `json:"thumbprint,omitempty"` // IsVerified - Determines whether certificate has been verified. IsVerified *bool `json:"isVerified,omitempty"` // Created - The certificate's creation date and time. Created *date.TimeRFC1123 `json:"created,omitempty"` // Updated - The certificate's last update date and time. Updated *date.TimeRFC1123 `json:"updated,omitempty"` }
CertificateProperties the description of an X509 CA Certificate.
type CertificatePurpose ¶
type CertificatePurpose string
CertificatePurpose enumerates the values for certificate purpose.
const ( // ClientAuthentication ... ClientAuthentication CertificatePurpose = "clientAuthentication" // ServerAuthentication ... ServerAuthentication 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 *CertificateProperties `json:"properties,omitempty"` // ID - The resource identifier. ID *string `json:"id,omitempty"` // Name - The name of the certificate. Name *string `json:"name,omitempty"` // Etag - The entity tag. Etag *string `json:"etag,omitempty"` // Type - The resource type. Type *string `json:"type,omitempty"` }
CertificateResponse the X509 Certificate.
type DefinitionDescription ¶
type DefinitionDescription struct { ApplyAllocationPolicy *bool `json:"applyAllocationPolicy,omitempty"` AllocationWeight *int32 `json:"allocationWeight,omitempty"` // Name - Host name of the IoT hub. Name *string `json:"name,omitempty"` // ConnectionString - Connection string og 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.
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.
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 ¶
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 sends the delete request. 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 ¶
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 ¶
GetSender sends the Get 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 certificate for the provisioning service. Parameters: certificateName - the mandatory logical name of the certificate, that the provisioning service uses to access. ifMatch - eTag 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 DpsCertificatesClient ¶
type DpsCertificatesClient struct {
BaseClient
}
DpsCertificatesClient is the API for using the Azure IoT Hub Device Provisioning Service features.
func NewDpsCertificatesClient ¶
func NewDpsCertificatesClient(subscriptionID string) DpsCertificatesClient
NewDpsCertificatesClient creates an instance of the DpsCertificatesClient client.
func NewDpsCertificatesClientWithBaseURI ¶
func NewDpsCertificatesClientWithBaseURI(baseURI string, subscriptionID string) DpsCertificatesClient
NewDpsCertificatesClientWithBaseURI creates an instance of the DpsCertificatesClient client.
func (DpsCertificatesClient) List ¶
func (client DpsCertificatesClient) 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 (DpsCertificatesClient) ListPreparer ¶
func (client DpsCertificatesClient) ListPreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (DpsCertificatesClient) ListResponder ¶
func (client DpsCertificatesClient) 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 (DpsCertificatesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ErrorDetails ¶
type ErrorDetails struct { // Code - error code. Code *string `json:"code,omitempty"` HTTPStatusCode *string `json:"httpStatusCode,omitempty"` Message *string `json:"message,omitempty"` Details *string `json:"details,omitempty"` }
ErrorDetails ...
type ErrorMesssage ¶
type ErrorMesssage struct { Code *string `json:"code,omitempty"` Message *string `json:"message,omitempty"` Details *string `json:"details,omitempty"` }
ErrorMesssage error response containing message and code.
type IotDpsPropertiesDescription ¶
type IotDpsPropertiesDescription struct { // State - Current state of the provisioning service. Possible values include: 'Activating', 'Active', 'Deleting', 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' State State `json:"state,omitempty"` // ProvisioningState - The ARM provisioning state of the provisioning service. ProvisioningState *string `json:"provisioningState,omitempty"` // IotHubs - List of IoT hubs assosciated with this provisioning service. IotHubs *[]DefinitionDescription `json:"iotHubs,omitempty"` // AllocationPolicy - Allocation policy to be used by this provisioning service. Possible values include: 'Hashed', 'GeoLatency', 'Static' AllocationPolicy AllocationPolicy `json:"allocationPolicy,omitempty"` // ServiceOperationsHostName - Service endpoint for provisioning service. ServiceOperationsHostName *string `json:"serviceOperationsHostName,omitempty"` // DeviceProvisioningHostName - Device endpoint for this provisioning service. DeviceProvisioningHostName *string `json:"deviceProvisioningHostName,omitempty"` // IDScope - Unique identifier of this provisioning service. IDScope *string `json:"idScope,omitempty"` AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"` }
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.
func (IotDpsResourceClient) CheckNameAvailability ¶
func (client IotDpsResourceClient) CheckNameAvailability(ctx context.Context, arguments OperationInputs) (result NameAvailabilityInfo, err error)
CheckNameAvailability check if a provisioning service name is available. Parameters: arguments - set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
func (IotDpsResourceClient) CheckNameAvailabilityPreparer ¶
func (client IotDpsResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, arguments OperationInputs) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (IotDpsResourceClient) CheckNameAvailabilityResponder ¶
func (client IotDpsResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityInfo, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (IotDpsResourceClient) CheckNameAvailabilitySender ¶
func (client IotDpsResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (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) 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 sends the delete request. 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) 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 non-security related metadata of the provisioning service. Parameters: provisioningServiceName - name of the provisioning service to retrieve. resourceGroupName - resource group name.
func (IotDpsResourceClient) GetKeysForKeyName ¶
func (client IotDpsResourceClient) GetKeysForKeyName(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, err error)
GetKeysForKeyName get a shared access policy by name from a provisioning service. 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) GetKeysForKeyNamePreparer ¶
func (client IotDpsResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string) (*http.Request, error)
GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.
func (IotDpsResourceClient) GetKeysForKeyNameResponder ¶
func (client IotDpsResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleAccessRightsDescription, err error)
GetKeysForKeyNameResponder handles the response to the GetKeysForKeyName request. The method always closes the http.Response Body.
func (IotDpsResourceClient) GetKeysForKeyNameSender ¶
func (client IotDpsResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)
GetKeysForKeyNameSender sends the GetKeysForKeyName request. The method will close the http.Response Body if it receives an error.
func (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) 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 ¶
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 get all the provisioning services in a subscription.
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 get the security metadata 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) 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 ¶
ListKeysSender sends the ListKeys 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 get the list of valid SKUs 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 ¶
ListValidSkusSender sends the ListValidSkus request. The method will close the http.Response Body if it receives an error.
type IotDpsResourceCreateOrUpdateFuture ¶
IotDpsResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*IotDpsResourceCreateOrUpdateFuture) Result ¶
func (future *IotDpsResourceCreateOrUpdateFuture) Result(client IotDpsResourceClient) (psd ProvisioningServiceDescription, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type IotDpsResourceDeleteFuture ¶
IotDpsResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*IotDpsResourceDeleteFuture) Result ¶
func (future *IotDpsResourceDeleteFuture) Result(client IotDpsResourceClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type IotDpsSku ¶
type IotDpsSku string
IotDpsSku enumerates the values for iot dps sku.
const ( // S1 ... S1 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 - Possible values include: 'S1' Name IotDpsSku `json:"name,omitempty"` }
IotDpsSkuDefinition SKU definition in terms of tier and units.
type IotDpsSkuDefinitionListResult ¶
type IotDpsSkuDefinitionListResult struct { autorest.Response `json:"-"` Value *[]IotDpsSkuDefinition `json:"value,omitempty"` 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.
type IotDpsSkuDefinitionListResultIterator ¶
type IotDpsSkuDefinitionListResultIterator struct {
// contains filtered or unexported fields
}
IotDpsSkuDefinitionListResultIterator provides access to a complete listing of IotDpsSkuDefinition values.
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.
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 (*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.
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 - Possible values include: 'S1' Name IotDpsSku `json:"name,omitempty"` // Tier - Pricing tier of the provisioning service. Tier *string `json:"tier,omitempty"` // Capacity - The number of services of the selected tier allowed in the subscription. Capacity *int64 `json:"capacity,omitempty"` }
IotDpsSkuInfo list of possible provisoning service SKUs.
type NameAvailabilityInfo ¶
type NameAvailabilityInfo struct { autorest.Response `json:"-"` NameAvailable *bool `json:"nameAvailable,omitempty"` // Reason - Possible values include: 'Invalid', 'AlreadyExists' Reason NameUnavailabilityReason `json:"reason,omitempty"` Message *string `json:"message,omitempty"` }
NameAvailabilityInfo description of name availability.
type NameUnavailabilityReason ¶
type NameUnavailabilityReason string
NameUnavailabilityReason enumerates the values for name unavailability reason.
const ( // AlreadyExists ... AlreadyExists NameUnavailabilityReason = "AlreadyExists" // Invalid ... Invalid 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 - Operation name: {provider}/{resource}/{read | write | action | delete} Name *string `json:"name,omitempty"` // Display - The object that represents the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation ioT Hub REST API operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - Service provider: Microsoft Devices. Provider *string `json:"provider,omitempty"` // Resource - Resource Type: ProvisioningServices. Resource *string `json:"resource,omitempty"` // Operation - Name of the operation. Operation *string `json:"operation,omitempty"` }
OperationDisplay the object that represents the operation.
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 - List of IoT Hub operations supported by the Microsoft.Devices resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
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.
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 (*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.
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.
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 ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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 *IotDpsPropertiesDescription `json:"properties,omitempty"` Sku *IotDpsSkuInfo `json:"sku,omitempty"` // ID - The resource identifier. ID *string `json:"id,omitempty"` // Name - The resource name. Name *string `json:"name,omitempty"` // Type - 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 *[]ProvisioningServiceDescription `json:"value,omitempty"` 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.
type ProvisioningServiceDescriptionListResultIterator ¶
type ProvisioningServiceDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
ProvisioningServiceDescriptionListResultIterator provides access to a complete listing of ProvisioningServiceDescription values.
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.
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 (*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.
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 Resource ¶
type Resource struct { // ID - The resource identifier. ID *string `json:"id,omitempty"` // Name - The resource name. Name *string `json:"name,omitempty"` // Type - 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 ¶
MarshalJSON is the custom marshaler for Resource.
type SharedAccessSignatureAuthorizationRuleAccessRightsDescription ¶
type SharedAccessSignatureAuthorizationRuleAccessRightsDescription struct { string `json:"keyName,omitempty"` PrimaryKey *string `json:"primaryKey,omitempty"` SecondaryKey *string `json:"secondaryKey,omitempty"` Rights AccessRightsDescription `json:"rights,omitempty"` }KeyName *
SharedAccessSignatureAuthorizationRuleAccessRightsDescription description of the shared access key.
type SharedAccessSignatureAuthorizationRuleListResult ¶
type SharedAccessSignatureAuthorizationRuleListResult struct {}
SharedAccessSignatureAuthorizationRuleListResult list of shared access keys.
func (SharedAccessSignatureAuthorizationRuleListResult) IsEmpty ¶
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SharedAccessSignatureAuthorizationRuleListResultIterator ¶
type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
// contains filtered or unexported fields
}
SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRuleAccessRightsDescription values.
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.
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 (*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.
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 ( // Activating ... Activating State = "Activating" // ActivationFailed ... ActivationFailed State = "ActivationFailed" // Active ... Active State = "Active" // Deleted ... Deleted State = "Deleted" // Deleting ... Deleting State = "Deleting" // DeletionFailed ... DeletionFailed State = "DeletionFailed" // FailingOver ... FailingOver State = "FailingOver" // FailoverFailed ... FailoverFailed State = "FailoverFailed" // Resuming ... Resuming State = "Resuming" // Suspended ... Suspended State = "Suspended" // Suspending ... Suspending State = "Suspending" // Transitioning ... Transitioning State = "Transitioning" )
func PossibleStateValues ¶
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
type VerificationCodeRequest ¶
type VerificationCodeRequest struct {
Certificate *string `json:"certificate,omitempty"`
}
VerificationCodeRequest certificate to generate verification code for.
type VerificationCodeResponse ¶
type VerificationCodeResponse struct { autorest.Response `json:"-"` // VerificationCode - Verification code. VerificationCode *string `json:"verificationCode,omitempty"` // Name - Name of certificate. Name *string `json:"name,omitempty"` // Etag - Request etag. Etag *string `json:"etag,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"` // Created - Certificate created time. Created *string `json:"created,omitempty"` // Updated - Certificate updated time. Updated *string `json:"updated,omitempty"` }
VerificationCodeResponse description of the response of the verification code.