Freigeben über


Graph QL Api Resolver - List By Api

Listet eine Auflistung der Resolver für die angegebene GraphQL-API auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers?api-version=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
apiId
path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Der Name des API-Verwaltungsdiensts.

subscriptionId
path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

$filter
query

string

| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen |
|-------------|-------------|-------------|-------------|
| Name | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith |
| beschreibung | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith |
| Pfad | filter | ge, le, eq, ne, gt, lt | teilstringof, contains, startswith, endswith |

$skip
query

integer (int32)

minimum: 0

Anzahl der zu überspringenden Datensätze.

$top
query

integer (int32)

minimum: 1

Anzahl der zurückzugebenden Datensätze.

Antworten

Name Typ Beschreibung
200 OK

ResolverCollection

Eine Sammlung von Resolver-Zusammenfassungsentitäten auf Der Ebene der GraphQL-API.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Resolver fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementListGraphQLApiResolvers

Beispielanforderung

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

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/resolvers",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "Query Users",
        "path": "Query/users",
        "description": "A GraphQL Resolver example"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/resolvers",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "Mutation makeUser",
        "path": "Mutation/makeUser",
        "description": "A GraphQL Resolver example"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/resolvers",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "Query for User Id field",
        "path": "User/id",
        "description": "A GraphQL Resolver example"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

ResolverCollection

Paged Resolver-Listendarstellung.

ResolverContract

Details zur GraphQL-API-Auflösung.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ResolverCollection

Paged Resolver-Listendarstellung.

Name Typ Beschreibung
count

integer (int64)

Gesamtzahl der Datensätze auf allen Seiten.

nextLink

string

Link zur nächsten Seite, falls vorhanden.

value

ResolverContract[]

Seitenwerte.

ResolverContract

Details zur GraphQL-API-Auflösung.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.description

string

maxLength: 1000

Beschreibung des Resolvers. Kann HTML-Formatierungstags enthalten.

properties.displayName

string

minLength: 1
maxLength: 300

Resolvername.

properties.path

string

minLength: 1
maxLength: 300

Pfad ist Typ/Feld, das aufgelöst wird.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"