const (
// DefaultBaseURI is the default URI used for the service Iothub
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AccessRightsDescription enumerates the values for access rights description.
type AccessRightsDescription string
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() []AccessRightsDescription
PossibleAccessRightsDescriptionValues returns an array of possible values for the AccessRightsDescription const type.
AllocationPolicy enumerates the values for allocation policy.
type AllocationPolicy string
const (
// GeoLatency ...
GeoLatency AllocationPolicy = "GeoLatency"
// Hashed ...
Hashed AllocationPolicy = "Hashed"
// Static ...
Static AllocationPolicy = "Static"
)
func PossibleAllocationPolicyValues() []AllocationPolicy
PossibleAllocationPolicyValues returns an array of possible values for the AllocationPolicy const type.
AsyncOperationResult result of a long running operation.
type AsyncOperationResult struct {
autorest.Response `json:"-"`
Status *string `json:"status,omitempty"`
Error *ErrorMesssage `json:"error,omitempty"`
}
BaseClient is the base client for Iothub.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
CertificateBodyDescription the JSON-serialized X509 Certificate.
type CertificateBodyDescription struct {
// Certificate - Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
Certificate *string `json:"certificate,omitempty"`
}
CertificateListDescription the JSON-serialized array of Certificate objects.
type CertificateListDescription struct {
autorest.Response `json:"-"`
// Value - The array of Certificate objects.
Value *[]CertificateResponse `json:"value,omitempty"`
}
CertificateProperties the description of an X509 CA Certificate.
type CertificateProperties struct {
// Subject - READ-ONLY; The certificate's subject name.
Subject *string `json:"subject,omitempty"`
// Expiry - READ-ONLY; The certificate's expiration date and time.
Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
// Thumbprint - READ-ONLY; The certificate's thumbprint.
Thumbprint *string `json:"thumbprint,omitempty"`
// IsVerified - READ-ONLY; Determines whether certificate has been verified.
IsVerified *bool `json:"isVerified,omitempty"`
// Created - READ-ONLY; The certificate's 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"`
}
func (cp CertificateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateProperties.
CertificatePurpose enumerates the values for certificate purpose.
type CertificatePurpose string
const (
// ClientAuthentication ...
ClientAuthentication CertificatePurpose = "clientAuthentication"
// ServerAuthentication ...
ServerAuthentication CertificatePurpose = "serverAuthentication"
)
func PossibleCertificatePurposeValues() []CertificatePurpose
PossibleCertificatePurposeValues returns an array of possible values for the CertificatePurpose const type.
CertificateResponse the X509 Certificate.
type CertificateResponse struct {
autorest.Response `json:"-"`
Properties *CertificateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the certificate.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; The entity tag.
Etag *string `json:"etag,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
}
func (cr CertificateResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateResponse.
DefinitionDescription description of the IoT hub.
type DefinitionDescription struct {
ApplyAllocationPolicy *bool `json:"applyAllocationPolicy,omitempty"`
AllocationWeight *int32 `json:"allocationWeight,omitempty"`
// Name - READ-ONLY; 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"`
}
func (dd DefinitionDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DefinitionDescription.
DpsCertificateClient is the API for using the Azure IoT Hub Device Provisioning Service features.
type DpsCertificateClient struct {
BaseClient
}
func NewDpsCertificateClient(subscriptionID string) DpsCertificateClient
NewDpsCertificateClient creates an instance of the DpsCertificateClient client.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client DpsCertificateClient) GetPreparer(ctx context.Context, certificateName string, resourceGroupName string, provisioningServiceName string, ifMatch string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (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 (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.
DpsCertificatesClient is the API for using the Azure IoT Hub Device Provisioning Service features.
type DpsCertificatesClient struct {
BaseClient
}
func NewDpsCertificatesClient(subscriptionID string) DpsCertificatesClient
NewDpsCertificatesClient creates an instance of the DpsCertificatesClient client.
func NewDpsCertificatesClientWithBaseURI(baseURI string, subscriptionID string) DpsCertificatesClient
NewDpsCertificatesClientWithBaseURI creates an instance of the DpsCertificatesClient 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 (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 (client DpsCertificatesClient) ListPreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string) (*http.Request, error)
ListPreparer prepares the List request.
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 (client DpsCertificatesClient) 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.
ErrorDetails ...
type ErrorDetails struct {
// Code - READ-ONLY; error code.
Code *string `json:"code,omitempty"`
// HTTPStatusCode - READ-ONLY
HTTPStatusCode *string `json:"httpStatusCode,omitempty"`
Message *string `json:"message,omitempty"`
Details *string `json:"details,omitempty"`
}
func (ed ErrorDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetails.
ErrorMesssage error response containing message and code.
type ErrorMesssage struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Details *string `json:"details,omitempty"`
}
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 associated 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 - 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 *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"`
}
func (idpd IotDpsPropertiesDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotDpsPropertiesDescription.
IotDpsResourceClient is the API for using the Azure IoT Hub Device Provisioning Service features.
type IotDpsResourceClient struct {
BaseClient
}
func NewIotDpsResourceClient(subscriptionID string) IotDpsResourceClient
NewIotDpsResourceClient creates an instance of the IotDpsResourceClient client.
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 (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 (client IotDpsResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, arguments OperationInputs) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
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 (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 (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 (client IotDpsResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, provisioningServiceName string, iotDpsDescription ProvisioningServiceDescription) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client IotDpsResourceClient) DeletePreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (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 (client IotDpsResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, provisioningServiceName string, keyName string, resourceGroupName string) (*http.Request, error)
GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.
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 (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 (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 (client IotDpsResourceClient) GetOperationResultPreparer(ctx context.Context, operationID string, resourceGroupName string, provisioningServiceName string, asyncinfo string) (*http.Request, error)
GetOperationResultPreparer prepares the GetOperationResult request.
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 (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 (client IotDpsResourceClient) GetPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client IotDpsResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProvisioningServiceDescriptionListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotDpsResourceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client IotDpsResourceClient) ListBySubscription(ctx context.Context) (result ProvisioningServiceDescriptionListResultPage, err error)
ListBySubscription get all the provisioning services in a subscription.
func (client IotDpsResourceClient) ListBySubscriptionComplete(ctx context.Context) (result ProvisioningServiceDescriptionListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotDpsResourceClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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 (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 (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 (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 (client IotDpsResourceClient) ListKeysPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
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 (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 (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 (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 (client IotDpsResourceClient) ListValidSkusPreparer(ctx context.Context, provisioningServiceName string, resourceGroupName string) (*http.Request, error)
ListValidSkusPreparer prepares the ListValidSkus request.
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 (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.
IotDpsResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *IotDpsResourceCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IotDpsResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *IotDpsResourceDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IotDpsSku enumerates the values for iot dps sku.
type IotDpsSku string
const (
// S1 ...
S1 IotDpsSku = "S1"
)
func PossibleIotDpsSkuValues() []IotDpsSku
PossibleIotDpsSkuValues returns an array of possible values for the IotDpsSku const type.
IotDpsSkuDefinition SKU definition in terms of tier and units.
type IotDpsSkuDefinition struct {
// Name - Possible values include: 'S1'
Name IotDpsSku `json:"name,omitempty"`
}
IotDpsSkuDefinitionListResult list of available SKUs.
type IotDpsSkuDefinitionListResult struct {
autorest.Response `json:"-"`
Value *[]IotDpsSkuDefinition `json:"value,omitempty"`
// NextLink - READ-ONLY
NextLink *string `json:"nextLink,omitempty"`
}
func (idsdlr IotDpsSkuDefinitionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (idsdlr IotDpsSkuDefinitionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotDpsSkuDefinitionListResult.
IotDpsSkuDefinitionListResultIterator provides access to a complete listing of IotDpsSkuDefinition values.
type IotDpsSkuDefinitionListResultIterator struct {
// contains filtered or unexported fields
}
func NewIotDpsSkuDefinitionListResultIterator(page IotDpsSkuDefinitionListResultPage) IotDpsSkuDefinitionListResultIterator
Creates a new instance of the IotDpsSkuDefinitionListResultIterator type.
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 (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 (iter IotDpsSkuDefinitionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotDpsSkuDefinitionListResultIterator) Response() IotDpsSkuDefinitionListResult
Response returns the raw server response from the last page request.
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.
IotDpsSkuDefinitionListResultPage contains a page of IotDpsSkuDefinition values.
type IotDpsSkuDefinitionListResultPage struct {
// contains filtered or unexported fields
}
func NewIotDpsSkuDefinitionListResultPage(cur IotDpsSkuDefinitionListResult, getNextPage func(context.Context, IotDpsSkuDefinitionListResult) (IotDpsSkuDefinitionListResult, error)) IotDpsSkuDefinitionListResultPage
Creates a new instance of the IotDpsSkuDefinitionListResultPage type.
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 (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 (page IotDpsSkuDefinitionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotDpsSkuDefinitionListResultPage) Response() IotDpsSkuDefinitionListResult
Response returns the raw server response from the last page request.
func (page IotDpsSkuDefinitionListResultPage) Values() []IotDpsSkuDefinition
Values returns the slice of values for the current page or nil if there are no values.
IotDpsSkuInfo list of possible provisioning service SKUs.
type IotDpsSkuInfo struct {
// Name - Possible values include: 'S1'
Name IotDpsSku `json:"name,omitempty"`
// Tier - READ-ONLY; 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"`
}
func (idsi IotDpsSkuInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotDpsSkuInfo.
NameAvailabilityInfo description of name availability.
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"`
}
NameUnavailabilityReason enumerates the values for name unavailability reason.
type NameUnavailabilityReason string
const (
// AlreadyExists ...
AlreadyExists NameUnavailabilityReason = "AlreadyExists"
// Invalid ...
Invalid NameUnavailabilityReason = "Invalid"
)
func PossibleNameUnavailabilityReasonValues() []NameUnavailabilityReason
PossibleNameUnavailabilityReasonValues returns an array of possible values for the NameUnavailabilityReason const type.
Operation ioT Hub REST API 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"`
}
func (o Operation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Operation.
OperationDisplay the object that represents the operation.
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"`
}
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
OperationInputs input values for operation results call.
type OperationInputs struct {
// Name - The name of the Provisioning Service to check.
Name *string `json:"name,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.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of IoT Hub operations supported by the Microsoft.Devices resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
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 (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 (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
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.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
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 (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 (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the API for using the Azure IoT Hub Device Provisioning Service features.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Microsoft.Devices REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
ProvisioningServiceDescription the description of the provisioning service.
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 - 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"`
}
func (psd ProvisioningServiceDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProvisioningServiceDescription.
ProvisioningServiceDescriptionListResult list of provisioning service descriptions.
type ProvisioningServiceDescriptionListResult struct {
autorest.Response `json:"-"`
Value *[]ProvisioningServiceDescription `json:"value,omitempty"`
// NextLink - READ-ONLY
NextLink *string `json:"nextLink,omitempty"`
}
func (psdlr ProvisioningServiceDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (psdlr ProvisioningServiceDescriptionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProvisioningServiceDescriptionListResult.
ProvisioningServiceDescriptionListResultIterator provides access to a complete listing of ProvisioningServiceDescription values.
type ProvisioningServiceDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
func NewProvisioningServiceDescriptionListResultIterator(page ProvisioningServiceDescriptionListResultPage) ProvisioningServiceDescriptionListResultIterator
Creates a new instance of the ProvisioningServiceDescriptionListResultIterator type.
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 (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 (iter ProvisioningServiceDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProvisioningServiceDescriptionListResultIterator) Response() ProvisioningServiceDescriptionListResult
Response returns the raw server response from the last page request.
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.
ProvisioningServiceDescriptionListResultPage contains a page of ProvisioningServiceDescription values.
type ProvisioningServiceDescriptionListResultPage struct {
// contains filtered or unexported fields
}
func NewProvisioningServiceDescriptionListResultPage(cur ProvisioningServiceDescriptionListResult, getNextPage func(context.Context, ProvisioningServiceDescriptionListResult) (ProvisioningServiceDescriptionListResult, error)) ProvisioningServiceDescriptionListResultPage
Creates a new instance of the ProvisioningServiceDescriptionListResultPage type.
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 (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 (page ProvisioningServiceDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProvisioningServiceDescriptionListResultPage) Response() ProvisioningServiceDescriptionListResult
Response returns the raw server response from the last page request.
func (page ProvisioningServiceDescriptionListResultPage) Values() []ProvisioningServiceDescription
Values returns the slice of values for the current page or nil if there are no values.
Resource the common properties of an Azure 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription description of the shared access key.
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: 'ServiceConfig', 'EnrollmentRead', 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite'
Rights AccessRightsDescription `json:"rights,omitempty"`
}
SharedAccessSignatureAuthorizationRuleListResult list of shared access keys.
type SharedAccessSignatureAuthorizationRuleListResult struct {
autorest.Response `json:"-"`
Value *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"value,omitempty"`
// NextLink - READ-ONLY
NextLink *string `json:"nextLink,omitempty"`
}
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedAccessSignatureAuthorizationRuleListResult.
SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRuleAccessRightsDescription values.
type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
// contains filtered or unexported fields
}
func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.
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 (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 (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
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.
SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRuleAccessRightsDescription values.
type SharedAccessSignatureAuthorizationRuleListResultPage struct {
// contains filtered or unexported fields
}
func NewSharedAccessSignatureAuthorizationRuleListResultPage(cur SharedAccessSignatureAuthorizationRuleListResult, getNextPage func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)) SharedAccessSignatureAuthorizationRuleListResultPage
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.
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 (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 (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRuleAccessRightsDescription
Values returns the slice of values for the current page or nil if there are no values.
State enumerates the values for state.
type State string
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() []State
PossibleStateValues returns an array of possible values for the State const type.
VerificationCodeRequest certificate to generate verification code for.
type VerificationCodeRequest struct {
Certificate *string `json:"certificate,omitempty"`
}
VerificationCodeResponse description of the response of the verification code.
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"`
}