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

@azure/arm-planetarycomputer package

SpatioClient

接口

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。

GeoCatalog

Microsoft Planetary Computer Pro GeoCatalog 资源

GeoCatalogProperties

Microsoft Planetary Computer Pro GeoCatalog 的详细信息。

GeoCatalogUpdate

可更新的 GeoCatalog 的属性。

GeoCatalogsCreateOptionalParams

可选参数。

GeoCatalogsDeleteOptionalParams

可选参数。

GeoCatalogsGetOptionalParams

可选参数。

GeoCatalogsListByResourceGroupOptionalParams

可选参数。

GeoCatalogsListBySubscriptionOptionalParams

可选参数。

GeoCatalogsOperations

表示 GeoCatalogs作的接口。

GeoCatalogsUpdateOptionalParams

可选参数。

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

ManagedServiceIdentityUpdate

用于添加可选属性的模板。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RestorePollerOptions
SpatioClientOptionalParams

客户端的可选参数。

SystemData

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

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UserAssignedIdentity

用户分配的标识属性

类型别名

AutoGeneratedDomainNameLabelScope

自动生成域名标签的生成范围,以及资源名称可以复用的范围。
KnownAutoGeneratedDomainNameLabelScope 可与 AutoGeneratedDomainNameLabelScope 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

NoReuse:域名标签是随机生成的。 资源名称不能在同一区域内重复使用。
TenantReuse:域名标签是使用资源名称和租户 ID 确定生成的。资源名称不能在同一区域和租户中重复使用。
SubscriptionReuse:域名标签是使用资源名称、租户 ID 和订阅 ID 确定生成的。资源名称不能在同一区域和订阅中重复使用。
ResourceGroupReuse:域名标签是使用资源名称、租户 ID、订阅 ID 和资源组名称确定生成的。 资源名称不能在同一资源组中重复使用。

CatalogTier

Microsoft Planetary Computer Pro GeoCatalog 层
KnownCatalogTier 可与 CatalogTier 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Basic:跨目录实例利用共享资源的基本层

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
<xref:KnowncreatedByType> 可与 createdByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。
KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:无托管标识。
SystemAssigned:系统分配的托管标识。
UserAssigned:用户分配的托管标识。
SystemAssigned、UserAssigned:系统和用户分配的托管标识。

ProvisioningState

当前作的状态。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。
Provisioning:正在预置目录。
正在更新:正在更新目录。
Deleting:正在删除目录。
Accepted:已接受目录请求。

枚举

KnownAutoGeneratedDomainNameLabelScope

自动生成域名标签的生成范围,以及资源名称可以复用的范围。

KnownCatalogTier

Microsoft Planetary Computer Pro GeoCatalog 层

KnownCreatedByType

创建资源的实体类型。

KnownManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

KnownProvisioningState

当前作的状态。

KnownVersions

服务的已知 KnownVersions 值。

函数

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

函数详细信息

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

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

参数

client
SpatioClient
serializedState

string

sourceOperation

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

返回

PollerLike<OperationState<TResult>, TResult>