Поделиться через

@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

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
ExternalDocumentation

Дополнительная внешняя документация по API.
License

Сведения о лицензии для API.
ManagedServiceIdentity

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
MetadataAssignment

Метаданные назначения
MetadataSchema

Сущность схемы метаданных. Используется для определения метаданных сущностей в каталоге API.
MetadataSchemaExportRequest

Запрос на экспорт схемы метаданных.
MetadataSchemaExportResult

Результат экспорта схемы метаданных.
MetadataSchemaListResult

Ответ операции списка MetadataSchema.
MetadataSchemaProperties

Свойства схемы метаданных.
MetadataSchemas

Интерфейс, представляющий метаданныеSchemas.
MetadataSchemasCreateOrUpdateHeaders

Определяет заголовки для операции MetadataSchemas_createOrUpdate.
MetadataSchemasCreateOrUpdateOptionalParams

Необязательные параметры.
MetadataSchemasDeleteOptionalParams

Необязательные параметры.
MetadataSchemasGetHeaders

Определяет заголовки для операции MetadataSchemas_get.
MetadataSchemasGetOptionalParams

Необязательные параметры.
MetadataSchemasHeadOptionalParams

Необязательные параметры.
MetadataSchemasListNextOptionalParams

Необязательные параметры.
MetadataSchemasListOptionalParams

Необязательные параметры.
Onboarding

Сведения о подключении
Operation

Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов
OperationDisplay

Локализованные сведения о отображении для конкретной операции.
OperationListResult

Список операций REST API, поддерживаемых поставщиком ресурсов Azure. Он содержит ссылку URL-адреса для получения следующего набора результатов.
Operations

Интерфейс, представляющий операции.
OperationsListNextOptionalParams

Необязательные параметры.
OperationsListOptionalParams

Необязательные параметры.
ProxyResource

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
Service

Сущность службы.
ServiceListResult

Ответ операции списка служб.
ServiceProperties

Свойства службы.
ServiceUpdate

Тип, используемый для операций обновления службы.
Services

Интерфейс, представляющий службы.
ServicesCreateOrUpdateOptionalParams

Необязательные параметры.
ServicesDeleteOptionalParams

Необязательные параметры.
ServicesExportMetadataSchemaHeaders

Определяет заголовки для операции Services_exportMetadataSchema.
ServicesExportMetadataSchemaOptionalParams

Необязательные параметры.
ServicesGetOptionalParams

Необязательные параметры.
ServicesListByResourceGroupNextOptionalParams

Необязательные параметры.
ServicesListByResourceGroupOptionalParams

Необязательные параметры.
ServicesListBySubscriptionNextOptionalParams

Необязательные параметры.
ServicesListBySubscriptionOptionalParams

Необязательные параметры.
ServicesUpdateOptionalParams

Необязательные параметры.
SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TermsOfService

Условия обслуживания ДЛЯ API.
TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
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 языка запросов Graph
grpc: API gRPC
soap: API SOAP
веб-перехватчик: веб-перехватчик
websocket: веб-сокет
ApiSpecExportResultFormat

Определяет значения для ApiSpecExportResultFormat.
KnownApiSpecExportResultFormat можно использовать взаимозаменяемо с ApiSpecExportResultFormat, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

встроенные: встроенное содержимое документа спецификации.
ссылку: ссылка на результат операции экспорта. URL-адрес действителен в течение 5 минут.
ApiSpecImportSourceFormat

Определяет значения для ApiSpecImportSourceFormat.
KnownApiSpecImportSourceFormat можно использовать взаимозаменяемо с ApiSpecImportSourceFormat, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

встроенные: встроенное содержимое документа спецификации.
ссылку: ссылка на документ спецификации, размещенный на общедоступном интернет-адресе.
ApiVersionsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
ApiVersionsGetResponse

Содержит данные ответа для операции получения.
ApiVersionsHeadResponse

Содержит данные ответа для головной операции.
ApiVersionsListNextResponse

Содержит данные ответа для операции listNext.
ApiVersionsListResponse

