خدمة Microsoft.ApiManagement/apis 2021-08-01

  • مقالة

تعريف مورد Bicep

يمكن توزيع نوع مورد الخدمة/apis مع العمليات التي تستهدف:

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis، أضف Bicep التالي إلى القالب الخاص بك.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

قيم Property

الخدمة/apis

الاسم الوصف القيمة
الاسم اسم المورد

تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في Bicep.		 سلسلة (مطلوبة)

حد الأحرف: 1-80

الأحرف الصالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
أصل في Bicep، يمكنك تحديد المورد الأصل لمورد تابع. تحتاج فقط إلى إضافة هذه الخاصية عند الإعلان عن المورد التابع خارج المورد الأصل.

لمزيد من المعلومات، راجع المورد التابع خارج المورد الأصل.		 اسم رمزي للمورد من النوع: الخدمة
خصائص إنشاء كيان واجهة برمجة التطبيقات لخصائص التحديث. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

الاسم الوصف القيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير قيمة، يتم إنشاء المراجعة الافتراضية 1 سلسلة
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. سلسلة
apiType نوع واجهة برمجة التطبيقات المراد إنشاؤها.
* http إنشاء واجهة برمجة تطبيقات REST
* soap إنشاء واجهة برمجة تطبيقات SOAP التمريرية
* websocket إنشاء واجهة برمجة تطبيقات websocket
* graphql ينشئ واجهة برمجة تطبيقات GraphQL.		 "graphql"
'http'
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات سلسلة
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. سلسلة
apiVersionSet تفاصيل مجموعة الإصدار ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. سلسلة
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
الوصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم واجهة برمجة التطبيقات. يجب أن يتراوح طوله من 1 إلى 300 حرف. سلسلة
التنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. 'graphql-link'
"openapi"
'openapi+json'
'openapi+json-link'
"openapi-link"
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. Bool
الترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار تحديد عنوان URL نسبي متميز لتعريف واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة API Management. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية واجهة برمجة التطبيقات المحددة أثناء إنشاء مثيل الخدمة لإنشاء عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوبة)
البروتوكولات توضح هذه المقالة البروتوكولات التي يمكن استدعاء العمليات من خلالها في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
'http'
'https'
'ws'
'wss'
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تقوم بتنفيذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. سلسلة
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. سلسلة
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
subscriptionRequired يحدد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. Bool
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. سلسلة
النوع نوع واجهة برمجة التطبيقات. "graphql"
'http'
"صابون"
"websocket"
القيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. سلسلة
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

الاسم الوصف القيمة
الوصف وصف مجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
المعرف معرف مجموعة إصدارات واجهة برمجة التطبيقات الموجودة. حذف هذه القيمة لإنشاء مجموعة إصدارات جديدة. سلسلة
الاسم اسم العرض لمجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
versionHeaderName اسم معلمة رأس HTTP التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى header. سلسلة
versioningScheme قيمة تحدد مكان وجود معرف إصدار واجهة برمجة التطبيقات في طلب HTTP. "الرأس"
"استعلام"
"مقطع"
versionQueryName اسم معلمة الاستعلام التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى query. سلسلة

AuthenticationSettingsContract

الاسم الوصف القيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
مفتوح إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

الاسم الوصف القيمة
معرف خادم التخويل معرف خادم تخويل OAuth. سلسلة
النطاق نطاق العمليات. سلسلة

OpenIdAuthenticationSettingsContract

الاسم الوصف القيمة
bearerTokenSendingMethods كيفية إرسال الرمز المميز إلى الخادم. صفيف سلسلة يحتوي على أي من:
"عنوان التخويل"
"استعلام"
openidProviderId معرف خادم تخويل OAuth. سلسلة

ApiContactInformation

الاسم الوصف القيمة
البريد الإلكتروني عنوان البريد الإلكتروني الخاص بجهة الاتصال/المؤسسة. يجب أن يكون بتنسيق عنوان بريد إلكتروني سلسلة
الاسم اسم تعريف جهة الاتصال/المؤسسة سلسلة
عنوان url عنوان URL الذي يشير إلى معلومات جهة الاتصال. يجب أن يكون بتنسيق عنوان URL سلسلة

