Product - Get

Service:

API Management

API-versie:

2024-05-01

Hiermee haalt u de details op van het product dat is opgegeven met de id.

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

URI-parameters

Name	In	Vereist	Type	Description
productId	path	True	string minLength: 1 maxLength: 256	Product-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ProductContract	De antwoordtekst bevat de opgegeven productentiteit. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetProduct

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2024-05-01

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ProductContract	Productdetails.
ProductState	of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ProductContract

Object

Productdetails.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.approvalRequired	boolean	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.description	string minLength: 0 maxLength: 1000	Productbeschrijving. Kan HTML-opmaaktags bevatten.
properties.displayName	string minLength: 1 maxLength: 300	Productnaam.
properties.state	ProductState	of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.
properties.subscriptionRequired	boolean	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is.
properties.subscriptionsLimit	integer (int32)	Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.terms	string	Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ProductState

Inventarisatie

of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.

Waarde	Description
notPublished
published