Product - Get
Ottiene i dettagli del prodotto specificato dall'identificatore.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
product
|
path | True |
string |
Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio Gestione API. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio Gestione API. Criterio di espressione regolare: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il corpo della risposta contiene l'entità Product specificata. Intestazioni ETag: string |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementGetProduct
Esempio di richiesta
Risposta di esempio
{
"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"
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Product |
Dettagli prodotto. |
Product |
se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non è Pubblicato. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
ProductContract
Dettagli prodotto.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.approvalRequired |
boolean |
se è necessaria l'approvazione della sottoscrizione. Se false, le nuove sottoscrizioni verranno approvate automaticamente consentendo agli sviluppatori di chiamare le API del prodotto immediatamente dopo la sottoscrizione. Se true, gli amministratori devono approvare manualmente la sottoscrizione prima che lo sviluppatore possa avere una delle API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false. |
properties.description |
string |
Descrizione del prodotto. Può includere tag di formattazione HTML. |
properties.displayName |
string |
Nome prodotto. |
properties.state |
se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non è Pubblicato. |
|
properties.subscriptionRequired |
boolean |
Indica se è necessaria una sottoscrizione del prodotto per l'accesso alle API incluse in questo prodotto. Se true, il prodotto viene definito "protetto" e una chiave di sottoscrizione valida è necessaria per una richiesta a un'API inclusa nel prodotto. Se false, il prodotto viene definito "aperto" e le richieste a un'API inclusa nel prodotto possono essere eseguite senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che sia true. |
properties.subscriptionsLimit |
integer |
Indica se il numero di sottoscrizioni che un utente può avere a questo prodotto contemporaneamente. Impostare su Null o omettere per consentire sottoscrizioni illimitate per utente. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false. |
properties.terms |
string |
Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ProductState
se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non è Pubblicato.
Nome | Tipo | Descrizione |
---|---|---|
notPublished |
string |
|
published |
string |