ProductApi interface
Interfaz que representa un ProductApi.
Métodos
| check |
Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Product. |
| create |
Agrega una API al producto especificado. |
| delete(string, string, string, string, Product |
Elimina la API especificada del producto especificado. |
| list |
Enumera una colección de las API asociadas a un producto. |
Detalles del método
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Product.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador del producto. Debe ser único en la instancia actual del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.
Parámetros de opciones.
Devoluciones
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Agrega una API al producto especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador del producto. Debe ser único en la instancia actual del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.
Parámetros de opciones.
Devoluciones
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Elimina la API especificada del producto especificado.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): 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 API Management.
- productId
-
string
Identificador del producto. Debe ser único en la instancia actual del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.
- options
- ProductApiDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Enumera una colección de las API asociadas a un producto.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador del producto. Debe ser único en la instancia actual del servicio API Management.
Parámetros de opciones.