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

@azure/arm-resources package

ResourceManagementClient

接口

Alias

别名类型。

AliasPath

别名的路径的类型。

AliasPathMetadata
AliasPattern

别名路径的模式类型。

ApiProfile
BasicDependency

部署依赖项信息。

CloudError

资源管理请求的错误响应。

DebugSetting

调试设置。

Dependency

部署依赖项信息。

Deployment

部署作参数。

DeploymentExportResult

部署导出结果。

DeploymentExtended

部署信息。

DeploymentExtendedFilter

部署筛选器。

DeploymentListResult

部署列表。

DeploymentOperation

部署作信息。

DeploymentOperationProperties

部署作属性。

DeploymentOperations

表示 DeploymentOperations 的接口。

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

可选参数。

DeploymentOperationsGetAtScopeOptionalParams

可选参数。

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

可选参数。

DeploymentOperationsGetAtTenantScopeOptionalParams

可选参数。

DeploymentOperationsGetOptionalParams

可选参数。

DeploymentOperationsListAtManagementGroupScopeNextOptionalParams

可选参数。

DeploymentOperationsListAtManagementGroupScopeOptionalParams

可选参数。

DeploymentOperationsListAtScopeNextOptionalParams

可选参数。

DeploymentOperationsListAtScopeOptionalParams

可选参数。

DeploymentOperationsListAtSubscriptionScopeNextOptionalParams

可选参数。

DeploymentOperationsListAtSubscriptionScopeOptionalParams

可选参数。

DeploymentOperationsListAtTenantScopeNextOptionalParams

可选参数。

DeploymentOperationsListAtTenantScopeOptionalParams

可选参数。

DeploymentOperationsListNextOptionalParams

可选参数。

DeploymentOperationsListOptionalParams

可选参数。

DeploymentOperationsListResult

部署作列表。

DeploymentProperties

部署属性。

DeploymentPropertiesExtended

具有更多详细信息的部署属性。

DeploymentValidateResult

来自验证模板部署响应的信息。

DeploymentWhatIf

部署 What-if作参数。

DeploymentWhatIfProperties

部署 What-if 属性。

DeploymentWhatIfSettings

部署 What-If作设置。

Deployments

表示部署的接口。

DeploymentsCalculateTemplateHashOptionalParams

可选参数。

DeploymentsCancelAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsCancelAtScopeOptionalParams

可选参数。

DeploymentsCancelAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsCancelAtTenantScopeOptionalParams

可选参数。

DeploymentsCancelOptionalParams

可选参数。

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsCheckExistenceAtScopeOptionalParams

可选参数。

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsCheckExistenceAtTenantScopeOptionalParams

可选参数。

DeploymentsCheckExistenceOptionalParams

可选参数。

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsCreateOrUpdateAtScopeOptionalParams

可选参数。

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

可选参数。

DeploymentsCreateOrUpdateOptionalParams

可选参数。

DeploymentsDeleteAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsDeleteAtScopeOptionalParams

可选参数。

DeploymentsDeleteAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsDeleteAtTenantScopeOptionalParams

可选参数。

DeploymentsDeleteOptionalParams

可选参数。

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsExportTemplateAtScopeOptionalParams

可选参数。

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsExportTemplateAtTenantScopeOptionalParams

可选参数。

DeploymentsExportTemplateOptionalParams

可选参数。

DeploymentsGetAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsGetAtScopeOptionalParams

可选参数。

DeploymentsGetAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsGetAtTenantScopeOptionalParams

可选参数。

DeploymentsGetOptionalParams

可选参数。

DeploymentsListAtManagementGroupScopeNextOptionalParams

可选参数。

DeploymentsListAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsListAtScopeNextOptionalParams

可选参数。

DeploymentsListAtScopeOptionalParams

可选参数。

DeploymentsListAtSubscriptionScopeNextOptionalParams

可选参数。

DeploymentsListAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsListAtTenantScopeNextOptionalParams

可选参数。

DeploymentsListAtTenantScopeOptionalParams

可选参数。

DeploymentsListByResourceGroupNextOptionalParams

可选参数。

DeploymentsListByResourceGroupOptionalParams

可选参数。

DeploymentsValidateAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsValidateAtScopeOptionalParams

可选参数。

DeploymentsValidateAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsValidateAtTenantScopeOptionalParams

可选参数。

DeploymentsValidateOptionalParams

可选参数。

DeploymentsWhatIfAtManagementGroupScopeHeaders

