@azure/arm-deviceprovisioningservices package

Classes

Interfaces

AsyncOperationResult	Result of a long running operation.
CertificateProperties	The description of an X509 CA Certificate.
CertificateResponse	The X509 Certificate.
DeviceRegistryNamespaceDescription	Description of the Device Registry namespace that is linked to the provisioning service.
DpsCertificateCreateOrUpdateOptionalParams	Optional parameters.
DpsCertificateDeleteOptionalParams	Optional parameters.
DpsCertificateGenerateVerificationCodeOptionalParams	Optional parameters.
DpsCertificateGetOptionalParams	Optional parameters.
DpsCertificateListOptionalParams	Optional parameters.
DpsCertificateOperations	Interface representing a DpsCertificate operations.
DpsCertificateVerifyCertificateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorDetails	Error details.
ErrorMessage	Error response containing message and code.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
GroupIdInformation	The group information for creating a private endpoint on a provisioning service
GroupIdInformationProperties	The properties for a group information object
IotDpsClientOptionalParams	Optional parameters for the client.
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
IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams	Optional parameters.
IotDpsResourceCreateOrUpdateOptionalParams	Optional parameters.
IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams	Optional parameters.
IotDpsResourceDeleteOptionalParams	Optional parameters.
IotDpsResourceDeletePrivateEndpointConnectionOptionalParams	Optional parameters.
IotDpsResourceGetOperationResultOptionalParams	Optional parameters.
IotDpsResourceGetOptionalParams	Optional parameters.
IotDpsResourceGetPrivateEndpointConnectionOptionalParams	Optional parameters.
IotDpsResourceGetPrivateLinkResourcesOptionalParams	Optional parameters.
IotDpsResourceListByResourceGroupOptionalParams	Optional parameters.
IotDpsResourceListBySubscriptionOptionalParams	Optional parameters.
IotDpsResourceListKeysForKeyNameOptionalParams	Optional parameters.
IotDpsResourceListKeysOptionalParams	Optional parameters.
IotDpsResourceListPrivateEndpointConnectionsOptionalParams	Optional parameters.
IotDpsResourceListPrivateLinkResourcesOptionalParams	Optional parameters.
IotDpsResourceListValidSkusOptionalParams	Optional parameters.
IotDpsResourceOperations	Interface representing a IotDpsResource operations.
IotDpsResourceUpdateOptionalParams	Optional parameters.
IotDpsSkuDefinition	Available SKUs of tier and units.
IotDpsSkuInfo	List of possible provisioning service SKUs.
IotHubDefinitionDescription	Description of the IoT hub.
IpFilterRule	The IP filter rules for a provisioning Service.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NameAvailabilityInfo	Description of name availability.
Operation	Represents an operation.
OperationInputs	Input values for operation results call.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
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
PrivateLinkServiceConnectionState	The current state of a private endpoint connection
ProvisioningServiceDescription	The description of the provisioning service.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Description of the shared access key.
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.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
VerificationCodeRequest	The JSON-serialized leaf certificate
VerificationCodeResponse	Description of the response of the verification code.
VerificationCodeResponseProperties	model interface VerificationCodeResponseProperties

Type Aliases

AccessRightsDescription	Rights that this key has. KnownAccessRightsDescription can be used interchangeably with AccessRightsDescription, this enum contains the known values that the service supports. Known values supported by the service ServiceConfig EnrollmentRead EnrollmentWrite DeviceConnect RegistrationStatusRead RegistrationStatusWrite
AllocationPolicy	Allocation policy to be used by this provisioning service. KnownAllocationPolicy can be used interchangeably with AllocationPolicy, this enum contains the known values that the service supports. Known values supported by the service Hashed GeoLatency Static
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CertificatePurpose	Type of CertificatePurpose
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DeviceRegistryNamespaceAuthenticationType	Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned. KnownDeviceRegistryNamespaceAuthenticationType can be used interchangeably with DeviceRegistryNamespaceAuthenticationType, this enum contains the known values that the service supports. Known values supported by the service UserAssigned: User assigned authentication type. SystemAssigned: System assigned authentication type.
IotDpsSku	Sku name. KnownIotDpsSku can be used interchangeably with IotDpsSku, this enum contains the known values that the service supports. Known values supported by the service S1
IpFilterActionType	The desired action for requests captured by this rule.
IpFilterTargetType	Target for requests captured by this rule.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
NameUnavailabilityReason	specifies the reason a name is unavailable KnownNameUnavailabilityReason can be used interchangeably with NameUnavailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
PrivateLinkServiceConnectionStatus	The status of a private endpoint connection KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
PublicNetworkAccess	Whether requests from Public Network are allowed KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
State	Current state of the provisioning service. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Activating Active Deleting Deleted ActivationFailed DeletionFailed Transitioning Suspending Suspended Resuming FailingOver FailoverFailed

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessRightsDescription	Rights that this key has.
KnownAllocationPolicy	Allocation policy to be used by this provisioning service.
KnownCertificatePurpose	Known values of CertificatePurpose that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeviceRegistryNamespaceAuthenticationType	Device Registry Namespace MI authentication type: UserAssigned, SystemAssigned.
KnownIotDpsSku	Sku name.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownNameUnavailabilityReason	specifies the reason a name is unavailable
KnownPrivateLinkServiceConnectionStatus	The status of a private endpoint connection
KnownPublicNetworkAccess	Whether requests from Public Network are allowed
KnownState	Current state of the provisioning service.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: IotDpsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: IotDpsClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

@azure/arm-deviceprovisioningservices package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Feedback