@azure/arm-deviceprovisioningservices package
Classes
| IotDpsClient |
Interfaces
| AsyncOperationResult |
Result of a long running operation. |
| CertificateBodyDescription |
The JSON-serialized X509 Certificate. |
| CertificateListDescription |
The JSON-serialized array of Certificate objects. |
| CertificateProperties |
The description of an X509 CA Certificate. |
| CertificateResponse |
The X509 Certificate. |
| DpsCertificate |
Interface representing a DpsCertificate. |
| DpsCertificateCreateOrUpdateOptionalParams |
Optional parameters. |
| DpsCertificateDeleteOptionalParams |
Optional parameters. |
| DpsCertificateGenerateVerificationCodeOptionalParams |
Optional parameters. |
| DpsCertificateGetOptionalParams |
Optional parameters. |
| DpsCertificateListOptionalParams |
Optional parameters. |
| DpsCertificateVerifyCertificateOptionalParams |
Optional parameters. |
| ErrorDetails |
Error details. |
| ErrorMessage |
Error response containing message and code. |
| GroupIdInformation |
The group information for creating a private endpoint on a provisioning service |
| GroupIdInformationProperties |
The properties for a group information object |
| IotDpsClientOptionalParams |
Optional parameters. |
| IotDpsPropertiesDescription |
the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope |
| IotDpsResource |
Interface representing a IotDpsResource. |
| IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams |
Optional parameters. |
| IotDpsResourceCreateOrUpdateOptionalParams |
Optional parameters. |
| IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams |
Optional parameters. |
| IotDpsResourceDeleteOptionalParams |
Optional parameters. |
| IotDpsResourceDeletePrivateEndpointConnectionHeaders |
Defines headers for IotDpsResource_deletePrivateEndpointConnection operation. |
| IotDpsResourceDeletePrivateEndpointConnectionOptionalParams |
Optional parameters. |
| IotDpsResourceGetOperationResultOptionalParams |
Optional parameters. |
| IotDpsResourceGetOptionalParams |
Optional parameters. |
| IotDpsResourceGetPrivateEndpointConnectionOptionalParams |
Optional parameters. |
| IotDpsResourceGetPrivateLinkResourcesOptionalParams |
Optional parameters. |
| IotDpsResourceListByResourceGroupNextOptionalParams |
Optional parameters. |
| IotDpsResourceListByResourceGroupOptionalParams |
Optional parameters. |
| IotDpsResourceListBySubscriptionNextOptionalParams |
Optional parameters. |
| IotDpsResourceListBySubscriptionOptionalParams |
Optional parameters. |
| IotDpsResourceListKeysForKeyNameOptionalParams |
Optional parameters. |
| IotDpsResourceListKeysNextOptionalParams |
Optional parameters. |
| IotDpsResourceListKeysOptionalParams |
Optional parameters. |
| IotDpsResourceListPrivateEndpointConnectionsOptionalParams |
Optional parameters. |
| IotDpsResourceListPrivateLinkResourcesOptionalParams |
Optional parameters. |
| IotDpsResourceListValidSkusNextOptionalParams |
Optional parameters. |
| IotDpsResourceListValidSkusOptionalParams |
Optional parameters. |
| IotDpsResourceUpdateOptionalParams |
Optional parameters. |
| IotDpsSkuDefinition |
Available SKUs of tier and units. |
| IotDpsSkuDefinitionListResult |
List of available SKUs. |
| IotDpsSkuInfo |
List of possible provisioning service SKUs. |
| IotHubDefinitionDescription |
Description of the IoT hub. |
| IpFilterRule |
The IP filter rules for a provisioning Service. |
| NameAvailabilityInfo |
Description of name availability. |
| Operation |
Provisioning Service REST API operation. |
| OperationDisplay |
The object that represents the operation. |
| OperationInputs |
Input values for operation results call. |
| OperationListResult |
Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PrivateEndpoint |
The private endpoint property of a private endpoint connection |
| PrivateEndpointConnection |
The private endpoint connection of a provisioning service |
| PrivateEndpointConnectionProperties |
The properties of a private endpoint connection |
| PrivateLinkResources |
The available private link resources for a provisioning service |
| PrivateLinkServiceConnectionState |
The current state of a private endpoint connection |
| ProvisioningServiceDescription |
The description of the provisioning service. |
| ProvisioningServiceDescriptionListResult |
List of provisioning service descriptions. |
| Resource |
The common properties of an Azure resource. |
| SharedAccessSignatureAuthorizationRuleAccessRightsDescription |
Description of the shared access key. |
| SharedAccessSignatureAuthorizationRuleListResult |
List of shared access keys. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TagsResource |
A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance. |
| VerificationCodeRequest |
The JSON-serialized leaf certificate |
| VerificationCodeResponse |
Description of the response of the verification code. |
| VerificationCodeResponseProperties | |
Type Aliases
| AccessRightsDescription |
Defines values for AccessRightsDescription. Known values supported by the serviceServiceConfig |
| AllocationPolicy |
Defines values for AllocationPolicy. Known values supported by the serviceHashed |
| CertificatePurpose |
Defines values for CertificatePurpose. Known values supported by the serviceclientAuthentication |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DpsCertificateCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| DpsCertificateGenerateVerificationCodeResponse |
Contains response data for the generateVerificationCode operation. |
| DpsCertificateGetResponse |
Contains response data for the get operation. |
| DpsCertificateListResponse |
Contains response data for the list operation. |
| DpsCertificateVerifyCertificateResponse |
Contains response data for the verifyCertificate operation. |
| IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse |
Contains response data for the checkProvisioningServiceNameAvailability operation. |
| IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse |
Contains response data for the createOrUpdatePrivateEndpointConnection operation. |
| IotDpsResourceCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| IotDpsResourceDeletePrivateEndpointConnectionResponse |
Contains response data for the deletePrivateEndpointConnection operation. |
| IotDpsResourceGetOperationResultResponse |
Contains response data for the getOperationResult operation. |
| IotDpsResourceGetPrivateEndpointConnectionResponse |
Contains response data for the getPrivateEndpointConnection operation. |
| IotDpsResourceGetPrivateLinkResourcesResponse |
Contains response data for the getPrivateLinkResources operation. |
| IotDpsResourceGetResponse |
Contains response data for the get operation. |
| IotDpsResourceListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| IotDpsResourceListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| IotDpsResourceListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| IotDpsResourceListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| IotDpsResourceListKeysForKeyNameResponse |
Contains response data for the listKeysForKeyName operation. |
| IotDpsResourceListKeysNextResponse |
Contains response data for the listKeysNext operation. |
| IotDpsResourceListKeysResponse |
Contains response data for the listKeys operation. |
| IotDpsResourceListPrivateEndpointConnectionsResponse |
Contains response data for the listPrivateEndpointConnections operation. |
| IotDpsResourceListPrivateLinkResourcesResponse |
Contains response data for the listPrivateLinkResources operation. |
| IotDpsResourceListValidSkusNextResponse |
Contains response data for the listValidSkusNext operation. |
| IotDpsResourceListValidSkusResponse |
Contains response data for the listValidSkus operation. |
| IotDpsResourceUpdateResponse |
Contains response data for the update operation. |
| IotDpsSku |
Defines values for IotDpsSku. Known values supported by the serviceS1 |
| IpFilterActionType |
Defines values for IpFilterActionType. |
| IpFilterTargetType |
Defines values for IpFilterTargetType. |
| NameUnavailabilityReason |
Defines values for NameUnavailabilityReason. Known values supported by the serviceInvalid |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| PrivateLinkServiceConnectionStatus |
Defines values for PrivateLinkServiceConnectionStatus. Known values supported by the servicePending |
| PublicNetworkAccess |
Defines values for PublicNetworkAccess. Known values supported by the serviceEnabled |
| State |
Defines values for State. Known values supported by the serviceActivating |
Enums
| KnownAccessRightsDescription |
Known values of AccessRightsDescription that the service accepts. |
| KnownAllocationPolicy |
Known values of AllocationPolicy that the service accepts. |
| KnownCertificatePurpose |
Known values of CertificatePurpose that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownIotDpsSku |
Known values of IotDpsSku that the service accepts. |
| KnownNameUnavailabilityReason |
Known values of NameUnavailabilityReason that the service accepts. |
| KnownPrivateLinkServiceConnectionStatus |
Known values of PrivateLinkServiceConnectionStatus that the service accepts. |
| KnownPublicNetworkAccess |
Known values of PublicNetworkAccess that the service accepts. |
| KnownState |
Known values of State that the service accepts. |
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.