定义Deployments_whatIfAtManagementGroupScope作的标头。

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

可选参数。

DeploymentsWhatIfAtSubscriptionScopeHeaders

定义Deployments_whatIfAtSubscriptionScope作的标头。

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

可选参数。

DeploymentsWhatIfAtTenantScopeHeaders

定义Deployments_whatIfAtTenantScope作的标头。

DeploymentsWhatIfAtTenantScopeOptionalParams

可选参数。

DeploymentsWhatIfHeaders

定义Deployments_whatIf作的标头。

DeploymentsWhatIfOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。 (这也遵循 OData 错误响应格式。)

ExportTemplateRequest

导出资源组模板请求参数。

ExpressionEvaluationOptions

指定模板表达式是在父模板或嵌套模板的范围内计算的。

ExtendedLocation

资源扩展位置。

GenericResource

资源信息。

GenericResourceExpanded

资源信息。

GenericResourceFilter

资源筛选器。

HttpMessage

HTTP 消息。

Identity

资源的标识。

IdentityUserAssignedIdentitiesValue
OnErrorDeployment

针对错误行为进行部署。

OnErrorDeploymentExtended

有关错误行为的部署,并提供了其他详细信息。

Operation

Microsoft.Resources作

OperationDisplay

表示作的对象。

OperationListResult

列出 Microsoft.Resources作的请求的结果。 它包含作列表和 URL 链接,用于获取下一组结果。

Operations

表示作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

ParametersLink

表示对部署参数的引用的实体。

Permission

角色定义权限。

Plan

规划资源。

Provider

资源提供程序信息。

ProviderConsentDefinition

提供程序同意。

ProviderExtendedLocation

提供程序扩展位置。

ProviderListResult

资源提供程序列表。

ProviderPermission

提供程序权限

ProviderPermissionListResult

提供程序权限列表。

ProviderRegistrationRequest

提供程序注册定义。

ProviderResourceType

资源提供程序管理的资源类型。

ProviderResourceTypeListResult

资源提供程序的资源类型列表。

ProviderResourceTypes

表示 ProviderResourceTypes 的接口。

ProviderResourceTypesListOptionalParams

可选参数。

Providers

表示提供程序的接口。

ProvidersGetAtTenantScopeOptionalParams

可选参数。

ProvidersGetOptionalParams

可选参数。

ProvidersListAtTenantScopeNextOptionalParams

可选参数。

ProvidersListAtTenantScopeOptionalParams

可选参数。

ProvidersListNextOptionalParams

可选参数。

ProvidersListOptionalParams

可选参数。

ProvidersProviderPermissionsOptionalParams

可选参数。

ProvidersRegisterAtManagementGroupScopeOptionalParams

可选参数。

ProvidersRegisterOptionalParams

可选参数。

ProvidersUnregisterOptionalParams

可选参数。

Resource

指定的资源。

ResourceGroup

资源组信息。

ResourceGroupExportResult

资源组导出结果。

ResourceGroupFilter

资源组筛选器。

ResourceGroupListResult

资源组列表。

ResourceGroupPatchable

资源组信息。

ResourceGroupProperties

资源组属性。

ResourceGroups

表示 ResourceGroups 的接口。

ResourceGroupsCheckExistenceOptionalParams

可选参数。

ResourceGroupsCreateOrUpdateOptionalParams

可选参数。

ResourceGroupsDeleteOptionalParams

可选参数。

ResourceGroupsExportTemplateOptionalParams

可选参数。

ResourceGroupsGetOptionalParams

可选参数。

ResourceGroupsListNextOptionalParams

可选参数。

ResourceGroupsListOptionalParams

可选参数。

ResourceGroupsUpdateOptionalParams

可选参数。

ResourceListResult

资源组列表。

ResourceManagementClientOptionalParams

可选参数。

ResourceProviderOperationDisplayProperties

资源提供程序作的显示属性。

ResourceReference

资源 ID 模型。

Resources

表示资源的接口。

ResourcesCheckExistenceByIdOptionalParams

可选参数。

ResourcesCheckExistenceOptionalParams

可选参数。

ResourcesCreateOrUpdateByIdOptionalParams

可选参数。

ResourcesCreateOrUpdateOptionalParams

可选参数。

ResourcesDeleteByIdOptionalParams

可选参数。

ResourcesDeleteOptionalParams

可选参数。

ResourcesGetByIdOptionalParams

可选参数。

