Product interface
Interfaz que representa un producto.
Métodos
| create |
Crea o actualiza un producto |
| delete(string, string, string, string, Product |
Elimina el producto. |
| get(string, string, string, Product |
Obtiene los detalles del producto especificado por su identificador. |
| get |
Obtiene la versión de estado de entidad (Etag) del producto especificado por su identificador. |
| list |
Enumera una colección de productos de la instancia de servicio especificada |
| list |
Enumera una colección de productos asociados a etiquetas. |
| update(string, string, string, string, Product |
Actualice los detalles del producto existentes. |
Detalles del método
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
Crea o actualiza un producto
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
- parameters
- ProductContract
Crear o actualizar parámetros.
Parámetros de opciones.
Devoluciones
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
Elimina el producto.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): 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.
- productId
-
string
Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- ProductDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, ProductGetOptionalParams)
Obtiene los detalles del producto especificado por su identificador.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
- options
- ProductGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad (Etag) del producto especificado por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
Parámetros de opciones.
Devoluciones
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
Enumera una colección de productos de la instancia de servicio especificada
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], 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.
Parámetros de opciones.
Devoluciones
listByTags(string, string, ProductListByTagsOptionalParams)
Enumera una colección de productos asociados a etiquetas.
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], 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.
- options
- ProductListByTagsOptionalParams
Parámetros de opciones.
Devoluciones
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
Actualice los detalles del producto existentes.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- productId
-
string
Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- parameters
- ProductUpdateParameters
Actualice los parámetros.
- options
- ProductUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ProductUpdateResponse>