Gateway - Get

Obtient les détails de la passerelle spécifiée par son identificateur.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2020-12-01

Paramètres URI

Name In Required Type Description
gatewayId
path True
  • string

Identificateur d’entité de la passerelle. Doit être unique dans l’instance actuelle du service gestion des API. Ne doit pas avoir la valeur’Managed'

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service gestion des API.

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

subscriptionId
path True
  • string

informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

Réponses

Name Type Description
200 OK

Le corps de la réponse contient l’entité de passerelle spécifiée.

Headers

  • ETag: string
Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

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 emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGetGateway

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2020-12-01

Sample Response

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

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GatewayContract

Détails de la passerelle.

ResourceLocationDataContract

Propriétés des données de l’emplacement de la ressource.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

La liste des champs non valides est envoyée dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

GatewayContract

Détails de la passerelle.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.description
  • string

Description de la passerelle

properties.locationData

Emplacement de la passerelle.

type
  • string

Type de ressource pour la ressource gestion des API.

ResourceLocationDataContract

Propriétés des données de l’emplacement de la ressource.

Name Type Description
city
  • string

Ville ou localité dans laquelle se trouve la ressource.

countryOrRegion
  • string

Le pays ou la région où se trouve la ressource.

district
  • string

District, État ou province où se trouve la ressource.

name
  • string

Nom canonique pour l’emplacement géographique ou physique.