Product - Get
Hiermee haalt u de details van het product op die zijn opgegeven door de id.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
product
|
path | True |
string |
Product-id. Moet uniek zijn in het huidige API Management service-exemplaar. |
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De antwoordtekst bevat de opgegeven productentiteit. Headers ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
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
{
"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"
}
}
Definities
Name | Description |
---|---|
Error |
Fout veldcontract. |
Error |
Foutreactie. |
Product |
Productdetails. |
Product |
of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished. |
ErrorFieldContract
Fout veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
ProductContract
Productdetails.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /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. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van 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 |
Productbeschrijving. Kan HTML-opmaaktags bevatten. |
properties.displayName |
string |
Productnaam. |
properties.state |
of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished. |
|
properties.subscriptionRequired |
boolean |
Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is. |
properties.subscriptionsLimit |
integer |
Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft. |
properties.terms |
string |
Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd 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
of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
Name | Type | Description |
---|---|---|
notPublished |
string |
|
published |
string |