@azure-rest/maps-geolocation package

الواجهات

CountryRegionOutput

الكائن الذي يحتوي على معلومات البلد/المنطقة.

ErrorAdditionalInfoOutput

خطأ إدارة الموارد معلومات إضافية.

ErrorDetailOutput

تفاصيل الخطأ.

ErrorResponseOutput

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة. (يتبع هذا أيضا تنسيق استجابة خطأ OData.).

GeolocationGetLocation200Response

واجهة برمجة تطبيقات Get IP To Location هي طلب GET HTTP الذي، بالنظر إلى عنوان IP، يقوم بإرجاع رمز بلد ISO الذي يوجد منه عنوان IP هذا. يمكن للمطورين استخدام هذه المعلومات لحظر محتوى معين أو تغييره استنادا إلى المواقع الجغرافية التي يتم عرض التطبيق منها.

GeolocationGetLocationDefaultResponse

واجهة برمجة تطبيقات Get IP To Location هي طلب GET HTTP الذي، بالنظر إلى عنوان IP، يقوم بإرجاع رمز بلد ISO الذي يوجد منه عنوان IP هذا. يمكن للمطورين استخدام هذه المعلومات لحظر محتوى معين أو تغييره استنادا إلى المواقع الجغرافية التي يتم عرض التطبيق منها.

GeolocationGetLocationQueryParam
GeolocationGetLocationQueryParamProperties
GetLocation
IpAddressToLocationResultOutput

يتم إرجاع هذا الكائن من استدعاء ناجح لعنوان 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)

إنشاء مثيل MapsGeolocation من Azure Identity TokenCredential.

المثال

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)

إنشاء مثيل MapsGeolocation من Azure Identity AzureSASCredential.

المثال

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)

إنشاء مثيل MapsGeolocation من Azure Identity TokenCredential.

المثال

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 لمورد خريطة معين

options
ClientOptions

الخيارات المستخدمة لتكوين عميل المسار

المرتجعات

default(AzureSASCredential, ClientOptions)

إنشاء مثيل MapsGeolocation من Azure Identity AzureSASCredential.

المثال

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