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

@azure/arm-apicenter package

类

AzureAPICenter

接口

Api	API 实体。
ApiDefinition	API 定义实体。
ApiDefinitionListResult	ApiDefinition 列表操作的响应。
ApiDefinitionProperties	API 定义属性实体。
ApiDefinitionPropertiesSpecification	API 规范详细信息。
ApiDefinitions	表示 ApiDefinitions 的接口。
ApiDefinitionsCreateOrUpdateHeaders	定义ApiDefinitions_createOrUpdate操作的标头。
ApiDefinitionsCreateOrUpdateOptionalParams	可选参数。
ApiDefinitionsDeleteOptionalParams	可选参数。
ApiDefinitionsExportSpecificationHeaders	定义ApiDefinitions_exportSpecification操作的标头。
ApiDefinitionsExportSpecificationOptionalParams	可选参数。
ApiDefinitionsGetHeaders	定义ApiDefinitions_get操作的标头。
ApiDefinitionsGetOptionalParams	可选参数。
ApiDefinitionsHeadOptionalParams	可选参数。
ApiDefinitionsImportSpecificationHeaders	定义ApiDefinitions_importSpecification操作的标头。
ApiDefinitionsImportSpecificationOptionalParams	可选参数。
ApiDefinitionsListNextOptionalParams	可选参数。
ApiDefinitionsListOptionalParams	可选参数。
ApiListResult	API 列表操作的响应。
ApiProperties	API 属性。
ApiSpecExportResult	API 规范导出结果。
ApiSpecImportRequest	API 规范源实体属性。
ApiSpecImportRequestSpecification	API 规范详细信息。
ApiVersion	API 版本实体。
ApiVersionListResult	ApiVersion 列表操作的响应。
ApiVersionProperties	API 版本属性实体。
ApiVersions	表示 ApiVersions 的接口。
ApiVersionsCreateOrUpdateHeaders	定义ApiVersions_createOrUpdate操作的标头。
ApiVersionsCreateOrUpdateOptionalParams	可选参数。
ApiVersionsDeleteOptionalParams	可选参数。
ApiVersionsGetHeaders	定义ApiVersions_get操作的标头。
ApiVersionsGetOptionalParams	可选参数。
ApiVersionsHeadOptionalParams	可选参数。
ApiVersionsListNextOptionalParams	可选参数。
ApiVersionsListOptionalParams	可选参数。
Apis	表示 API 的接口。
ApisCreateOrUpdateHeaders	定义Apis_createOrUpdate操作的标头。
ApisCreateOrUpdateOptionalParams	可选参数。
ApisDeleteOptionalParams	可选参数。
ApisGetHeaders	定义Apis_get操作的标头。
ApisGetOptionalParams	可选参数。
ApisHeadOptionalParams	可选参数。
ApisListNextOptionalParams	可选参数。
ApisListOptionalParams	可选参数。
AzureAPICenterOptionalParams	可选参数。
Contact	联系信息
Deployment	API 部署实体。
DeploymentListResult	部署列表操作的响应。
DeploymentProperties	API 部署实体属性。
DeploymentServer	服务器
Deployments	表示部署的接口。
DeploymentsCreateOrUpdateHeaders	定义Deployments_createOrUpdate操作的标头。
DeploymentsCreateOrUpdateOptionalParams	可选参数。
DeploymentsDeleteOptionalParams	可选参数。
DeploymentsGetHeaders	定义Deployments_get操作的标头。
DeploymentsGetOptionalParams	可选参数。
DeploymentsHeadOptionalParams	可选参数。
DeploymentsListNextOptionalParams	可选参数。
DeploymentsListOptionalParams	可选参数。
Environment	环境实体。
EnvironmentListResult	环境列表操作的响应。
EnvironmentProperties	环境属性实体。
EnvironmentServer	环境的服务器信息。
Environments	表示环境的接口。
EnvironmentsCreateOrUpdateHeaders	定义Environments_createOrUpdate操作的标头。
EnvironmentsCreateOrUpdateOptionalParams	可选参数。
EnvironmentsDeleteOptionalParams	可选参数。
EnvironmentsGetHeaders	定义Environments_get操作的标头。
EnvironmentsGetOptionalParams	可选参数。
EnvironmentsHeadOptionalParams	可选参数。
EnvironmentsListNextOptionalParams	可选参数。
EnvironmentsListOptionalParams	可选参数。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。
ExternalDocumentation	API 的其他外部文档。
License	API 的许可证信息。
ManagedServiceIdentity	托管服务标识 (系统分配的标识和/或用户分配的标识)
MetadataAssignment	分配元数据
MetadataSchema	元数据架构实体。 用于定义 API 目录中实体的元数据。
MetadataSchemaExportRequest	元数据架构导出请求。
MetadataSchemaExportResult	元数据架构导出结果。
MetadataSchemaListResult	MetadataSchema 列表操作的响应。
MetadataSchemaProperties	元数据架构属性。
MetadataSchemas	表示 MetadataSchemas 的接口。
MetadataSchemasCreateOrUpdateHeaders	定义MetadataSchemas_createOrUpdate操作的标头。
MetadataSchemasCreateOrUpdateOptionalParams	可选参数。
MetadataSchemasDeleteOptionalParams	可选参数。
MetadataSchemasGetHeaders	定义MetadataSchemas_get操作的标头。
MetadataSchemasGetOptionalParams	可选参数。
MetadataSchemasHeadOptionalParams	可选参数。
MetadataSchemasListNextOptionalParams	可选参数。
MetadataSchemasListOptionalParams	可选参数。
Onboarding	载入信息
Operation	从资源提供程序操作 API 返回的 REST API 操作的详细信息
OperationDisplay	此特定操作的本地化显示信息。
OperationListResult	Azure 资源提供程序支持的 REST API 操作的列表。 它包含用于获取下一组结果的 URL 链接。
Operations	表示操作的接口。
OperationsListNextOptionalParams	可选参数。
OperationsListOptionalParams	可选参数。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不会有标记和位置
Resource	所有 Azure 资源管理器 资源的响应中返回的常见字段
Service	服务实体。
ServiceListResult	服务列表操作的响应。
ServiceProperties	服务的属性。
ServiceUpdate	用于服务的更新操作的类型。
Services	表示服务的接口。
ServicesCreateOrUpdateOptionalParams	可选参数。
ServicesDeleteOptionalParams	可选参数。
ServicesExportMetadataSchemaHeaders	定义Services_exportMetadataSchema操作的标头。
ServicesExportMetadataSchemaOptionalParams	可选参数。
ServicesGetOptionalParams	可选参数。
ServicesListByResourceGroupNextOptionalParams	可选参数。
ServicesListByResourceGroupOptionalParams	可选参数。
ServicesListBySubscriptionNextOptionalParams	可选参数。
ServicesListBySubscriptionOptionalParams	可选参数。
ServicesUpdateOptionalParams	可选参数。
SystemData	与资源的创建和上次修改相关的元数据。
TermsOfService	API 的服务条款。
TrackedResource	Azure 的资源模型定义资源管理器跟踪的顶级资源，其中包含“标记”和“位置”
UserAssignedIdentity	用户分配的标识属性
Workspace	工作区实体。
WorkspaceListResult	工作区列表操作的响应。
WorkspaceProperties	工作区属性。
Workspaces	表示工作区的接口。
WorkspacesCreateOrUpdateHeaders	定义Workspaces_createOrUpdate操作的标头。
WorkspacesCreateOrUpdateOptionalParams	可选参数。
WorkspacesDeleteOptionalParams	可选参数。
WorkspacesGetHeaders	定义Workspaces_get操作的标头。
WorkspacesGetOptionalParams	可选参数。
WorkspacesHeadOptionalParams	可选参数。
WorkspacesListNextOptionalParams	可选参数。
WorkspacesListOptionalParams	可选参数。