ApiLicenseInformation

الاسم الوصف القيمة
الاسم اسم الترخيص المستخدم لواجهة برمجة التطبيقات سلسلة
عنوان url عنوان URL للترخيص المستخدم لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL سلسلة

SubscriptionKeyParameterNamesContract

الاسم الوصف القيمة
العنوان اسم عنوان مفتاح الاشتراك. سلسلة
استعلام اسم معلمة سلسلة استعلام مفتاح الاشتراك. سلسلة

ApiCreateOrUpdatePropertiesWsdlSelector

الاسم الوصف القيمة
wsdlEndpointName اسم نقطة النهاية (المنفذ) المراد استيرادها من WSDL سلسلة
wsdlServiceName اسم الخدمة المراد استيرادها من WSDL سلسلة

قوالب التشغيل السريع

تنشر قوالب التشغيل السريع التالية نوع المورد هذا.

قالب الوصف
إنشاء مثيل APIM وجميع الموارد الفرعية باستخدام القالب

نشر في Azure		 يوضح هذا القالب كيفية إنشاء خدمة APIM وتكوين الكيانات الفرعية
إنشاء Azure Front Door أمام إدارة واجهة برمجة تطبيقات Azure

نشر في Azure		 يوضح هذا النموذج كيفية استخدام Azure Front Door كموازن تحميل عمومي أمام Azure API Management.

تعريف مورد قالب ARM

يمكن توزيع نوع مورد الخدمة/apis مع العمليات التي تستهدف:

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis، أضف JSON التالي إلى القالب الخاص بك.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

قيم Property

الخدمة/apis

الاسم الوصف القيمة
النوع نوع المورد 'Microsoft.ApiManagement/service/apis'
apiVersion إصدار واجهة برمجة تطبيقات المورد '2021-08-01'
الاسم اسم المورد

تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في قوالب JSON ARM.		 سلسلة (مطلوبة)

حد الأحرف: 1-80

الأحرف الصالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
خصائص إنشاء كيان واجهة برمجة التطبيقات لخصائص التحديث. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

الاسم الوصف القيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير قيمة، يتم إنشاء المراجعة الافتراضية 1 سلسلة
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. سلسلة
apiType نوع واجهة برمجة التطبيقات المراد إنشاؤها.
* http إنشاء واجهة برمجة تطبيقات REST
* soap إنشاء واجهة برمجة تطبيقات مرور SOAP
* websocket إنشاء واجهة برمجة تطبيقات websocket
* graphql ينشئ واجهة برمجة تطبيقات GraphQL.		 "graphql"
'http'
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات سلسلة
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. سلسلة
apiVersionSet تفاصيل مجموعة الإصدارات ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. سلسلة
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
الوصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم واجهة برمجة التطبيقات. يجب أن يكون طوله من 1 إلى 300 حرف. سلسلة
التنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. 'graphql-link'
"openapi"
'openapi+json'
"openapi+json-link"
"openapi-link"
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. Bool
الترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار تحديد عنوان URL نسبي متميز لتعريف واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة API Management. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية واجهة برمجة التطبيقات المحددة أثناء إنشاء مثيل الخدمة لإنشاء عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوب)
البروتوكولات توضح هذه المقالة البروتوكولات التي يمكن استدعاء العمليات من خلالها في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
'http'
'https'
'ws'
'wss'
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تقوم بتنفيذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. سلسلة
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. سلسلة
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
subscriptionRequired يحدد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. Bool
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. سلسلة
النوع نوع واجهة برمجة التطبيقات. "graphql"
'http'
"صابون"
"websocket"
القيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. سلسلة
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

