Partilhar via

ApiDefinitions interface

  • Referência
Pacote:
@azure/arm-apicenter

Interface que representa uma ApiDefinitions.

Métodos

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exporta a especificação da API.
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exporta a especificação da API.
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importa a especificação da API.
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importa a especificação da API.
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

Cria uma definição de API nova ou atualiza a existente.
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

Elimina a definição de API especificada.
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

Devolve detalhes da definição da API.
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

Verifica se a definição de API especificada existe.
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

Devolve uma coleção de definições de API.

Detalhes de Método

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exporta a especificação da API.

function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

options
ApiDefinitionsExportSpecificationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exporta a especificação da API.

function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

options
ApiDefinitionsExportSpecificationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiSpecExportResult>

beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importa a especificação da API.

function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

body
ApiSpecImportRequest

O conteúdo do pedido de ação

options
ApiDefinitionsImportSpecificationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importa a especificação da API.

function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

body
ApiSpecImportRequest

O conteúdo do pedido de ação

options
ApiDefinitionsImportSpecificationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

Cria uma definição de API nova ou atualiza a existente.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

resource
ApiDefinition

Parâmetros de criação de recursos.

options
ApiDefinitionsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiDefinitionsCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

Elimina a definição de API especificada.

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

options
ApiDefinitionsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

Devolve detalhes da definição da API.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

options
ApiDefinitionsGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiDefinitionsGetResponse>

head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

Verifica se a definição de API especificada existe.

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

definitionName

string

O nome da definição da API.

options
ApiDefinitionsHeadOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiDefinitionsHeadResponse>

list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

Devolve uma coleção de definições de API.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço API Center do Azure.

workspaceName

string

O nome da área de trabalho.

apiName

string

O nome da API.

versionName

string

O nome da versão da API.

options
ApiDefinitionsListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>