Apis interface

Paquete:

@azure/arm-apicenter

Interfaz que representa una API.

Métodos

createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)	Crea una API nueva o actualiza la existente.
delete(string, string, string, string, ApisDeleteOptionalParams)	Elimina la API especificada.
get(string, string, string, string, ApisGetOptionalParams)	Devuelve los detalles de la API.
head(string, string, string, string, ApisHeadOptionalParams)	Comprueba si existe la API especificada.
list(string, string, string, ApisListOptionalParams)	Devuelve una colección de API.

Detalles del método

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

Crea una API nueva o actualiza la existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio Azure API Center.

workspaceName

string

Nombre del área de trabajo.

apiName

string

Nombre de la API.

resource

Api

Parámetros de creación de recursos.

options

ApisCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApisCreateOrUpdateResponse>

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

Elimina la API especificada.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio Azure API Center.

workspaceName

string

Nombre del área de trabajo.

apiName

string

Nombre de la API.

options

ApisDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Devuelve los detalles de la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio Azure API Center.

workspaceName

string

Nombre del área de trabajo.

apiName

string

Nombre de la API.

options

ApisGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApisGetResponse>

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

Comprueba si existe la API especificada.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio Azure API Center.

workspaceName

string

Nombre del área de trabajo.

apiName

string

Nombre de la API.

options

ApisHeadOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApisHeadResponse>

list(string, string, string, ApisListOptionalParams)

Devuelve una colección de API.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio Azure API Center.

workspaceName

string

Nombre del área de trabajo.

options

ApisListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<Api, Api[], PageSettings>