@azure/arm-apicenter package

Classes

AzureAPICenter

Interfaces

Api	Entidade de API.
ApiDefinition	Entidade de definição de API.
ApiDefinitionListResult	A resposta de uma operação de lista ApiDefinition.
ApiDefinitionProperties	Entidade de propriedades de definição de API.
ApiDefinitionPropertiesSpecification	Detalhes da especificação da API.
ApiDefinitions	Interface que representa uma ApiDefinitions.
ApiDefinitionsCreateOrUpdateHeaders	Define cabeçalhos para ApiDefinitions_createOrUpdate operação.
ApiDefinitionsCreateOrUpdateOptionalParams	Parâmetros opcionais.
ApiDefinitionsDeleteOptionalParams	Parâmetros opcionais.
ApiDefinitionsExportSpecificationHeaders	Define cabeçalhos para ApiDefinitions_exportSpecification operação.
ApiDefinitionsExportSpecificationOptionalParams	Parâmetros opcionais.
ApiDefinitionsGetHeaders	Define cabeçalhos para ApiDefinitions_get operação.
ApiDefinitionsGetOptionalParams	Parâmetros opcionais.
ApiDefinitionsHeadOptionalParams	Parâmetros opcionais.
ApiDefinitionsImportSpecificationHeaders	Define cabeçalhos para ApiDefinitions_importSpecification operação.
ApiDefinitionsImportSpecificationOptionalParams	Parâmetros opcionais.
ApiDefinitionsListNextOptionalParams	Parâmetros opcionais.
ApiDefinitionsListOptionalParams	Parâmetros opcionais.
ApiListResult	A resposta de uma operação de lista de API.
ApiProperties	Propriedades da API.
ApiSpecExportResult	O resultado da exportação da especificação da API.
ApiSpecImportRequest	As propriedades da entidade de origem da especificação da API.
ApiSpecImportRequestSpecification	Detalhes da especificação da API.
ApiVersion	Entidade de versão da API.
ApiVersionListResult	A resposta de uma operação de lista ApiVersion.
ApiVersionProperties	Entidade de propriedades de versão da API.
ApiVersions	Interface que representa uma ApiVersions.
ApiVersionsCreateOrUpdateHeaders	Define cabeçalhos para ApiVersions_createOrUpdate operação.
ApiVersionsCreateOrUpdateOptionalParams	Parâmetros opcionais.
ApiVersionsDeleteOptionalParams	Parâmetros opcionais.
ApiVersionsGetHeaders	Define cabeçalhos para ApiVersions_get operação.
ApiVersionsGetOptionalParams	Parâmetros opcionais.
ApiVersionsHeadOptionalParams	Parâmetros opcionais.
ApiVersionsListNextOptionalParams	Parâmetros opcionais.
ApiVersionsListOptionalParams	Parâmetros opcionais.
Apis	Interface que representa uma Apis.
ApisCreateOrUpdateHeaders	Define cabeçalhos para Apis_createOrUpdate operação.
ApisCreateOrUpdateOptionalParams	Parâmetros opcionais.
ApisDeleteOptionalParams	Parâmetros opcionais.
ApisGetHeaders	Define cabeçalhos para Apis_get operação.
ApisGetOptionalParams	Parâmetros opcionais.
ApisHeadOptionalParams	Parâmetros opcionais.
ApisListNextOptionalParams	Parâmetros opcionais.
ApisListOptionalParams	Parâmetros opcionais.
AzureAPICenterOptionalParams	Parâmetros opcionais.
Contact	Informações de contato
Deployment	Entidade de implantação de API.
DeploymentListResult	A resposta de uma operação de lista de implantação.
DeploymentProperties	Propriedades da entidade de implantação de API.
DeploymentServer	Servidor
Deployments	Interface que representa uma implantação.
DeploymentsCreateOrUpdateHeaders	Define cabeçalhos para Deployments_createOrUpdate operação.
DeploymentsCreateOrUpdateOptionalParams	Parâmetros opcionais.
DeploymentsDeleteOptionalParams	Parâmetros opcionais.
DeploymentsGetHeaders	Define cabeçalhos para Deployments_get operação.
DeploymentsGetOptionalParams	Parâmetros opcionais.
DeploymentsHeadOptionalParams	Parâmetros opcionais.
DeploymentsListNextOptionalParams	Parâmetros opcionais.
DeploymentsListOptionalParams	Parâmetros opcionais.
Environment	Entidade de ambiente.
EnvironmentListResult	A resposta de uma operação de lista de ambientes.
EnvironmentProperties	Entidade de propriedades de ambiente.
EnvironmentServer	Informações do servidor do ambiente.
Environments	Interface que representa um Ambientes.
EnvironmentsCreateOrUpdateHeaders	Define cabeçalhos para Environments_createOrUpdate operação.
EnvironmentsCreateOrUpdateOptionalParams	Parâmetros opcionais.
EnvironmentsDeleteOptionalParams	Parâmetros opcionais.
EnvironmentsGetHeaders	Define cabeçalhos para Environments_get operação.
EnvironmentsGetOptionalParams	Parâmetros opcionais.
EnvironmentsHeadOptionalParams	Parâmetros opcionais.
EnvironmentsListNextOptionalParams	Parâmetros opcionais.
EnvironmentsListOptionalParams	Parâmetros opcionais.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
ExternalDocumentation	Documentação externa adicional para a API.
License	As informações de licença para a API.
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)
MetadataAssignment	Metadados de atribuição
MetadataSchema	Entidade de esquema de metadados. Usado para definir metadados para as entidades no catálogo de API.
MetadataSchemaExportRequest	A solicitação de exportação de esquema de metadados.
MetadataSchemaExportResult	O resultado da exportação do esquema de metadados.
MetadataSchemaListResult	A resposta de uma operação de lista MetadataSchema.
MetadataSchemaProperties	Propriedades do esquema de metadados.
MetadataSchemas	Interface que representa um MetadataSchemas.
MetadataSchemasCreateOrUpdateHeaders	Define cabeçalhos para MetadataSchemas_createOrUpdate operação.
MetadataSchemasCreateOrUpdateOptionalParams	Parâmetros opcionais.
MetadataSchemasDeleteOptionalParams	Parâmetros opcionais.
MetadataSchemasGetHeaders	Define cabeçalhos para MetadataSchemas_get operação.
MetadataSchemasGetOptionalParams	Parâmetros opcionais.
MetadataSchemasHeadOptionalParams	Parâmetros opcionais.
MetadataSchemasListNextOptionalParams	Parâmetros opcionais.
MetadataSchemasListOptionalParams	Parâmetros opcionais.
Onboarding	Informações de integração
Operation	Detalhes de uma operação da API REST, retornada da API de Operações do Provedor de Recursos
OperationDisplay	Informações de exibição localizadas para esta operação específica.
OperationListResult	Uma lista de operações da API REST com suporte por um Provedor de Recursos do Azure. Ele contém um link de URL para obter o próximo conjunto de resultados.
Operations	Interface que representa operações.
OperationsListNextOptionalParams	Parâmetros opcionais.
OperationsListOptionalParams	Parâmetros opcionais.
ProxyResource	A definição do modelo de recurso para um recurso de proxy de Resource Manager do Azure. Ele não terá marcas e um local
Resource	Campos comuns retornados na resposta para todos os recursos do Azure Resource Manager
Service	A entidade de serviço.
ServiceListResult	A resposta de uma operação de lista de serviços.
ServiceProperties	As propriedades do serviço.
ServiceUpdate	O tipo usado para operações de atualização do Serviço.
Services	Interface que representa um Serviços.
ServicesCreateOrUpdateOptionalParams	Parâmetros opcionais.
ServicesDeleteOptionalParams	Parâmetros opcionais.
ServicesExportMetadataSchemaHeaders	Define cabeçalhos para Services_exportMetadataSchema operação.
ServicesExportMetadataSchemaOptionalParams	Parâmetros opcionais.
ServicesGetOptionalParams	Parâmetros opcionais.
ServicesListByResourceGroupNextOptionalParams	Parâmetros opcionais.
ServicesListByResourceGroupOptionalParams	Parâmetros opcionais.
ServicesListBySubscriptionNextOptionalParams	Parâmetros opcionais.
ServicesListBySubscriptionOptionalParams	Parâmetros opcionais.
ServicesUpdateOptionalParams	Parâmetros opcionais.
SystemData	Metadados relativos à criação e à última modificação do recurso.
TermsOfService	Termos de serviço para a API.
TrackedResource	A definição do modelo de recurso para um recurso de nível superior do Azure Resource Manager rastreado que tem 'tags' e um 'location'
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
Workspace	Entidade de workspace.
WorkspaceListResult	A resposta de uma operação de lista de workspaces.
WorkspaceProperties	Propriedades do workspace.
Workspaces	Interface que representa um Workspaces.
WorkspacesCreateOrUpdateHeaders	Define cabeçalhos para Workspaces_createOrUpdate operação.
WorkspacesCreateOrUpdateOptionalParams	Parâmetros opcionais.
WorkspacesDeleteOptionalParams	Parâmetros opcionais.
WorkspacesGetHeaders	Define cabeçalhos para Workspaces_get operação.
WorkspacesGetOptionalParams	Parâmetros opcionais.
WorkspacesHeadOptionalParams	Parâmetros opcionais.
WorkspacesListNextOptionalParams	Parâmetros opcionais.
WorkspacesListOptionalParams	Parâmetros opcionais.

