@azure-rest/maps-geolocation package

Interfaces

CountryRegionOutput

Objet contenant les informations de pays/région.

ErrorAdditionalInfoOutput

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetailOutput

Détail de l’erreur.

ErrorResponseOutput

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

GeolocationGetLocation200Response

L’API Get IP To Location est une requête HTTP GET qui, en fonction d’une adresse IP, retourne le code de pays ISO à partir duquel se trouve cette adresse IP. Les développeurs peuvent utiliser ces informations pour bloquer ou modifier certains contenus en fonction des emplacements géographiques à partir duquel l’application est consultée.

GeolocationGetLocationDefaultResponse

L’API Get IP To Location est une requête HTTP GET qui, en fonction d’une adresse IP, retourne le code de pays ISO à partir duquel se trouve cette adresse IP. Les développeurs peuvent utiliser ces informations pour bloquer ou modifier certains contenus en fonction des emplacements géographiques à partir duquel l’application est consultée.

GeolocationGetLocationQueryParam
GeolocationGetLocationQueryParamProperties
GetLocation
IpAddressToLocationResultOutput

Cet objet est retourné à partir d’un appel réussi à l’adresse IP vers l’API pays/région

MapsGeolocationClientOptions

Paramètres facultatifs pour le client

Routes

Alias de type

GeolocationGetLocationParameters
MapsGeolocationClient

Functions

default(AzureKeyCredential, ClientOptions)

Crée une instance de MapsGeolocationClient à partir d’une clé d’abonnement.

exemple de

import { AzureKeyCredential } from "@azure/core-auth";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsGeolocation(credential);
default(TokenCredential, string, ClientOptions)

Crée une instance de MapsGeolocation à partir d’une TokenCredentiald’identité Azure.

exemple de

import { DefaultAzureCredential } from "@azure/identity";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new DefaultAzureCredential();
const client = MapsGeolocation(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Crée une instance de MapsGeolocation à partir d’une AzureSASCredentiald’identité Azure.

exemple de

import { AzureSASCredential } from "@azure/core-auth";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsGeolocation(credential);
isUnexpected(GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse)

Informations relatives à la fonction

default(AzureKeyCredential, ClientOptions)

Crée une instance de MapsGeolocationClient à partir d’une clé d’abonnement.

exemple de

import { AzureKeyCredential } from "@azure/core-auth";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsGeolocation(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsGeolocationClient

Paramètres

credential
AzureKeyCredential

Instance AzureKeyCredential utilisée pour authentifier les demandes auprès du service

options
ClientOptions

Options utilisées pour configurer le client de géolocalisation

Retours

default(TokenCredential, string, ClientOptions)

Crée une instance de MapsGeolocation à partir d’une TokenCredentiald’identité Azure.

exemple de

import { DefaultAzureCredential } from "@azure/identity";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new DefaultAzureCredential();
const client = MapsGeolocation(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsGeolocationClient

Paramètres

credential
TokenCredential

Instance TokenCredential utilisée pour authentifier les demandes auprès du service

mapsAccountClientId

string

ID client Azure Maps d’une ressource de carte spécifique

options
ClientOptions

Options utilisées pour configurer le client de routage

Retours

default(AzureSASCredential, ClientOptions)

Crée une instance de MapsGeolocation à partir d’une AzureSASCredentiald’identité Azure.

exemple de

import { AzureSASCredential } from "@azure/core-auth";
import MapsGeolocation from "@azure-rest/maps-geolocation";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsGeolocation(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsGeolocationClient

Paramètres

credential
AzureSASCredential

Instance AzureSASCredential utilisée pour authentifier les demandes auprès du service

options
ClientOptions

Options utilisées pour configurer le client de géolocalisation

Retours

isUnexpected(GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse)

function isUnexpected(response: GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse): response

Paramètres

Retours

response