Share via

@azure-rest/maps-geolocation package

Interfaces

CountryRegionOutput

The object containing the country/region information.
ErrorAdditionalInfoOutput

The resource management error additional info.
ErrorDetailOutput

The error detail.
ErrorResponseOutput

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
GeolocationGetLocation200Response

The Get IP To Location API is an HTTP GET request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.
GeolocationGetLocationDefaultResponse

The Get IP To Location API is an HTTP GET request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.
GeolocationGetLocationQueryParam
GeolocationGetLocationQueryParamProperties
GetLocation
IpAddressToLocationResultOutput

This object is returned from a successful call to IP Address to country/region API
MapsGeolocationClientOptions

The optional parameters for the client
Routes

Type Aliases

GeolocationGetLocationParameters
MapsGeolocationClient

Functions

default(AzureKeyCredential, ClientOptions)

Creates an instance of MapsGeolocationClient from a subscription key.

Example

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)

Creates an instance of MapsGeolocation from an Azure Identity TokenCredential.

Example

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)

Creates an instance of MapsGeolocation from an Azure Identity AzureSASCredential.

Example

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)

Function Details

default(AzureKeyCredential, ClientOptions)

Creates an instance of MapsGeolocationClient from a subscription key.

Example

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

Parameters

credential
AzureKeyCredential

An AzureKeyCredential instance used to authenticate requests to the service

options
ClientOptions

Options used to configure the Geolocation Client

Returns

MapsGeolocationClient

default(TokenCredential, string, ClientOptions)

Creates an instance of MapsGeolocation from an Azure Identity TokenCredential.

Example

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

Parameters

credential
TokenCredential

An TokenCredential instance used to authenticate requests to the service

mapsAccountClientId

string

The Azure Maps client id of a specific map resource

options
ClientOptions

Options used to configure the Route Client

Returns

MapsGeolocationClient

default(AzureSASCredential, ClientOptions)

Creates an instance of MapsGeolocation from an Azure Identity AzureSASCredential.

Example

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

Parameters

credential
AzureSASCredential

An AzureSASCredential instance used to authenticate requests to the service

options
ClientOptions

Options used to configure the Geolocation Client

Returns

MapsGeolocationClient

isUnexpected(GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse) 

function isUnexpected(response: GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse): response

Parameters

response

GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse

Returns

response