Share via

Gateway - List By Service

  • Referência
Service:
API Management
API Version:
2022-08-01

Lista uma coleção de gateways registados na 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
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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName
 path True

string

O nome do serviço Gestão de API.

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

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar para esta operação.
$filter
 query

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| nome | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| região | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, começacom, termina com |
| description | filtro | ge, le, eq, ne, gt, lt | subcadeia de, contém, startswith, endswith |
$skip
 query

integer

int32

Número de registos a ignorar.
$top
 query

integer

int32

Número de registos a devolver.

Respostas

Name Tipo Description
200 OK

GatewayCollection

Lista uma coleção de entidades de Gateway.
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual 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

Name Description
user_impersonation representar a sua conta de utilizador

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

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

Definições

Name Description
ErrorFieldContract

Contrato de Campo de Erro.
ErrorResponse

Resposta do Erro.
GatewayCollection

Representação da lista de Gateway paginado.
GatewayContract

Detalhes do gateway.
ResourceLocationDataContract

Propriedades de dados de localização de recursos.

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

Código de erro de nível de propriedade.
message

string

Representação legível por humanos do erro ao nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados no pedido, em caso de erro de validação.
error.message

string

Representação legível por humanos do erro.

GatewayCollection

Representação da lista de Gateway paginado.

Name Tipo Description
count

integer

Número total de contagem de registos em todas as páginas.
nextLink

string

Ligação da página seguinte, se existir.
value

GatewayContract[]

Valores de página.

GatewayContract

Detalhes do gateway.

Name Tipo Description
id

string

ID de recurso completamente qualificado 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

ResourceLocationDataContract

Localização do gateway.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Propriedades de dados de localização de recursos.

Name Tipo Description
city

string

A cidade ou localidade onde o recurso está localizado.
countryOrRegion

string

O país ou região onde o recurso está localizado.
district

string

O distrito, o estado ou a província onde o recurso está localizado.
name

string

Um nome canónico para a localização geográfica ou física.