Gateway - List By Service
Visar en samling gatewayer som registrerats med tjänstinstansen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways?api-version=2022-08-01
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
$filter
|
query |
string |
| Fält | Användning | Operatorer som stöds | Funktioner som stöds | |
|
$skip
|
query |
integer int32 |
Antal poster att hoppa över. |
|
$top
|
query |
integer int32 |
Antal poster som ska returneras. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Visar en samling gateway-entiteter. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
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 | personifiera ditt användarkonto |
Exempel
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
{
"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": ""
}
Definitioner
Name | Description |
---|---|
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Gateway |
Visning av växlingsgatewaylista. |
Gateway |
Gatewayinformation. |
Resource |
Egenskaper för resursplatsdata. |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
GatewayCollection
Visning av växlingsgatewaylista.
Name | Typ | Description |
---|---|---|
count |
integer |
Totalt antal poster på alla sidor. |
nextLink |
string |
Länk till nästa sida om det finns någon. |
value |
Sidvärden. |
GatewayContract
Gatewayinformation.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.description |
string |
Gatewaybeskrivning |
properties.locationData |
Gatewayplats. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
ResourceLocationDataContract
Egenskaper för resursplatsdata.
Name | Typ | Description |
---|---|---|
city |
string |
Orten eller platsen där resursen finns. |
countryOrRegion |
string |
Det land eller den region där resursen finns. |
district |
string |
Det distrikt, den delstat eller den provins där resursen finns. |
name |
string |
Ett kanoniskt namn för den geografiska eller fysiska platsen. |