Api Tag Description - List By Service
Elenca tutte le descrizioni dei tag nell'ambito dell'API. Modello simile a swagger: tagDescription è definito a livello di API, ma il tag può essere assegnato alle operazioni
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
api
|
path | True |
string |
Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ; rev=n come suffisso dove n è il numero di revisione. Regex pattern: |
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 di Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
$filter
|
query |
string |
| Campo | Utilizzo | Operatori supportati | Funzioni supportate | |
|
$skip
|
query |
integer int32 |
Numero di record da ignorare. |
|
$top
|
query |
integer int32 |
Numero di record da restituire. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
L'operazione restituisce una raccolta di tagDescriptions associate all'entità Api. |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementListApiTagDescriptions
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/tagDescriptions?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002",
"type": "Microsoft.ApiManagement/service/tags",
"name": "5600b539c53f5b0062060002",
"properties": {
"tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
"displayName": "tag1",
"externalDocsDescription": "some additional info",
"externalDocsUrl": "http://some_url.com"
}
}
],
"count": 1,
"nextLink": ""
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Tag |
Rappresentazione dell'elenco TagDescription di paging. |
Tag |
Dettagli del contratto. |
ErrorFieldContract
Contratto campo di 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. |
TagDescriptionCollection
Rappresentazione dell'elenco TagDescription di paging.
Nome | Tipo | Descrizione |
---|---|---|
count |
integer |
Numero totale di conteggio record in tutte le pagine. |
nextLink |
string |
Collegamento alla pagina successiva, se disponibile. |
value |
Valori di pagina. |
TagDescriptionContract
Dettagli del contratto.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.description |
string |
Descrizione del tag. |
properties.displayName |
string |
Nome tag. |
properties.externalDocsDescription |
string |
Descrizione delle risorse esterne che descrivono il tag. |
properties.externalDocsUrl |
string |
URL assoluto delle risorse esterne che descrivono il tag. |
properties.tagId |
string |
Identificatore del tag sotto forma di /tags/{tagId} |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |