Gateway - List By Service
Mencantumkan kumpulan gateway yang terdaftar dengan instans layanan.
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
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
service
|
path | True |
string |
Nama layanan API Management. Regex pattern: |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
$filter
|
query |
string |
| Bidang | Penggunaan | Operator yang didukung | Fungsi yang didukung | |
|
$skip
|
query |
integer int32 |
Jumlah rekaman yang akan dilewati. |
|
$top
|
query |
integer int32 |
Jumlah rekaman yang akan dikembalikan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Mencantumkan kumpulan entitas Gateway. |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
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": ""
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Kontrak Bidang Kesalahan. |
Error |
Respons Kesalahan. |
Gateway |
Representasi daftar Paged Gateway. |
Gateway |
Detail gateway. |
Resource |
Properti data lokasi sumber daya. |
ErrorFieldContract
Kontrak Bidang Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan tingkat properti. |
message |
string |
Representasi kesalahan tingkat properti yang dapat dibaca manusia. |
target |
string |
Nama properti. |
ErrorResponse
Respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error.code |
string |
Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons. |
error.details |
Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi. |
|
error.message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
GatewayCollection
Representasi daftar Paged Gateway.
Nama | Jenis | Deskripsi |
---|---|---|
count |
integer |
Jumlah jumlah rekaman total di semua halaman. |
nextLink |
string |
Tautan halaman berikutnya jika ada. |
value |
Nilai halaman. |
GatewayContract
Detail gateway.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nama sumber daya. |
properties.description |
string |
Deskripsi gateway |
properties.locationData |
Lokasi gateway. |
|
type |
string |
Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
ResourceLocationDataContract
Properti data lokasi sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
city |
string |
Kota atau lokalitas tempat sumber daya berada. |
countryOrRegion |
string |
Negara atau wilayah tempat sumber daya berada. |
district |
string |
Kabupaten, negara bagian, atau provinsi tempat sumber daya berada. |
name |
string |
Nama kanonis untuk lokasi geografis atau fisik. |