Share via

Gateway - List By Service

  • Odwołanie
Service:
API Management
API Version:
2022-08-01

Wyświetla listę kolekcji bram zarejestrowanych w wystąpieniu usługi.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName
 path True

string

Nazwa usługi API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.
$filter
 query

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

Liczba rekordów do pominięcia.
$top
 query

integer

int32

Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

GatewayCollection

Wyświetla listę kolekcji jednostek bramy.
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementListGateways

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
      "type": "Microsoft.ApiManagement/service/gateways",
      "name": "a1",
      "properties": {
        "description": "my gateway 1",
        "locationData": {
          "name": "my location 1"
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2",
      "type": "Microsoft.ApiManagement/service/gateways",
      "name": "5a73933b8f27f7cc82a2d533",
      "properties": {
        "description": "my gateway 2",
        "locationData": {
          "name": "my location 2"
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.
ErrorResponse

Odpowiedź na błąd.
GatewayCollection

Reprezentacja listy stronicowanej bramy.
GatewayContract

Szczegóły bramy.
ResourceLocationDataContract

Właściwości danych lokalizacji zasobu.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.
message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details

ErrorFieldContract[]

Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
error.message

string

Czytelna dla człowieka reprezentacja błędu.

GatewayCollection

Reprezentacja listy stronicowanej bramy.

Nazwa Typ Opis
count

integer

Łączna liczba rekordów na wszystkich stronach.
nextLink

string

Jeśli istnieje, łącze następnej strony.
value

GatewayContract[]

Wartości stron.

GatewayContract

Szczegóły bramy.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.description

string

Opis bramy
properties.locationData

ResourceLocationDataContract

Lokalizacja bramy.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Właściwości danych lokalizacji zasobu.

Nazwa Typ Opis
city

string

Miasto lub miejsce, w którym znajduje się zasób.
countryOrRegion

string

Kraj lub region, w którym znajduje się zasób.
district

string

Region, stan lub prowincja, w której znajduje się zasób.
name

string

Nazwa kanoniczna lokalizacji geograficznej lub fizycznej.