Api Gateway Config Connection - List By Gateway

Dienst:

API Management

API-Version:

2024-05-01

Auflisten aller KONFIGURATIONSverbindungen des API-Verwaltungsgateways innerhalb eines Gateways.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsgateways.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
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.

Antworten

Name	Typ	Beschreibung
200 OK	ApiManagementGatewayConfigConnectionListResult	Die Verbindungsliste für die API-Verwaltungsgatewaykonfiguration.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang 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

ApiManagementListGatewayConfigConnection

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
      "name": "gcc-1",
      "type": "Microsoft.ApiManagement/gateways/configConnections",
      "etag": "AAAAAAAWN/4=",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
        "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net",
        "hostnames": [
          "gcc1standard-gw-1.gateway.eastus.azure-api.net"
        ]
      }
    },
    {
      "etag": "AAAAAAAWKwo=",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2",
      "name": "gcc-2",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002",
        "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net"
      },
      "type": "Microsoft.ApiManagement/gateways/configConnetions"
    }
  ]
}

Definitionen

Name	Beschreibung
ApiManagementGatewayConfigConnectionListResult	Die Antwort des Listen-API-Verwaltungsgateways.
ApiManagementGatewayConfigConnectionResource	Eine einzelne API-Verwaltungsgatewayressource in "List" oder "Get response".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

ApiManagementGatewayConfigConnectionListResult

Objekt

Die Antwort des Listen-API-Verwaltungsgateways.

Name	Typ	Beschreibung
nextLink	string	Verknüpfen Sie den nächsten Ergebnissatz. Nicht leer, wenn Der Wert eine unvollständige Liste der API-Verwaltungsdienste enthält.
value	ApiManagementGatewayConfigConnectionResource[]	Ergebnis des Verbindungsvorgangs des Listen-API-Verwaltungsgateways.

ApiManagementGatewayConfigConnectionResource

Objekt

Eine einzelne API-Verwaltungsgatewayressource in "List" oder "Get response".

Name	Typ	Beschreibung
etag	string	ETag der Ressource.
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.defaultHostname	string	Der Standardhostname des Datenebenengateways.
properties.hostnames	string[]	Die Hostnamen des Datenebenengateways, an das Anforderungen gesendet werden können.
properties.provisioningState	string	Der aktuelle Bereitstellungsstatus der API-Verwaltungsgatewaykonfigurationsverbindung
properties.sourceId	string (arm-id)	Der Link zum ARBEITSBEREICH des API-Verwaltungsdiensts.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.