الاسم الوصف القيمة
الوصف وصف مجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
المعرف معرف مجموعة إصدارات واجهة برمجة التطبيقات الموجودة. حذف هذه القيمة لإنشاء مجموعة إصدارات جديدة. سلسلة
الاسم اسم العرض لمجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
versionHeaderName اسم معلمة رأس HTTP التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى header. سلسلة
versioningScheme قيمة تحدد مكان وجود معرف إصدار واجهة برمجة التطبيقات في طلب HTTP. "الرأس"
"استعلام"
"مقطع"
versionQueryName اسم معلمة الاستعلام التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى query. سلسلة

AuthenticationSettingsContract

الاسم الوصف القيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
مفتوح إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

الاسم الوصف القيمة
معرف خادم التخويل معرف خادم تخويل OAuth. سلسلة
النطاق نطاق العمليات. سلسلة

OpenIdAuthenticationSettingsContract

الاسم الوصف القيمة
bearerTokenSendingMethods كيفية إرسال الرمز المميز إلى الخادم. صفيف سلسلة يحتوي على أي من:
"عنوان التخويل"
"استعلام"
openidProviderId معرف خادم تخويل OAuth. سلسلة

ApiContactInformation

الاسم الوصف القيمة
البريد الإلكتروني عنوان البريد الإلكتروني الخاص بجهة الاتصال/المؤسسة. يجب أن يكون بتنسيق عنوان بريد إلكتروني سلسلة
الاسم اسم تعريف جهة الاتصال/المؤسسة سلسلة
عنوان url عنوان URL الذي يشير إلى معلومات جهة الاتصال. يجب أن يكون بتنسيق عنوان URL سلسلة

ApiLicenseInformation

الاسم الوصف القيمة
الاسم اسم الترخيص المستخدم لواجهة برمجة التطبيقات سلسلة
عنوان url عنوان URL للترخيص المستخدم لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL سلسلة

SubscriptionKeyParameterNamesContract

الاسم الوصف القيمة
العنوان اسم عنوان مفتاح الاشتراك. سلسلة
استعلام اسم معلمة سلسلة استعلام مفتاح الاشتراك. سلسلة

ApiCreateOrUpdatePropertiesWsdlSelector

الاسم الوصف القيمة
wsdlEndpointName اسم نقطة النهاية (المنفذ) المراد استيرادها من WSDL سلسلة
wsdlServiceName اسم الخدمة المراد استيرادها من WSDL سلسلة

قوالب التشغيل السريع

تنشر قوالب التشغيل السريع التالية نوع المورد هذا.

قالب الوصف
إنشاء مثيل APIM وجميع الموارد الفرعية باستخدام القالب

نشر في Azure		 يوضح هذا القالب كيفية إنشاء خدمة APIM وتكوين الكيانات الفرعية
إنشاء Azure Front Door أمام إدارة واجهة برمجة تطبيقات Azure

نشر في Azure		 يوضح هذا النموذج كيفية استخدام Azure Front Door كموازن تحميل عمومي أمام Azure API Management.

تعريف مورد Terraform (موفر AzAPI)

يمكن توزيع نوع مورد الخدمة/apis مع العمليات التي تستهدف:

  • مجموعات الموارد

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis، أضف Terraform التالي إلى القالب الخاص بك.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

قيم Property

الخدمة/apis

الاسم الوصف القيمة
النوع نوع المورد "Microsoft.ApiManagement/service/apis@2021-08-01"
الاسم اسم المورد سلسلة (مطلوبة)

حد الأحرف: 1-80

الأحرف الصالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
parent_id معرف المورد الأصل لهذا المورد. معرف المورد من النوع: الخدمة
خصائص إنشاء كيان واجهة برمجة التطبيقات لخصائص التحديث. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

