@azure-rest/maps-geolocation package

Schnittstellen

CountryRegionOutput

Das Objekt, das die Informationen zu Land/Region enthält.

ErrorAdditionalInfoOutput

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetailOutput

Das Fehlerdetails.

ErrorResponseOutput

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

GeolocationGetLocation200Response

Die Get IP To Location-API ist eine HTTP-GET Anforderung, die aufgrund einer IP-Adresse den ISO-Ländercode zurückgibt, aus dem sich diese IP-Adresse befindet. Entwickler können diese Informationen verwenden, um bestimmte Inhalte basierend auf geografischen Standorten zu blockieren oder zu ändern, von denen die Anwendung angezeigt wird.

GeolocationGetLocationDefaultResponse

Die Get IP To Location-API ist eine HTTP-GET Anforderung, die aufgrund einer IP-Adresse den ISO-Ländercode zurückgibt, aus dem sich diese IP-Adresse befindet. Entwickler können diese Informationen verwenden, um bestimmte Inhalte basierend auf geografischen Standorten zu blockieren oder zu ändern, von denen die Anwendung angezeigt wird.

GeolocationGetLocationQueryParam
GeolocationGetLocationQueryParamProperties
GetLocation
IpAddressToLocationResultOutput

Dieses Objekt wird von einem erfolgreichen Aufruf der IP-Adresse an die Länder-/Regions-API zurückgegeben.

MapsGeolocationClientOptions

Die optionalen Parameter für den Client

Routes

Typaliase

GeolocationGetLocationParameters
MapsGeolocationClient

Functions

default(AzureKeyCredential, ClientOptions)

Erstellt eine Instanz von MapsGeolocationClient aus einem Abonnementschlüssel.

Beispiel

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)

Erstellt eine Instanz von MapsGeolocation aus einer Azure Identity TokenCredential.

Beispiel

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)

Erstellt eine Instanz von MapsGeolocation aus einer Azure Identity AzureSASCredential.

Beispiel

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)

Details zur Funktion

default(AzureKeyCredential, ClientOptions)

Erstellt eine Instanz von MapsGeolocationClient aus einem Abonnementschlüssel.

Beispiel

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

Parameter

credential
AzureKeyCredential

Eine AzureKeyCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

options
ClientOptions

Optionen zum Konfigurieren des Geolocation-Clients

Gibt zurück

default(TokenCredential, string, ClientOptions)

Erstellt eine Instanz von MapsGeolocation aus einer Azure Identity TokenCredential.

Beispiel

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

Parameter

credential
TokenCredential

Eine TokenCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

mapsAccountClientId

string

Die Azure Maps-Client-ID einer bestimmten Kartenressource

options
ClientOptions

Optionen zum Konfigurieren des Routingclients

Gibt zurück

default(AzureSASCredential, ClientOptions)

Erstellt eine Instanz von MapsGeolocation aus einer Azure Identity AzureSASCredential.

Beispiel

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

Parameter

credential
AzureSASCredential

Eine AzureSASCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

options
ClientOptions

Optionen zum Konfigurieren des Geolocation-Clients

Gibt zurück

isUnexpected(GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse)

function isUnexpected(response: GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse): response

Parameter

Gibt zurück

response