ApiOperation interface
Interfaz que representa una ApiOperation.
Métodos
| create |
Crea una nueva operación en la API o actualiza una ya existente |
| delete(string, string, string, string, string, Api |
Elimina la operación especificada de la API. |
| get(string, string, string, string, Api |
Obtiene los detalles de la operación de API especificada por su identificador. |
| get |
Obtiene la versión del estado de entidad (Etag) de la operación de API especificada por su identificador. |
| list |
Enumera una colección de las operaciones de la API especificada |
| update(string, string, string, string, string, Operation |
Novedades los detalles de la operación en la API especificada por su identificador. |
Detalles del método
createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)
Crea una nueva operación en la API o actualiza una ya existente
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- parameters
- OperationContract
Crear parámetros.
Parámetros de opciones.
Devoluciones
Promise<ApiOperationCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)
Elimina la operación especificada de la API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- ApiOperationDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, string, ApiOperationGetOptionalParams)
Obtiene los detalles de la operación de API especificada por su identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- options
- ApiOperationGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiOperationGetResponse>
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)
Obtiene la versión del estado de entidad (Etag) de la operación de API especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
Parámetros de opciones.
Devoluciones
Promise<ApiOperationGetEntityTagHeaders>
listByApi(string, string, string, ApiOperationListByApiOptionalParams)
Enumera una colección de las operaciones de la API especificada
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
Parámetros de opciones.
Devoluciones
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)
Novedades los detalles de la operación en la API especificada por su identificador.
function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- operationId
-
string
Identificador de operación dentro de una API. Debe ser único en la instancia de servicio API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- parameters
- OperationUpdateContract
Parámetros de actualización de operaciones de API.
- options
- ApiOperationUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiOperationUpdateResponse>