你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-deviceprovisioningservices package

IotDpsClient

接口

AsyncOperationResult

长时间运行的作的结果。

CertificateBodyDescription

JSON 序列化的 X509 证书。

CertificateListDescription

证书对象的 JSON 序列化数组。

CertificateProperties

X509 CA 证书的说明。

CertificateResponse

X509 证书。

DpsCertificate

表示 DpsCertificate 的接口。

DpsCertificateCreateOrUpdateOptionalParams

可选参数。

DpsCertificateDeleteOptionalParams

可选参数。

DpsCertificateGenerateVerificationCodeOptionalParams

可选参数。

DpsCertificateGetOptionalParams

可选参数。

DpsCertificateListOptionalParams

可选参数。

DpsCertificateVerifyCertificateOptionalParams

可选参数。

ErrorDetails

错误详细信息。

ErrorMessage

包含消息和代码的错误响应。

GroupIdInformation

用于在预配服务上创建专用终结点的组信息

GroupIdInformationProperties

组信息对象的属性

IotDpsClientOptionalParams

可选参数。

IotDpsPropertiesDescription

预配服务的服务特定属性,包括密钥、链接的 iot 中心、当前状态和系统生成的属性,例如主机名和 idScope

IotDpsResource

表示 IotDpsResource 的接口。

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

可选参数。

IotDpsResourceCreateOrUpdateOptionalParams

可选参数。

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

可选参数。

IotDpsResourceDeleteOptionalParams

可选参数。

IotDpsResourceDeletePrivateEndpointConnectionHeaders

定义IotDpsResource_deletePrivateEndpointConnection作的标头。

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

可选参数。

IotDpsResourceGetOperationResultOptionalParams

可选参数。

IotDpsResourceGetOptionalParams

可选参数。

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

可选参数。

IotDpsResourceGetPrivateLinkResourcesOptionalParams

可选参数。

IotDpsResourceListByResourceGroupNextOptionalParams

可选参数。

IotDpsResourceListByResourceGroupOptionalParams

可选参数。

IotDpsResourceListBySubscriptionNextOptionalParams

可选参数。

IotDpsResourceListBySubscriptionOptionalParams

可选参数。

IotDpsResourceListKeysForKeyNameOptionalParams

可选参数。

IotDpsResourceListKeysNextOptionalParams

可选参数。

IotDpsResourceListKeysOptionalParams

可选参数。

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

可选参数。

IotDpsResourceListPrivateLinkResourcesOptionalParams

可选参数。

IotDpsResourceListValidSkusNextOptionalParams

可选参数。

IotDpsResourceListValidSkusOptionalParams

可选参数。

IotDpsResourceUpdateOptionalParams

可选参数。

IotDpsSkuDefinition

层和单位的可用 SKU。

IotDpsSkuDefinitionListResult

可用 SKU 列表。

IotDpsSkuInfo

可能的预配服务 SKU 列表。

IotHubDefinitionDescription

IoT 中心的说明。

IpFilterRule

预配服务的 IP 筛选器规则。

NameAvailabilityInfo

名称可用性的说明。

Operation

预配服务 REST API作。

OperationDisplay

表示作的对象。

OperationInputs

作结果调用的输入值。

OperationListResult

列出预配服务作的请求的结果。 它包含作列表和 URL 链接,用于获取下一组结果。

Operations

表示作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

PrivateEndpoint

专用终结点连接的专用终结点属性

PrivateEndpointConnection

预配服务的专用终结点连接

PrivateEndpointConnectionProperties

专用终结点连接的属性

PrivateLinkResources

预配服务的可用专用链接资源

PrivateLinkServiceConnectionState

专用终结点连接的当前状态

ProvisioningServiceDescription

预配服务的说明。

ProvisioningServiceDescriptionListResult

预配服务说明的列表。

Resource

Azure 资源的常见属性。

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

共享访问密钥的说明。

SharedAccessSignatureAuthorizationRuleListResult

共享访问密钥列表。

SystemData

与创建和上次修改资源相关的元数据。

TagsResource

只保存资源的标记的容器,允许用户更新预配服务实例上的标记。

VerificationCodeRequest

JSON 序列化的叶证书

VerificationCodeResponse

验证码响应的说明。

VerificationCodeResponseProperties

类型别名

AccessRightsDescription

定义 AccessRightsDescription 的值。
KnownAccessRightsDescription 可与 AccessRightsDescription 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

定义 AllocationPolicy 的值。
KnownAllocationPolicy 可与 AllocationPolicy 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

