@azure-rest/maps-geolocation package

インターフェイス

CountryRegionOutput

国/地域情報を含むオブジェクト。

ErrorAdditionalInfoOutput

リソース管理エラーの追加情報。

ErrorDetailOutput

エラーの詳細。

ErrorResponseOutput

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

GeolocationGetLocation200Response

Get IP To Location API は、IP アドレスを指定すると、その IP アドレスが存在する ISO 国コードを返す HTTP GET 要求です。 開発者は、この情報を使用して、アプリケーションの表示元の地理的な場所に基づいて特定のコンテンツをブロックまたは変更できます。

GeolocationGetLocationDefaultResponse

Get IP To Location API は、IP アドレスを指定すると、その IP アドレスが存在する ISO 国コードを返す HTTP GET 要求です。 開発者は、この情報を使用して、アプリケーションの表示元の地理的な場所に基づいて特定のコンテンツをブロックまたは変更できます。

GeolocationGetLocationQueryParam
GeolocationGetLocationQueryParamProperties
GetLocation
IpAddressToLocationResultOutput

このオブジェクトは、国/リージョン API への IP アドレスの正常な呼び出しから返されます

MapsGeolocationClientOptions

クライアントの省略可能なパラメーター

Routes

型エイリアス

GeolocationGetLocationParameters
MapsGeolocationClient

関数

default(AzureKeyCredential, ClientOptions)

サブスクリプション キーから MapsGeolocationClient のインスタンスを作成します。

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)

Azure ID TokenCredentialから MapsGeolocation のインスタンスを作成します。

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)

Azure ID AzureSASCredentialから MapsGeolocation のインスタンスを作成します。

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)

関数の詳細

default(AzureKeyCredential, ClientOptions)

サブスクリプション キーから MapsGeolocationClient のインスタンスを作成します。

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

パラメーター

credential
AzureKeyCredential

サービスへの要求を認証するために使用される AzureKeyCredential インスタンス

options
ClientOptions

位置情報クライアントの構成に使用するオプション

戻り値

default(TokenCredential, string, ClientOptions)

Azure ID TokenCredentialから MapsGeolocation のインスタンスを作成します。

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

パラメーター

credential
TokenCredential

サービスへの要求を認証するために使用される TokenCredential インスタンス

mapsAccountClientId

string

特定のマップ リソースの Azure Maps クライアント ID

options
ClientOptions

ルート クライアントの構成に使用されるオプション

戻り値

default(AzureSASCredential, ClientOptions)

Azure ID AzureSASCredentialから MapsGeolocation のインスタンスを作成します。

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

パラメーター

credential
AzureSASCredential

サービスへの要求を認証するために使用される AzureSASCredential インスタンス

options
ClientOptions

位置情報クライアントの構成に使用するオプション

戻り値

isUnexpected(GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse)

function isUnexpected(response: GeolocationGetLocation200Response | GeolocationGetLocationDefaultResponse): response

パラメーター

戻り値

response