Gateway - List By Service

  • Referencia
Service:
API Management
API Version:
2022-08-01

A szolgáltatáspéldányban regisztrált átjárók gyűjteményét sorolja fel.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
 path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName
 path True

string

A API Management szolgáltatás neve.

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

string

A cél-előfizetés azonosítója.
api-version
 query True

string

A művelethez használandó API-verzió.
$filter
 query

string

| Mező | Használat | Támogatott operátorok | Támogatott függvények |
|-------------|-------------|-------------|-------------|
| név | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswithwith |
| régió | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswithwith |
| leírás | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

Kihagyandó rekordok száma.
$top
 query

integer

int32

A visszaadandó rekordok száma.

Válaszok

Name Típus Description
200 OK

GatewayCollection

Az átjáró-entitások gyűjteményét sorolja fel.
Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

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": ""
}

Definíciók

Name Description
ErrorFieldContract

Hibamező-szerződés.
ErrorResponse

Hibaválasz.
GatewayCollection

Lapozott átjárólista ábrázolása.
GatewayContract

Átjáró adatai.
ResourceLocationDataContract

Erőforrás helyadatainak tulajdonságai.

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.
message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details

ErrorFieldContract[]

Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.
error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

GatewayCollection

Lapozott átjárólista ábrázolása.

Name Típus Description
count

integer

Összes rekordszám az összes oldalon.
nextLink

string

Ha van ilyen, a következő oldal hivatkozása.
value

GatewayContract[]

Oldalértékek.

GatewayContract

Átjáró adatai.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Az erőforrás neve
properties.description

string

Átjáró leírása
properties.locationData

ResourceLocationDataContract

Átjáró helye.
type

string

Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Erőforrás helyadatainak tulajdonságai.

Name Típus Description
city

string

Az a város vagy hely, ahol az erőforrás található.
countryOrRegion

string

Az az ország vagy régió, ahol az erőforrás található.
district

string

Az a körzet, állam vagy tartomány, ahol az erőforrás található.
name

string

A földrajzi vagy fizikai hely canonical neve.