哈希处理
GeoLatency
静态

CertificatePurpose

定义 CertificatePurpose 的值。
KnownCertificatePurpose 可与 CertificatePurpose 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

clientAuthentication
serverAuthentication

CreatedByType

定义 CreatedByType 的值。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
应用程序
ManagedIdentity
密钥

DpsCertificateCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

DpsCertificateGenerateVerificationCodeResponse

包含 generateVerificationCode作的响应数据。

DpsCertificateGetResponse

包含获取作的响应数据。

DpsCertificateListResponse

包含列表作的响应数据。

DpsCertificateVerifyCertificateResponse

包含 verifyCertificate作的响应数据。

IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse

包含 checkProvisioningServiceNameAvailability作的响应数据。

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionResponse

包含 createOrUpdatePrivateEndpointConnection作的响应数据。

IotDpsResourceCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

IotDpsResourceDeletePrivateEndpointConnectionResponse

包含 deletePrivateEndpointConnection作的响应数据。

IotDpsResourceGetOperationResultResponse

包含 getOperationResult作的响应数据。

IotDpsResourceGetPrivateEndpointConnectionResponse

包含 getPrivateEndpointConnection作的响应数据。

IotDpsResourceGetPrivateLinkResourcesResponse

包含 getPrivateLinkResources作的响应数据。

IotDpsResourceGetResponse

包含获取作的响应数据。

IotDpsResourceListByResourceGroupNextResponse

包含 listByResourceGroupNext作的响应数据。

IotDpsResourceListByResourceGroupResponse

包含 listByResourceGroup作的响应数据。

IotDpsResourceListBySubscriptionNextResponse

包含 listBySubscriptionNext作的响应数据。

IotDpsResourceListBySubscriptionResponse

包含 listBySubscription作的响应数据。

IotDpsResourceListKeysForKeyNameResponse

包含 listKeysForKeyName作的响应数据。

IotDpsResourceListKeysNextResponse

包含 listKeysNext作的响应数据。

IotDpsResourceListKeysResponse

包含 listKeys作的响应数据。

IotDpsResourceListPrivateEndpointConnectionsResponse

包含 listPrivateEndpointConnections作的响应数据。

IotDpsResourceListPrivateLinkResourcesResponse

包含 listPrivateLinkResources作的响应数据。

IotDpsResourceListValidSkusNextResponse

包含 listValidSkusNext作的响应数据。

IotDpsResourceListValidSkusResponse

包含 listValidSkus作的响应数据。

IotDpsResourceUpdateResponse

包含更新作的响应数据。

IotDpsSku

定义 IotDpsSku 的值。
KnownIotDpsSku 可与 IotDpsSku 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

S1

IpFilterActionType

定义 IpFilterActionType 的值。

IpFilterTargetType

定义 IpFilterTargetType 的值。

NameUnavailabilityReason

定义 NameUnavailabilityReason 的值。
KnownNameUnavailabilityReason 可与 NameUnavailabilityReason 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效的
AlreadyExists

OperationsListNextResponse

包含 listNext作的响应数据。

OperationsListResponse

包含列表作的响应数据。

PrivateLinkServiceConnectionStatus

定义 PrivateLinkServiceConnectionStatus 的值。
KnownPrivateLinkServiceConnectionStatus 可与 PrivateLinkServiceConnectionStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

挂起的
已批准
拒绝
断开连接的

PublicNetworkAccess

定义 PublicNetworkAccess 的值。
KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已启用
禁用

State

定义 State 的值。
KnownState 可与 State 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

激活
活动
删除
已删除
ActivationFailed
DeletionFailed
转换
暂停
暂停
恢复
故障转移
FailoverFailed

枚举

KnownAccessRightsDescription

服务接受的 AccessRightsDescription 的已知值。

KnownAllocationPolicy

服务的 AllocationPolicy 的已知值。

KnownCertificatePurpose

服务接受的 CertificatePurpose 的已知值。

KnownCreatedByType

服务的 CreatedByType 的已知值

KnownIotDpsSku

服务接受的 IotDpsSku 的已知值。

KnownNameUnavailabilityReason

NameUnavailabilityReason 服务的已知值。

KnownPrivateLinkServiceConnectionStatus

PrivateLinkServiceConnectionStatus 服务的已知值。

KnownPublicNetworkAccess

PublicNetworkAccess 服务的已知值。

KnownState

服务接受的 状态 的已知值。

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。