类型别名

ActionType	定义 ActionType 的值。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 内部
ApiDefinitionsCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
ApiDefinitionsExportSpecificationResponse	包含 exportSpecification 操作的响应数据。
ApiDefinitionsGetResponse	包含获取操作的响应数据。
ApiDefinitionsHeadResponse	包含头操作的响应数据。
ApiDefinitionsListNextResponse	包含 listNext 操作的响应数据。
ApiDefinitionsListResponse	包含列表操作的响应数据。
ApiKind	定义 ApiKind 的值。 KnownApiKind 可与 ApiKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 rest：代表性状态传输 API graphql：图形查询语言 Api grpc：gRPC Api soap：SOAP Api webhook：Web Hook websocket：Web 套接字
ApiSpecExportResultFormat	定义 ApiSpecExportResultFormat 的值。 KnownApiSpecExportResultFormat 可与 ApiSpecExportResultFormat 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 inline：规范文档的内联内容。 link：指向导出操作结果的链接。 URL 的有效期为 5 分钟。
ApiSpecImportSourceFormat	定义 ApiSpecImportSourceFormat 的值。 KnownApiSpecImportSourceFormat 可与 ApiSpecImportSourceFormat 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 inline：规范文档的内联内容。 link：指向托管在可公开访问的 Internet 地址上的规范文档的链接。
ApiVersionsCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
ApiVersionsGetResponse	包含获取操作的响应数据。
ApiVersionsHeadResponse	包含头操作的响应数据。
ApiVersionsListNextResponse	包含 listNext 操作的响应数据。
ApiVersionsListResponse	包含列表操作的响应数据。
ApisCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
ApisGetResponse	包含获取操作的响应数据。
ApisHeadResponse	包含头操作的响应数据。
ApisListNextResponse	包含 listNext 操作的响应数据。
ApisListResponse	包含列表操作的响应数据。
CreatedByType	定义 CreatedByType 的值。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户 应用程序 ManagedIdentity 键
DeploymentState	定义 DeploymentState 的值。 KnownDeploymentState 可与 DeploymentState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 活动：活动状态 非活动状态：非活动状态
DeploymentsCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
DeploymentsGetResponse	包含获取操作的响应数据。
DeploymentsHeadResponse	包含头操作的响应数据。
DeploymentsListNextResponse	包含 listNext 操作的响应数据。
DeploymentsListResponse	包含列表操作的响应数据。
EnvironmentKind	定义 EnvironmentKind 的值。 KnownEnvironmentKind 可与 EnvironmentKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 开发：开发环境 测试：测试环境 staging：暂存环境 生产：生产环境
EnvironmentServerType	定义 EnvironmentServerType 的值。 KnownEnvironmentServerType 可与 EnvironmentServerType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Azure API 管理：Api Management Server Azure 计算服务：计算服务器 Apigee API 管理：Apigee 服务器 AWS API 网关：AWS Api 网关服务器 Kong API 网关：Kong API 网关服务器 Kubernetes：Kubernetes 服务器 MuleSoft API 管理：Mulesoft Api 管理服务器
EnvironmentsCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
EnvironmentsGetResponse	包含获取操作的响应数据。
EnvironmentsHeadResponse	包含头操作的响应数据。
EnvironmentsListNextResponse	包含 listNext 操作的响应数据。
EnvironmentsListResponse	包含列表操作的响应数据。
LifecycleStage	定义 LifecycleStage 的值。 KnownLifecycleStage 可与 LifecycleStage 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 设计：设计阶段 开发：开发阶段 测试：测试阶段 预览版：预览版 生产：在生产中 已弃用：已弃用阶段 已停用：已停用阶段
ManagedServiceIdentityType	定义 ManagedServiceIdentityType 的值。 KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无 SystemAssigned UserAssigned SystemAssigned，UserAssigned
MetadataAssignmentEntity	定义 MetadataAssignmentEntity 的值。 KnownMetadataAssignmentEntity 可与 MetadataAssignmentEntity 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 api：分配给 API 环境：分配给环境 部署：分配给部署
MetadataSchemaExportFormat	定义 MetadataSchemaExportFormat 的值。 KnownMetadataSchemaExportFormat 可与 MetadataSchemaExportFormat 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 inline：架构文档的内联内容。 链接：架构文档的链接。 该 URL 的有效期为 5 分钟。
MetadataSchemasCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
MetadataSchemasGetResponse	包含获取操作的响应数据。
MetadataSchemasHeadResponse	包含头操作的响应数据。
MetadataSchemasListNextResponse	包含 listNext 操作的响应数据。
MetadataSchemasListResponse	包含列表操作的响应数据。
OperationsListNextResponse	包含 listNext 操作的响应数据。
OperationsListResponse	包含列表操作的响应数据。
Origin	定义 Origin 的值。 KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 user 系统 user，system
ProvisioningState	定义 ProvisioningState 的值。 KnownProvisioningState 可与 ProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。
ServicesCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
ServicesExportMetadataSchemaResponse	包含 exportMetadataSchema 操作的响应数据。
ServicesGetResponse	包含获取操作的响应数据。
ServicesListByResourceGroupNextResponse	包含 listByResourceGroupNext 操作的响应数据。
ServicesListByResourceGroupResponse	包含 listByResourceGroup 操作的响应数据。
ServicesListBySubscriptionNextResponse	包含 listBySubscriptionNext 操作的响应数据。
ServicesListBySubscriptionResponse	包含 listBySubscription 操作的响应数据。
ServicesUpdateResponse	包含更新操作的响应数据。
Versions	定义版本的值。 KnownVersions 可与版本互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 2024-03-01：初始服务版本
WorkspacesCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
WorkspacesGetResponse	包含获取操作的响应数据。
WorkspacesHeadResponse	包含头操作的响应数据。
WorkspacesListNextResponse	包含 listNext 操作的响应数据。
WorkspacesListResponse	包含列表操作的响应数据。