Aliases de tipo

ActionType	Define valores para ActionType. KnownActionType pode ser usado intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Interna
ApiDefinitionsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Contém dados de resposta para a operação exportSpecification.
ApiDefinitionsGetResponse	Contém dados de resposta para a operação get.
ApiDefinitionsHeadResponse	Contém dados de resposta para a operação de cabeçalho.
ApiDefinitionsListNextResponse	Contém dados de resposta para a operação listNext.
ApiDefinitionsListResponse	Contém dados de resposta para a operação de lista.
ApiKind	Define valores para ApiKind. KnownApiKind pode ser usado intercambiável com a ApiKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço rest: uma API de Transferência de Estado Representacional graphql: API de linguagem de consulta do Graph grpc: A gRPC Api soap: uma API SOAP webhook: Web Hook websocket: Web Socket
ApiSpecExportResultFormat	Define valores para ApiSpecExportResultFormat. KnownApiSpecExportResultFormat pode ser usado intercambiável com ApiSpecExportResultFormat, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço embutido: o conteúdo embutido de um documento de especificação. link: o link para o resultado da operação de exportação. A URL é válida por 5 minutos.
ApiSpecImportSourceFormat	Define valores para ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat pode ser usado de forma intercambiável com ApiSpecImportSourceFormat, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço embutido: o conteúdo embutido de um documento de especificação. link: o link para um documento de especificação hospedado em um endereço de Internet publicamente acessível.
ApiVersionsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
ApiVersionsGetResponse	Contém dados de resposta para a operação get.
ApiVersionsHeadResponse	Contém dados de resposta para a operação de cabeçalho.
ApiVersionsListNextResponse	Contém dados de resposta para a operação listNext.
ApiVersionsListResponse	Contém dados de resposta para a operação de lista.
ApisCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
ApisGetResponse	Contém dados de resposta para a operação get.
ApisHeadResponse	Contém dados de resposta para a operação de cabeçalho.
ApisListNextResponse	Contém dados de resposta para a operação listNext.
ApisListResponse	Contém dados de resposta para a operação de lista.
CreatedByType	Define valores para CreatedByType. KnownCreatedByType pode ser usado intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Usuário Aplicativo ManagedIdentity Chave
DeploymentState	Define valores para DeploymentState. KnownDeploymentState pode ser usado de forma intercambiável com DeploymentState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço active: Estado ativo inativo: estado inativo
DeploymentsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
DeploymentsGetResponse	Contém dados de resposta para a operação get.
DeploymentsHeadResponse	Contém dados de resposta para a operação de cabeçalho.
DeploymentsListNextResponse	Contém dados de resposta para a operação listNext.
DeploymentsListResponse	Contém dados de resposta para a operação de lista.
EnvironmentKind	Define valores para EnvironmentKind. KnownEnvironmentKind pode ser usado intercambiável com EnvironmentKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço desenvolvimento: ambiente de desenvolvimento teste: ambiente de teste preparo: ambiente de preparo produção: ambiente de produção
EnvironmentServerType	Define valores para EnvironmentServerType. KnownEnvironmentServerType pode ser usado intercambiável com EnvironmentServerType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Azure Gerenciamento de API: Servidor de Gerenciamento de API Serviço de computação do Azure: servidor de computação Apigee Gerenciamento de API: servidor Apigee Gateway de API da AWS: servidor de Gateway de API da AWS Gateway de API de Kong: servidor de Gateway de API de Kong Kubernetes: servidor Kubernetes MuleSoft Gerenciamento de API: Servidor de Gerenciamento de API mulesoft
EnvironmentsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
EnvironmentsGetResponse	Contém dados de resposta para a operação get.
EnvironmentsHeadResponse	Contém dados de resposta para a operação de cabeçalho.
EnvironmentsListNextResponse	Contém dados de resposta para a operação listNext.
EnvironmentsListResponse	Contém dados de resposta para a operação de lista.
LifecycleStage	Define valores para LifecycleStage. KnownLifecycleStage pode ser usado intercambiável com LifecycleStage, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço design: estágio de design desenvolvimento: estágio de desenvolvimento teste: estágio de teste versão prévia: na versão prévia produção: Em produção preterido: estágio preterido desativado: estágio desativado
ManagedServiceIdentityType	Define valores para ManagedServiceIdentityType. KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhuma SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Define valores para MetadataAssignmentEntity. KnownMetadataAssignmentEntity pode ser usado de forma intercambiável com MetadataAssignmentEntity, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço api: atribuído à API ambiente: atribuído ao ambiente implantação: atribuído à implantação
MetadataSchemaExportFormat	Define valores para MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat pode ser usado de forma intercambiável com MetadataSchemaExportFormat, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço embutido: o conteúdo embutido de um documento de esquema. link: o link para um documento de esquema. A URL é válida por 5 minutos.
MetadataSchemasCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
MetadataSchemasGetResponse	Contém dados de resposta para a operação get.
MetadataSchemasHeadResponse	Contém dados de resposta para a operação de cabeçalho.
MetadataSchemasListNextResponse	Contém dados de resposta para a operação listNext.
MetadataSchemasListResponse	Contém dados de resposta para a operação de lista.
OperationsListNextResponse	Contém dados de resposta para a operação listNext.
OperationsListResponse	Contém dados de resposta para a operação de lista.
Origin	Define valores para Origin. KnownOrigin pode ser usado de forma intercambiável com Origin, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço user sistema usuário, sistema
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Êxito: o recurso foi criado. Falha: falha na criação de recursos. Cancelado: a criação do recurso foi cancelada.
ServicesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
ServicesExportMetadataSchemaResponse	Contém dados de resposta para a operação exportMetadataSchema.
ServicesGetResponse	Contém dados de resposta para a operação get.
ServicesListByResourceGroupNextResponse	Contém dados de resposta para a operação listByResourceGroupNext.
ServicesListByResourceGroupResponse	Contém dados de resposta para a operação listByResourceGroup.
ServicesListBySubscriptionNextResponse	Contém dados de resposta para a operação listBySubscriptionNext.
ServicesListBySubscriptionResponse	Contém dados de resposta para a operação listBySubscription.
ServicesUpdateResponse	Contém dados de resposta para a operação de atualização.
Versions	Define valores para Versões. KnownVersions pode ser usado de forma intercambiável com Versões, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço 2024-03-01: a versão inicial do serviço
WorkspacesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WorkspacesGetResponse	Contém dados de resposta para a operação get.
WorkspacesHeadResponse	Contém dados de resposta para a operação de cabeçalho.
WorkspacesListNextResponse	Contém dados de resposta para a operação listNext.
WorkspacesListResponse	Contém dados de resposta para a operação de lista.