ResourcesGetOptionalParams

可选参数。

ResourcesListByResourceGroupNextOptionalParams

可选参数。

ResourcesListByResourceGroupOptionalParams

可选参数。

ResourcesListNextOptionalParams

可选参数。

ResourcesListOptionalParams

可选参数。

ResourcesMoveInfo

移动资源的参数。

ResourcesMoveResourcesOptionalParams

可选参数。

ResourcesUpdateByIdOptionalParams

可选参数。

ResourcesUpdateOptionalParams

可选参数。

ResourcesValidateMoveResourcesOptionalParams

可选参数。

RoleDefinition

角色定义属性。

ScopedDeployment

部署作参数。

ScopedDeploymentWhatIf

部署 What-if作参数。

Sku

资源的 SKU。

StatusMessage

作状态消息对象。

SubResource

子资源。

TagCount

标记计数。

TagDetails

标记详细信息。

TagValue

标记信息。

Tags

名称和值对的字典。

TagsCreateOrUpdateAtScopeOptionalParams

可选参数。

TagsCreateOrUpdateOptionalParams

可选参数。

TagsCreateOrUpdateValueOptionalParams

可选参数。

TagsDeleteAtScopeOptionalParams

可选参数。

TagsDeleteOptionalParams

可选参数。

TagsDeleteValueOptionalParams

可选参数。

TagsGetAtScopeOptionalParams

可选参数。

TagsListNextOptionalParams

可选参数。

TagsListOptionalParams

可选参数。

TagsListResult

订阅标记列表。

TagsOperations

表示 TagsOperations 的接口。

TagsPatchResource

仅标记修补 API 请求的包装器资源。

TagsResource

标记 API 请求和响应的包装器资源。

TagsUpdateAtScopeOptionalParams

可选参数。

TargetResource

目标资源。

TemplateHashResult

计算模板哈希的请求的结果。 它包含一个缩小模板及其哈希字符串。

TemplateLink

表示对模板的引用的实体。

WhatIfChange

有关 What-If作预测的单个资源更改的信息。

WhatIfOperationResult

What-If作的结果。 包含预测的更改列表和 URL 链接,用于获取下一组结果。

WhatIfPropertyChange

对资源属性的预测更改。

ZoneMapping

类型别名

AliasPathAttributes

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

服务支持的已知值

None:别名路径引用的标记没有属性。
可修改:别名路径引用的标记可由具有“modify”效果的策略修改。

AliasPathTokenType

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

服务支持的已知值

NotSpecified:未指定标记类型。
任何:令牌类型可以是任何内容。
字符串:标记类型为字符串。
对象:标记类型为对象。
数组:标记类型为数组。
整数:标记类型为整数。
数字:标记类型为 number。
布尔:标记类型为布尔值。

AliasPatternType

定义 AliasPatternType 的值。

AliasType

定义 AliasType 的值。

ChangeType

定义 ChangeType 的值。

DeploymentMode

定义 DeploymentMode 的值。

DeploymentOperationsGetAtManagementGroupScopeResponse

包含 getAtManagementGroupScope作的响应数据。

DeploymentOperationsGetAtScopeResponse

包含 getAtScope作的响应数据。

DeploymentOperationsGetAtSubscriptionScopeResponse

包含 getAtSubscriptionScope作的响应数据。

DeploymentOperationsGetAtTenantScopeResponse

包含 getAtTenantScope作的响应数据。

DeploymentOperationsGetResponse

包含获取作的响应数据。

DeploymentOperationsListAtManagementGroupScopeNextResponse

包含 listAtManagementGroupScopeNext作的响应数据。

DeploymentOperationsListAtManagementGroupScopeResponse

包含 listAtManagementGroupScope作的响应数据。

DeploymentOperationsListAtScopeNextResponse

包含 listAtScopeNext作的响应数据。

DeploymentOperationsListAtScopeResponse

包含 listAtScope作的响应数据。

DeploymentOperationsListAtSubscriptionScopeNextResponse

包含 listAtSubscriptionScopeNext作的响应数据。

DeploymentOperationsListAtSubscriptionScopeResponse

包含 listAtSubscriptionScope作的响应数据。

DeploymentOperationsListAtTenantScopeNextResponse

包含 listAtTenantScopeNext作的响应数据。

DeploymentOperationsListAtTenantScopeResponse

包含 listAtTenantScope作的响应数据。

DeploymentOperationsListNextResponse

包含 listNext作的响应数据。

