Api Gateway - List By Resource Group

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Liste todos os gateways de Gerenciamento de API em um grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApiManagementGatewayListResult	A lista de gateways de Gerenciamento de API.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListGatewaysBySubscriptionAndResourceGroup

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways?api-version=2024-05-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1",
      "name": "standard-gw-1",
      "type": "Microsoft.ApiManagement/gateways",
      "tags": {
        "owner": "v-aswmoh",
        "ReleaseName": "Z3"
      },
      "location": "West US",
      "etag": "AAAAAAAWN/4=",
      "properties": {
        "provisioningState": "Succeeded",
        "targetProvisioningState": "",
        "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
        "frontend": {
          "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net"
        },
        "backend": {
          "subnet": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
          }
        },
        "configurationApi": {
          "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net"
        }
      },
      "sku": {
        "name": "Standard",
        "capacity": 1
      },
      "systemData": {
        "createdBy": "bar@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-06-16T09:40:00.7106733Z",
        "lastModifiedBy": "foo@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-2",
      "name": "standard-gw-2",
      "type": "Microsoft.ApiManagement/gateways",
      "tags": {
        "Owner": "vitaliik"
      },
      "location": "East US",
      "etag": "AAAAAAAWKwo=",
      "properties": {
        "provisioningState": "Succeeded",
        "targetProvisioningState": "",
        "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
        "frontend": {
          "defaultHostname": "standard-gw-2.eastus.gateway.azure-api.net"
        },
        "backend": {
          "subnet": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn2/subnets/sn2"
          }
        },
        "configurationApi": {
          "hostname": "standard-gw-2.eastus.configuration.gateway.azure-api.net"
        }
      },
      "sku": {
        "name": "Standard",
        "capacity": 1
      }
    }
  ]
}

Definições

Nome	Description
ApiGatewaySkuType	Nome do Sku.
ApiManagementGatewayListResult	A resposta da operação de gateway de Gerenciamento de API de Lista.
ApiManagementGatewayResource	Um único recurso de gateway de Gerenciamento de API em Lista ou Obter resposta.
ApiManagementGatewaySkuProperties	Propriedades de SKU de recursos do gateway de Gerenciamento de API.
BackendConfiguration	Informações sobre como o gateway deve se integrar aos sistemas de back-end.
BackendSubnetConfiguration	Informações sobre como a sub-rede à qual o gateway deve ser injetado.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FrontendConfiguration	Informações sobre como o gateway deve ser exposto.
GatewayConfigurationApi	Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard.
systemData	Metadados relativos à criação e última modificação do recurso.
VirtualNetworkType	O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.

ApiGatewaySkuType

Enumeração

Nome do Sku.

Valor	Description
Standard	SKU padrão do gateway de API.
WorkspaceGatewayPremium	SKU Premium do gateway de API a ser usado em Workspaces.
WorkspaceGatewayStandard	SKU padrão do gateway de API a ser usado em workspaces.

ApiManagementGatewayListResult

Objeto

A resposta da operação de gateway de Gerenciamento de API de Lista.

Nome	Tipo	Description
nextLink	string	Link para o próximo conjunto de resultados. Não estará vazio se o Valor contiver uma lista incompleta dos serviços de Gerenciamento de API.
value	ApiManagementGatewayResource[]	Resultado da operação de gateway de Gerenciamento de API de Lista.

ApiManagementGatewayResource

Objeto

Um único recurso de gateway de Gerenciamento de API em Lista ou Obter resposta.

Nome	Tipo	Description
etag	string	ETag do recurso.
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.backend	BackendConfiguration	Informações sobre como o gateway deve se integrar aos sistemas de back-end.
properties.configurationApi	GatewayConfigurationApi	Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard.
properties.createdAtUtc	string (date-time)	Data utc de criação do gateway de Gerenciamento de API. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pelo padrão ISO 8601.
properties.frontend	FrontendConfiguration	Informações sobre como o gateway deve ser exposto.
properties.provisioningState	string	O estado de provisionamento atual do gateway de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Com Falha/Parado/Terminando/Terminação Com Falha/Excluído.
properties.targetProvisioningState	string	O estado de provisionamento do gateway de Gerenciamento de API, que é direcionado pela operação de execução prolongada iniciada no gateway.
properties.virtualNetworkType	VirtualNetworkType	O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.
sku	ApiManagementGatewaySkuProperties	Propriedades de SKU do gateway de Gerenciamento de API.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Marcas de recurso.
type	string	O tipo de recurso para o recurso de Gerenciamento de API é definido como Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Objeto

Propriedades de SKU de recursos do gateway de Gerenciamento de API.

Nome	Tipo	Description
capacity	integer (int32)	Capacidade do SKU (número de unidades implantadas da SKU)
name	ApiGatewaySkuType	Nome do Sku.

BackendConfiguration

Objeto

Informações sobre como o gateway deve se integrar aos sistemas de back-end.

Nome	Tipo	Description
subnet	BackendSubnetConfiguration	O nome do host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas.

BackendSubnetConfiguration

Objeto

Informações sobre como a sub-rede à qual o gateway deve ser injetado.

Nome	Tipo	Description
id	string	A ID do ARM da sub-rede na qual os sistemas de back-end estão hospedados.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FrontendConfiguration

Objeto

Informações sobre como o gateway deve ser exposto.

Nome	Tipo	Description
defaultHostname	string	O nome do host padrão do gateway do plano de dados para o qual as solicitações podem ser enviadas. Isso só é aplicável ao gateway de API com SKU Standard.

GatewayConfigurationApi

Objeto

Informações sobre a API de Configuração do gateway de Gerenciamento de API. Isso só é aplicável ao gateway de API com SKU Standard.

Nome	Tipo	Description
hostname	string	Nome do host ao qual o agente se conecta para propagar a configuração para a nuvem.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VirtualNetworkType

Enumeração

O tipo de VPN no qual o gateway de Gerenciamento de API precisa ser configurado.

Valor	Description
External	O gateway de Gerenciamento de API faz parte da Rede Virtual e pode ser acessado pela Internet.
Internal	O gateway de Gerenciamento de API faz parte da Rede Virtual e só pode ser acessado de dentro da rede virtual.
None	O gateway de Gerenciamento de API não faz parte de nenhuma Rede Virtual.

Compartilhar via

Api Gateway - List By Resource Group

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementListGatewaysBySubscriptionAndResourceGroup

Solicitação de exemplo

Resposta de exemplo

Definições

ApiGatewaySkuType

ApiManagementGatewayListResult

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType

Recursos adicionais