Enumerações

KnownActionType	Valores conhecidos de ActionType que o serviço aceita.
KnownApiKind	Valores conhecidos da ApiKind que o serviço aceita.
KnownApiSpecExportResultFormat	Valores conhecidos de ApiSpecExportResultFormat que o serviço aceita.
KnownApiSpecImportSourceFormat	Valores conhecidos de ApiSpecImportSourceFormat que o serviço aceita.
KnownCreatedByType	Valores conhecidos de CreatedByType que o serviço aceita.
KnownDeploymentState	Valores conhecidos de DeploymentState que o serviço aceita.
KnownEnvironmentKind	Valores conhecidos de EnvironmentKind que o serviço aceita.
KnownEnvironmentServerType	Valores conhecidos de EnvironmentServerType que o serviço aceita.
KnownLifecycleStage	Valores conhecidos de LifecycleStage que o serviço aceita.
KnownManagedServiceIdentityType	Valores conhecidos de ManagedServiceIdentityType que o serviço aceita.
KnownMetadataAssignmentEntity	Valores conhecidos de MetadataAssignmentEntity que o serviço aceita.
KnownMetadataSchemaExportFormat	Valores conhecidos de MetadataSchemaExportFormat que o serviço aceita.
KnownOrigin	Valores conhecidos de Origem que o serviço aceita.
KnownProvisioningState	Valores conhecidos de ProvisioningState que o serviço aceita.
KnownVersions	Valores conhecidos de Versões que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acesso value no IteratorResult de um byPage iterador.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.