Partilhar via


Apis interface

Interface que representa apis.

Métodos

createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)

Cria uma API nova ou atualiza a API existente.

delete(string, string, string, string, ApisDeleteOptionalParams)

Elimina a API especificada.

get(string, string, string, string, ApisGetOptionalParams)

Devolve detalhes da API.

head(string, string, string, string, ApisHeadOptionalParams)

Verifica se a API especificada existe.

list(string, string, string, ApisListOptionalParams)

Devolve uma coleção de APIs.

Detalhes de Método

createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)

Cria uma API nova ou atualiza a API existente.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>

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.

resource
Api

Parâmetros de criação de recursos.

options
ApisCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

delete(string, string, string, string, ApisDeleteOptionalParams)

Elimina a API especificada.

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): 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.

options
ApisDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, string, ApisGetOptionalParams)

Devolve detalhes da API.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>

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.

options
ApisGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApisGetResponse>

head(string, string, string, string, ApisHeadOptionalParams)

Verifica se a API especificada existe.

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>

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.

options
ApisHeadOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApisHeadResponse>

list(string, string, string, ApisListOptionalParams)

Devolve uma coleção de APIs.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], 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.

options
ApisListOptionalParams

Os parâmetros de opções.

Devoluções