枚举

KnownActionType	服务接受的 ActionType 的已知值。
KnownApiKind	服务接受的 ApiKind 的已知值。
KnownApiSpecExportResultFormat	服务接受的 ApiSpecExportResultFormat 的已知值。
KnownApiSpecImportSourceFormat	服务接受的 ApiSpecImportSourceFormat 的已知值。
KnownCreatedByType	服务接受的 CreatedByType 的已知值。
KnownDeploymentState	服务接受的 DeploymentState 的已知值。
KnownEnvironmentKind	服务接受的 EnvironmentKind 的已知值。
KnownEnvironmentServerType	服务接受 的 EnvironmentServerType 的已知值。
KnownLifecycleStage	服务接受的 LifecycleStage 的已知值。
KnownManagedServiceIdentityType	服务接受的 ManagedServiceIdentityType 的已知值。
KnownMetadataAssignmentEntity	服务接受的 MetadataAssignmentEntity 的已知值。
KnownMetadataSchemaExportFormat	服务接受的 MetadataSchemaExportFormat 的已知值。
KnownOrigin	服务接受的 Origin 的已知值。
KnownProvisioningState	服务接受的 ProvisioningState 的已知值。
KnownVersions	服务 接受的版本的 已知值。

函数

getContinuationToken(unknown)

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

函数详细信息

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

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

返回

string | undefined

可在将来调用期间传入 byPage () 的继续标记。