DeploymentOperationsListResponse

包含列表作的响应数据。

DeploymentsCalculateTemplateHashResponse

包含 calculateTemplateHash作的响应数据。

DeploymentsCheckExistenceAtManagementGroupScopeResponse

包含 checkExistenceAtManagementGroupScope作的响应数据。

DeploymentsCheckExistenceAtScopeResponse

包含 checkExistenceAtScope作的响应数据。

DeploymentsCheckExistenceAtSubscriptionScopeResponse

包含 checkExistenceAtSubscriptionScope作的响应数据。

DeploymentsCheckExistenceAtTenantScopeResponse

包含 checkExistenceAtTenantScope作的响应数据。

DeploymentsCheckExistenceResponse

包含 checkExistence作的响应数据。

DeploymentsCreateOrUpdateAtManagementGroupScopeResponse

包含 createOrUpdateAtManagementGroupScope作的响应数据。

DeploymentsCreateOrUpdateAtScopeResponse

包含 createOrUpdateAtScope作的响应数据。

DeploymentsCreateOrUpdateAtSubscriptionScopeResponse

包含 createOrUpdateAtSubscriptionScope作的响应数据。

DeploymentsCreateOrUpdateAtTenantScopeResponse

包含 createOrUpdateAtTenantScope作的响应数据。

DeploymentsCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

DeploymentsExportTemplateAtManagementGroupScopeResponse

包含 exportTemplateAtManagementGroupScope作的响应数据。

DeploymentsExportTemplateAtScopeResponse

包含 exportTemplateAtScope作的响应数据。

DeploymentsExportTemplateAtSubscriptionScopeResponse

包含 exportTemplateAtSubscriptionScope作的响应数据。

DeploymentsExportTemplateAtTenantScopeResponse

包含 exportTemplateAtTenantScope作的响应数据。

DeploymentsExportTemplateResponse

包含 exportTemplate作的响应数据。

DeploymentsGetAtManagementGroupScopeResponse

包含 getAtManagementGroupScope作的响应数据。

DeploymentsGetAtScopeResponse

包含 getAtScope作的响应数据。

DeploymentsGetAtSubscriptionScopeResponse

包含 getAtSubscriptionScope作的响应数据。

DeploymentsGetAtTenantScopeResponse

包含 getAtTenantScope作的响应数据。

DeploymentsGetResponse

包含获取作的响应数据。

DeploymentsListAtManagementGroupScopeNextResponse

包含 listAtManagementGroupScopeNext作的响应数据。

DeploymentsListAtManagementGroupScopeResponse

包含 listAtManagementGroupScope作的响应数据。

DeploymentsListAtScopeNextResponse

包含 listAtScopeNext作的响应数据。

DeploymentsListAtScopeResponse

包含 listAtScope作的响应数据。

DeploymentsListAtSubscriptionScopeNextResponse

包含 listAtSubscriptionScopeNext作的响应数据。

DeploymentsListAtSubscriptionScopeResponse

包含 listAtSubscriptionScope作的响应数据。

DeploymentsListAtTenantScopeNextResponse

包含 listAtTenantScopeNext作的响应数据。

DeploymentsListAtTenantScopeResponse

包含 listAtTenantScope作的响应数据。

DeploymentsListByResourceGroupNextResponse

包含 listByResourceGroupNext作的响应数据。

DeploymentsListByResourceGroupResponse

包含 listByResourceGroup作的响应数据。

DeploymentsValidateAtManagementGroupScopeResponse

包含 validateAtManagementGroupScope作的响应数据。

DeploymentsValidateAtScopeResponse

包含 validateAtScope作的响应数据。

DeploymentsValidateAtSubscriptionScopeResponse

包含 validateAtSubscriptionScope作的响应数据。

DeploymentsValidateAtTenantScopeResponse

包含 validateAtTenantScope作的响应数据。

DeploymentsValidateResponse

包含验证作的响应数据。

DeploymentsWhatIfAtManagementGroupScopeResponse

包含 whatIfAtManagementGroupScope作的响应数据。

DeploymentsWhatIfAtSubscriptionScopeResponse

包含 whatIfAtSubscriptionScope作的响应数据。

DeploymentsWhatIfAtTenantScopeResponse

包含 whatIfAtTenantScope作的响应数据。

DeploymentsWhatIfResponse

包含 whatIf作的响应数据。

ExpressionEvaluationOptionsScopeType

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

服务支持的已知值

