ApiDefinitions interface

Paquete:

@azure/arm-apicenter

Interfaz que representa una ApiDefinitions.

Métodos

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Exporta la especificación de API.
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Exporta la especificación de API.
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importa la especificación de la API.
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importa la especificación de la API.
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)	Crea una definición de API nueva o actualiza la existente.
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)	Elimina la definición de API especificada.
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)	Devuelve los detalles de la definición de API.
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)	Comprueba si existe la definición de API especificada.
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)	Devuelve una colección de definiciones de API.

Detalles del método

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

Exporta la especificación de 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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

options

ApiDefinitionsExportSpecificationOptionalParams

Parámetros de opciones.

Devoluciones

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

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

Exporta la especificación de API.

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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

options

ApiDefinitionsExportSpecificationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiSpecExportResult>

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

Importa la especificación de la 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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

body

ApiSpecImportRequest

Contenido de la solicitud de acción

options

ApiDefinitionsImportSpecificationOptionalParams

Parámetros de opciones.

Devoluciones

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

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

Importa la especificación de la 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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

body

ApiSpecImportRequest

Contenido de la solicitud de acción

options

ApiDefinitionsImportSpecificationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Crea una definición de API nueva o actualiza la 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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

resource

ApiDefinition

Parámetros de creación de recursos.

options

ApiDefinitionsCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiDefinitionsCreateOrUpdateResponse>

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

Elimina la definición 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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

options

ApiDefinitionsDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Devuelve los detalles de la definición de API.

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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

options

ApiDefinitionsGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiDefinitionsGetResponse>

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

Comprueba si existe la definición de API especificada.

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

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.

versionName

string

Nombre de la versión de la API.

definitionName

string

Nombre de la definición de API.

options

ApiDefinitionsHeadOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiDefinitionsHeadResponse>

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

Devuelve una colección de definiciones de API.

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

apiName

string

Nombre de la API.

versionName

string

Nombre de la versión de la API.

options

ApiDefinitionsListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>