Gateway - List By Service
Lista uma coleção de gateways registrados com a instância de serviço.
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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Regex pattern: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
$filter
|
query |
string |
| Campo | Uso | Operadores com suporte | Funções com suporte | |
|
$skip
|
query |
integer int32 |
Número de registros a serem ignorados. |
|
$top
|
query |
integer int32 |
Número de registros a serem retornados. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Lista uma coleção de entidades de Gateway. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
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": ""
}
Definições
Nome | Description |
---|---|
Error |
Contrato de Campo de Erro. |
Error |
Resposta de erro. |
Gateway |
Representação da lista de Gateway paginado. |
Gateway |
Detalhes do gateway. |
Resource |
Propriedades de dados do local do recurso. |
ErrorFieldContract
Contrato de Campo de Erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
GatewayCollection
Representação da lista de Gateway paginado.
Nome | Tipo | Description |
---|---|---|
count |
integer |
Número total de contagem de registros em todas as páginas. |
nextLink |
string |
Link da próxima página, se houver. |
value |
Valores de página. |
GatewayContract
Detalhes do gateway.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.description |
string |
Descrição do gateway |
properties.locationData |
Local do gateway. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ResourceLocationDataContract
Propriedades de dados do local do recurso.
Nome | Tipo | Description |
---|---|---|
city |
string |
A cidade ou localidade em que o recurso está localizado. |
countryOrRegion |
string |
O país ou a região em que o recurso está localizado. |
district |
string |
O distrito, estado ou província onde o recurso está localizado. |
name |
string |
Um nome canônico para a localização geográfica ou física. |