الاسم الوصف القيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير قيمة، يتم إنشاء المراجعة الافتراضية 1 سلسلة
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. سلسلة
apiType نوع واجهة برمجة التطبيقات المراد إنشاؤها.
* http إنشاء واجهة برمجة تطبيقات REST
* soap إنشاء واجهة برمجة تطبيقات SOAP التمريرية
* websocket إنشاء واجهة برمجة تطبيقات websocket
* graphql ينشئ واجهة برمجة تطبيقات GraphQL.		 "graphql"
"http"
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات سلسلة
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. سلسلة
apiVersionSet تفاصيل مجموعة الإصدار ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. سلسلة
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
الوصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم واجهة برمجة التطبيقات. يجب أن يتراوح طوله من 1 إلى 300 حرف. سلسلة
التنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. "graphql-link"
"openapi"
"openapi+json"
"openapi+json-link"
"openapi-link"
"swagger-json"
"swagger-link-json"
"wadl-link-json"
"wadl-xml"
"wsdl"
"wsdl-link"
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. Bool
الترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار تحديد عنوان URL نسبي متميز لتعريف واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة API Management. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية واجهة برمجة التطبيقات المحددة أثناء إنشاء مثيل الخدمة لإنشاء عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوبة)
البروتوكولات توضح هذه المقالة البروتوكولات التي يمكن استدعاء العمليات من خلالها في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
"http"
"https"
"ws"
"wss"
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تقوم بتنفيذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. سلسلة
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. سلسلة
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
subscriptionRequired يحدد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. Bool
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. سلسلة
النوع نوع واجهة برمجة التطبيقات. "graphql"
"http"
"صابون"
"websocket"
القيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. سلسلة
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

الاسم الوصف القيمة
الوصف وصف مجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
المعرف معرف مجموعة إصدارات واجهة برمجة التطبيقات الموجودة. حذف هذه القيمة لإنشاء مجموعة إصدارات جديدة. سلسلة
الاسم اسم العرض لمجموعة إصدارات واجهة برمجة التطبيقات. سلسلة
versionHeaderName اسم معلمة رأس HTTP التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى header. سلسلة
versioningScheme قيمة تحدد مكان وجود معرف إصدار واجهة برمجة التطبيقات في طلب HTTP. "الرأس"
"استعلام"
"مقطع"
versionQueryName اسم معلمة الاستعلام التي تشير إلى إصدار واجهة برمجة التطبيقات إذا تم تعيين versioningScheme إلى query. سلسلة

AuthenticationSettingsContract

الاسم الوصف القيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
مفتوح إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

الاسم الوصف القيمة
معرف خادم التخويل معرف خادم تخويل OAuth. سلسلة
النطاق نطاق العمليات. سلسلة

OpenIdAuthenticationSettingsContract

الاسم الوصف القيمة
bearerTokenSendingMethods كيفية إرسال الرمز المميز إلى الخادم. صفيف سلسلة يحتوي على أي من:
"عنوان التخويل"
"استعلام"
openidProviderId معرف خادم تخويل OAuth. سلسلة

ApiContactInformation

الاسم الوصف القيمة
البريد الإلكتروني عنوان البريد الإلكتروني الخاص بجهة الاتصال/المؤسسة. يجب أن يكون بتنسيق عنوان بريد إلكتروني سلسلة
الاسم اسم تعريف جهة الاتصال/المؤسسة سلسلة
عنوان url عنوان URL الذي يشير إلى معلومات جهة الاتصال. يجب أن يكون بتنسيق عنوان URL سلسلة

ApiLicenseInformation

الاسم الوصف القيمة
الاسم اسم الترخيص المستخدم لواجهة برمجة التطبيقات سلسلة
عنوان url عنوان URL للترخيص المستخدم لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL سلسلة

SubscriptionKeyParameterNamesContract

الاسم الوصف القيمة
العنوان اسم عنوان مفتاح الاشتراك. سلسلة
استعلام اسم معلمة سلسلة استعلام مفتاح الاشتراك. سلسلة

ApiCreateOrUpdatePropertiesWsdlSelector

الاسم الوصف القيمة
wsdlEndpointName اسم نقطة النهاية (المنفذ) المراد استيرادها من WSDL سلسلة
wsdlServiceName اسم الخدمة المراد استيرادها من WSDL سلسلة