@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 da versão da API.
ApiVersionListResult	A resposta de uma operação de lista ApiVersion.
ApiVersionProperties	Entidade de propriedades da 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 contacto
Deployment	Entidade de implementação de API.
DeploymentListResult	A resposta de uma operação de Lista de implementação.
DeploymentProperties	Propriedades da entidade de implementação de API.
DeploymentServer	Servidor
Deployments	Interface que representa uma Implementaçã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 ambiente.
EnvironmentProperties	Entidade de propriedades do 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	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto 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 da API.
ManagedServiceIdentity	Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)
MetadataAssignment	Metadados de atribuição
MetadataSchema	Entidade de esquema de metadados. Utilizado para definir metadados para as entidades no catálogo de API.
MetadataSchemaExportRequest	O pedido de exportação do 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 inclusão
Operation	Detalhes de uma operação da API REST, devolvida a partir da API de Operações do Fornecedor de Recursos
OperationDisplay	Informações de apresentação localizadas para esta operação específica.
OperationListResult	Uma lista das operações da API REST suportadas por um Fornecedor de Recursos do Azure. Contém uma ligação de URL para obter o próximo conjunto de resultados.
Operations	Interface que representa uma Operação.
OperationsListNextOptionalParams	Parâmetros opcionais.
OperationsListOptionalParams	Parâmetros opcionais.
ProxyResource	A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Não terá etiquetas nem uma localização
Resource	Campos comuns que são devolvidos 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 utilizado 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 controlado do Azure Resource Manager que tem "etiquetas" e uma "localização"
UserAssignedIdentity	Propriedades de identidade atribuídas pelo utilizador
Workspace	Entidade da área de trabalho.
WorkspaceListResult	A resposta de uma operação de lista área de trabalho.
WorkspaceProperties	Propriedades da área de trabalho.
Workspaces	Interface que representa uma Área de Trabalho.
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 utilizado alternadamente com ActionType, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Interno
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 principal.
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 a ApiKind. KnownApiKind pode ser utilizado alternadamente com a ApiKind. Esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço rest: A Representational State Transfer Api (API de Transferência de Estado De Representação) graphql: A Graph query language Api (API de linguagem de consulta do Graph) grpc: A gRPC Api soap: A SOAP Api webhook: Web Hook websocket: Socket Web
ApiSpecExportResultFormat	Define valores para ApiSpecExportResultFormat. KnownApiSpecExportResultFormat pode ser utilizado alternadamente com ApiSpecExportResultFormat, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço inline: o conteúdo indicado de um documento de especificação. ligação: a ligação para o resultado da operação de exportação. O URL é válido durante 5 minutos.
ApiSpecImportSourceFormat	Define valores para ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat pode ser utilizado alternadamente com ApiSpecImportSourceFormat, esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço inline: o conteúdo indicado de um documento de especificação. ligação: a ligação para um documento de especificação alojado num endereço internet acessível publicamente.
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 principal.
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 principal.
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 utilizado alternadamente com CreatedByType, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Utilizador Aplicação ManagedIdentity Chave
DeploymentState	Define valores para DeploymentState. KnownDeploymentState pode ser utilizado alternadamente com DeploymentState, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço ativo: 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 principal.
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 utilizado alternadamente com EnvironmentKind, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço desenvolvimento: Ambiente de desenvolvimento teste: Ambiente de teste teste: Ambiente de teste produção: Ambiente de produção
EnvironmentServerType	Define valores para EnvironmentServerType. KnownEnvironmentServerType pode ser utilizado alternadamente com EnvironmentServerType, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Azure Gestão de API: Servidor de Gestão de API Serviço de computação do Azure: Servidor de computação Apigee Gestão de API: Servidor Apigee Gateway de API do AWS: servidor do Gateway de API do AWS Gateway de API de Kong: Servidor de Gateway de API de Kong Kubernetes: servidor kubernetes MuleSoft Gestão de API: Servidor de Gestão 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 principal.
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 utilizado alternadamente com LifecycleStage, esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço design: fase de design desenvolvimento: fase de desenvolvimento teste: fase de teste pré-visualização: Em pré-visualização produção: Em produção preterido: fase preterida descontinuado: Fase descontinuada
ManagedServiceIdentityType	Define valores para ManagedServiceIdentityType. KnownManagedServiceIdentityType pode ser utilizado alternadamente com ManagedServiceIdentityType. Este enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Nenhuma SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Define valores para MetadataAssignmentEntity. KnownMetadataAssignmentEntity pode ser utilizado alternadamente com MetadataAssignmentEntity. Esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço api: Atribuída à API ambiente: Atribuído ao Ambiente implementação: Atribuída à Implementação
MetadataSchemaExportFormat	Define valores para MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat pode ser utilizado alternadamente com MetadataSchemaExportFormat, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço inline: o conteúdo indicado de um documento de esquema. ligação: a ligação para um documento de esquema. O URL é válido durante 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 principal.
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 Origem. O KnownOrigin pode ser utilizado alternadamente com a Origem. Esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Utilizador sistema utilizador,sistema
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState pode ser utilizado alternadamente com ProvisioningState, esta enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Com êxito: o recurso foi criado. Falha: a criação de recursos falhou. Cancelado: a criação de recursos 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. As KnownVersions podem ser utilizadas alternadamente com Versões. Esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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 principal.
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 da 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, devolve um token de continuação que pode ser utilizado para começar a paginar a partir desse ponto mais tarde.

Detalhes de Função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, devolve um token de continuação que pode ser utilizado para começar a paginar a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto a value partir do acesso no IteratorResult a partir de um byPage iterador.

Devoluções

string | undefined

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