Содержит данные ответа для операции списка.
ApisCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
ApisGetResponse

Содержит данные ответа для операции получения.
ApisHeadResponse

Содержит данные ответа для головной операции.
ApisListNextResponse

Содержит данные ответа для операции listNext.
ApisListResponse

Содержит данные ответа для операции списка.
CreatedByType

Определяет значения для CreatedByType.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user
приложения
ManagedIdentity
ключ

DeploymentState

Определяет значения для DeploymentState.
KnownDeploymentState можно использовать взаимозаменяемо с DeploymentState, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

активные: активное состояние
неактивные: неактивное состояние
DeploymentsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
DeploymentsGetResponse

Содержит данные ответа для операции получения.
DeploymentsHeadResponse

Содержит данные ответа для головной операции.
DeploymentsListNextResponse

Содержит данные ответа для операции listNext.
DeploymentsListResponse

Содержит данные ответа для операции списка.
EnvironmentKind

Определяет значения для EnvironmentKind.
KnownEnvironmentKind можно использовать взаимозаменяемо с EnvironmentKind, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

разработки: среда разработки
тестирования: среда тестирования
промежуточной: промежуточная среда
рабочей: рабочая среда
EnvironmentServerType

Определяет значения для EnvironmentServerType.
KnownEnvironmentServerType можно использовать взаимозаменяемо с EnvironmentServerType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

управление API Azure: сервер управления API
службе вычислений Azure: вычислительный сервер
apigee API Management: сервер Apigee
шлюз API AWS: сервер шлюза API AWS
Шлюз API в Конгане: сервер шлюза API в Конгане
Kubernetes: сервер Kubernetes
Управление API MuleSoft: сервер управления API Mulesoft
EnvironmentsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
EnvironmentsGetResponse

Содержит данные ответа для операции получения.
EnvironmentsHeadResponse

Содержит данные ответа для головной операции.
EnvironmentsListNextResponse

Содержит данные ответа для операции listNext.
EnvironmentsListResponse

Содержит данные ответа для операции списка.
LifecycleStage

Определяет значения для Жизненного циклаStage.
KnownLifecycleStage можно использовать взаимозаменяемо с жизненным циклом, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

проектирования: этап разработки
разработки: этап разработки
тестирования: этап тестирования
предварительной версии: в предварительной версии
рабочей: в рабочей среде
нерекомендуемые: устаревший этап
отставной: этап выхода на пенсию
ManagedServiceIdentityType

Определяет значения для ManagedServiceIdentityType.
KnownManagedServiceIdentityType можно использовать взаимозаменяемо с ManagedServiceIdentityType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Нет
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
MetadataAssignmentEntity

Определяет значения для MetadataAssignmentEntity.
KnownMetadataAssignmentEntity можно использовать взаимозаменяемо с MetadataAssignmentEntity, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

API: назначен API
среда: назначена средам
развертывания: назначено развертыванию
MetadataSchemaExportFormat

Определяет значения для MetadataSchemaExportFormat.
KnownMetadataSchemaExportFormat можно использовать взаимозаменяемо с MetadataSchemaExportFormat, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

встроенные: встроенное содержимое документа схемы.
ссылку: ссылка на документ схемы. URL-адрес действителен в течение 5 минут.
MetadataSchemasCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
MetadataSchemasGetResponse

Содержит данные ответа для операции получения.
MetadataSchemasHeadResponse

Содержит данные ответа для головной операции.
MetadataSchemasListNextResponse

Содержит данные ответа для операции listNext.
MetadataSchemasListResponse

Содержит данные ответа для операции списка.
OperationsListNextResponse

Содержит данные ответа для операции listNext.
OperationsListResponse

Содержит данные ответа для операции списка.
Origin

Определяет значения для источника.
KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

пользователя
системные
пользователем, системным
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)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

Сведения о функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект от доступа к value на итераторе IteratorResult из byPage итератора.

Возвращаемое значение

string | undefined

Маркер продолжения, который можно передать в byPage() во время будущих вызовов.