NotSpecified
外部
内部

ExtendedLocationType

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

服务支持的已知值

EdgeZone

OnErrorDeploymentType

定义 OnErrorDeploymentType 的值。

OperationsListNextResponse

包含 listNext作的响应数据。

OperationsListResponse

包含列表作的响应数据。

PropertyChangeType

定义 PropertyChangeType 的值。

ProviderAuthorizationConsentState

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

服务支持的已知值

NotSpecified
必需
NotRequired
同意

ProviderResourceTypesListResponse

包含列表作的响应数据。

ProvidersGetAtTenantScopeResponse

包含 getAtTenantScope作的响应数据。

ProvidersGetResponse

包含获取作的响应数据。

ProvidersListAtTenantScopeNextResponse

包含 listAtTenantScopeNext作的响应数据。

ProvidersListAtTenantScopeResponse

包含 listAtTenantScope作的响应数据。

ProvidersListNextResponse

包含 listNext作的响应数据。

ProvidersListResponse

包含列表作的响应数据。

ProvidersProviderPermissionsResponse

包含 providerPermissions作的响应数据。

ProvidersRegisterResponse

包含注册作的响应数据。

ProvidersUnregisterResponse

包含注销作的响应数据。

ProvisioningOperation

定义 ProvisioningOperation 的值。

ProvisioningState

定义 ProvisioningState 的值。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

NotSpecified
已接受
运行
就绪
创建
已创建
删除
已删除
已取消
失败
已成功
更新

ResourceGroupsCheckExistenceResponse

包含 checkExistence作的响应数据。

ResourceGroupsCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

ResourceGroupsExportTemplateResponse

包含 exportTemplate作的响应数据。

ResourceGroupsGetResponse

包含获取作的响应数据。

ResourceGroupsListNextResponse

包含 listNext作的响应数据。

ResourceGroupsListResponse

包含列表作的响应数据。

ResourceGroupsUpdateResponse

包含更新作的响应数据。

ResourceIdentityType

定义 ResourceIdentityType 的值。

ResourcesCheckExistenceByIdResponse

包含 checkExistenceById作的响应数据。

ResourcesCheckExistenceResponse

包含 checkExistence作的响应数据。

ResourcesCreateOrUpdateByIdResponse

包含 createOrUpdateById作的响应数据。

ResourcesCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

ResourcesGetByIdResponse

包含 getById作的响应数据。

ResourcesGetResponse

包含获取作的响应数据。

ResourcesListByResourceGroupNextResponse

包含 listByResourceGroupNext作的响应数据。

ResourcesListByResourceGroupResponse

包含 listByResourceGroup作的响应数据。

ResourcesListNextResponse

包含 listNext作的响应数据。

ResourcesListResponse

包含列表作的响应数据。

ResourcesUpdateByIdResponse

包含 updateById作的响应数据。

ResourcesUpdateResponse

包含更新作的响应数据。

TagsCreateOrUpdateAtScopeResponse

包含 createOrUpdateAtScope作的响应数据。

TagsCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

TagsCreateOrUpdateValueResponse

包含 createOrUpdateValue作的响应数据。

TagsGetAtScopeResponse

包含 getAtScope作的响应数据。

TagsListNextResponse

包含 listNext作的响应数据。

TagsListResponse

包含列表作的响应数据。

TagsPatchOperation

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

服务支持的已知值

替换:“替换”选项将整个现有标记集替换为新集。
合并:“合并”选项允许添加新名称的标记,并使用现有名称更新标记的值。
删除:“删除”选项允许根据给定的名称或名称/值对选择性地删除标记。

TagsUpdateAtScopeResponse

包含 updateAtScope作的响应数据。

WhatIfResultFormat

定义 WhatIfResultFormat 的值。

枚举

KnownAliasPathAttributes

AliasPathAttributes 服务的已知值。

KnownAliasPathTokenType

AliasPathTokenType 服务的已知值。

KnownExpressionEvaluationOptionsScopeType

ExpressionEvaluationOptionsScopeType 服务的已知值。

KnownExtendedLocationType

ExtendedLocationType 服务的已知值。

KnownProviderAuthorizationConsentState

ProviderAuthorizationConsentState 服务的已知值。

KnownProvisioningState

服务的 ProvisioningState 的已知值。

KnownTagsPatchOperation

服务的 TagsPatchOperation 的已知值。

函数

getContinuationToken(unknown)

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

函数详细信息

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

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

返回

string | undefined

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