Compartir a través de

Product - Get

  • Referencia
Service:
API Management
API Version:
2022-08-01

Obtiene los detalles del producto especificado por su identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2022-08-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
productId
 path True

string

Identificador de producto. Debe ser único en la instancia de servicio de API Management actual.
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName
 path True

string

Nombre del servicio API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Identificador de la suscripción de destino.
api-version
 query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

ProductContract

El cuerpo de la respuesta contiene la entidad Product especificada.

Headers

ETag: string
Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

ApiManagementGetProduct

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "unlimited",
  "properties": {
    "displayName": "Unlimited",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definiciones

Nombre Description
ErrorFieldContract

Contrato de campo de error.
ErrorResponse

Respuesta de error.
ProductContract

Detalles del producto.
ProductState

si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.

ErrorFieldContract

Contrato de campo de error.

Nombre Tipo Description
code

string

Código de error de nivel de propiedad.
message

string

Representación legible del error de nivel de propiedad.
target

string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error.code

string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message

string

Representación legible del error.

ProductContract

Detalles del producto.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nombre del recurso.
properties.approvalRequired

boolean

si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción para que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false.
properties.description

string

Descripción del producto. Puede incluir etiquetas de formato HTML.
properties.displayName

string

Nombre de producto.
properties.state

ProductState

si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.
properties.subscriptionRequired

boolean

Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true.
properties.subscriptionsLimit

integer

Si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establézcalo en null omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor de false.
properties.terms

string

Términos de uso del producto. Los desarrolladores que traten de suscribirse al producto verán y deberán aceptar estos términos para poder completar el proceso de suscripción.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ProductState

si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.

Nombre Tipo Description
notPublished

string

published

string