مشاركة عبر

Microsoft.ApiManagement service/apis

  • مقالة

تعريف مورد Bicep

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

  • مجموعات الموارد - راجع أوامر نشر مجموعة الموارد

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

تنسيق المورد

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-09-01-preview' = {
  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'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          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'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

قيم الخصائص

الخدمة/واجهة برمجة التطبيقات

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

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

حد الحرف: 1-80

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

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

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

اسم وصف قيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير أي قيمة، يتم إنشاء المراجعة الافتراضية 1 خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 100
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
نوع واجهة برمجة التطبيقات نوع واجهة برمجة التطبيقات التي يجب إنشاؤها.
* http بإنشاء واجهة برمجة تطبيقات REST
* soap بإنشاء واجهة برمجة تطبيقات مرور SOAP
* websocket بإنشاء واجهة برمجة تطبيقات websocket
ينشئ * graphql واجهة برمجة تطبيقات GraphQL.
يمكن إضافة أنواع جديدة في المستقبل.		 'graphql'
'grpc'
'http'
"odata"
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات خيط

القيود:
الحد الأقصى للطول = 100
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
apiVersionSet تفاصيل مجموعة الإصدارات ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. خيط
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
وصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. خيط
اسم العرض اسم واجهة برمجة التطبيقات. يجب أن يكون طوله من 1 إلى 300 حرف. خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 300
تنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. يمكن إضافة تنسيقات جديدة في المستقبل 'graphql-link'
'grpc'
'grpc-link'
"odata"
"odata-link"
"openapi"
'openapi+json'
'openapi+json-link'
"openapi-link"
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. قيمة منطقية
ترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار يحدد URL النسبي بشكل فريد واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة APIM. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية API المحدد أثناء إنشاء مثيل الخدمة لتشكيل عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوب)

القيود:
الحد الأقصى للطول = 400
البروتوكولات يصف البروتوكولات التي يمكن استدعاء العمليات في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
'http'
'https'
'ws'
'wss'
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تنفذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. خيط

القيود:
الحد الأقصى للطول = 2000
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. خيط
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
الاشتراك مطلوبة تحديد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. قيمة منطقية
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. خيط
معلمات طلب الترجمة استراتيجية ترجمة معلمات الاستعلام المطلوبة إلى معلمات القالب. بشكل افتراضي لها قيمة "قالب". القيم المحتملة: "قالب"، "استعلام" "استعلام"
"قالب"
نوع نوع واجهة برمجة التطبيقات. 'graphql'
'grpc'
'http'
"odata"
"صابون"
"websocket"
قيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. خيط
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

اسم وصف قيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings مجموعة من إعدادات مصادقة OAuth2 المضمنة في واجهة برمجة التطبيقات هذه. OAuth2AuthenticationSettingsContract[]
openid إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings مجموعة من إعدادات مصادقة Open ID Connect المضمنة في واجهة برمجة التطبيقات هذه. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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

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

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

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

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

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

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

  • مجموعات الموارد - راجع أوامر نشر مجموعة الموارد

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

تنسيق المورد

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-09-01-preview",
  "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"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "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",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

قيم الخصائص

الخدمة/واجهة برمجة التطبيقات

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

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

حد الحرف: 1-80

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

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

اسم وصف قيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير أي قيمة، يتم إنشاء المراجعة الافتراضية 1 خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 100
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
نوع واجهة برمجة التطبيقات نوع واجهة برمجة التطبيقات التي يجب إنشاؤها.
* http بإنشاء واجهة برمجة تطبيقات REST
* soap بإنشاء واجهة برمجة تطبيقات مرور SOAP
* websocket بإنشاء واجهة برمجة تطبيقات websocket
ينشئ * graphql واجهة برمجة تطبيقات GraphQL.
يمكن إضافة أنواع جديدة في المستقبل.		 'graphql'
'grpc'
'http'
"odata"
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات خيط

القيود:
الحد الأقصى للطول = 100
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
apiVersionSet تفاصيل مجموعة الإصدارات ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. خيط
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
وصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. خيط
اسم العرض اسم واجهة برمجة التطبيقات. يجب أن يكون طوله من 1 إلى 300 حرف. خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 300
تنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. يمكن إضافة تنسيقات جديدة في المستقبل 'graphql-link'
'grpc'
'grpc-link'
"odata"
"odata-link"
"openapi"
'openapi+json'
'openapi+json-link'
"openapi-link"
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. قيمة منطقية
ترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار يحدد URL النسبي بشكل فريد واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة APIM. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية API المحدد أثناء إنشاء مثيل الخدمة لتشكيل عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوب)

القيود:
الحد الأقصى للطول = 400
البروتوكولات يصف البروتوكولات التي يمكن استدعاء العمليات في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
'http'
'https'
'ws'
'wss'
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تنفذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. خيط

القيود:
الحد الأقصى للطول = 2000
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. خيط
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
الاشتراك مطلوبة تحديد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. قيمة منطقية
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. خيط
معلمات طلب الترجمة استراتيجية ترجمة معلمات الاستعلام المطلوبة إلى معلمات القالب. بشكل افتراضي لها قيمة "قالب". القيم المحتملة: "قالب"، "استعلام" "استعلام"
"قالب"
نوع نوع واجهة برمجة التطبيقات. 'graphql'
'grpc'
'http'
"odata"
"صابون"
"websocket"
قيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. خيط
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

اسم وصف قيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings مجموعة من إعدادات مصادقة OAuth2 المضمنة في واجهة برمجة التطبيقات هذه. OAuth2AuthenticationSettingsContract[]
openid إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings مجموعة من إعدادات مصادقة Open ID Connect المضمنة في واجهة برمجة التطبيقات هذه. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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

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

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

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

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

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

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

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

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

تنسيق المورد

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
  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"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            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"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

قيم الخصائص

الخدمة/واجهة برمجة التطبيقات

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

حد الحرف: 1-80

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

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

اسم وصف قيمة
apiRevision يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير أي قيمة، يتم إنشاء المراجعة الافتراضية 1 خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 100
apiRevisionDescription وصف مراجعة واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
نوع واجهة برمجة التطبيقات نوع واجهة برمجة التطبيقات التي يجب إنشاؤها.
* http بإنشاء واجهة برمجة تطبيقات REST
* soap بإنشاء واجهة برمجة تطبيقات مرور SOAP
* websocket بإنشاء واجهة برمجة تطبيقات websocket
ينشئ * graphql واجهة برمجة تطبيقات GraphQL.
يمكن إضافة أنواع جديدة في المستقبل.		 "graphql"
"grpc"
"http"
"odata"
"صابون"
"websocket"
apiVersion يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات خيط

القيود:
الحد الأقصى للطول = 100
apiVersionDescription وصف إصدار واجهة برمجة التطبيقات. خيط

القيود:
الحد الأقصى للطول = 256
apiVersionSet تفاصيل مجموعة الإصدارات ApiVersionSetContractDetails
apiVersionSetId معرف مورد ل ApiVersionSet ذات الصلة. خيط
إعدادات المصادقة مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه. AuthenticationSettingsContract
الاتصال معلومات الاتصال لواجهة برمجة التطبيقات. ApiContactInformation
وصف وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML. خيط
اسم العرض اسم واجهة برمجة التطبيقات. يجب أن يكون طوله من 1 إلى 300 حرف. خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 300
تنسيق تنسيق المحتوى الذي يتم استيراد واجهة برمجة التطبيقات فيه. يمكن إضافة تنسيقات جديدة في المستقبل "graphql-link"
"grpc"
"grpc-link"
"odata"
"odata-link"
"openapi"
"openapi+json"
"openapi+json-link"
"openapi-link"
"swagger-json"
"swagger-link-json"
"wadl-link-json"
"wadl-xml"
"wsdl"
"wsdl-link"
isCurrent يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية. قيمة منطقية
ترخيص معلومات الترخيص لواجهة برمجة التطبيقات. ApiLicenseInformation
مسار يحدد URL النسبي بشكل فريد واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة APIM. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية API المحدد أثناء إنشاء مثيل الخدمة لتشكيل عنوان URL عام لواجهة برمجة التطبيقات هذه. سلسلة (مطلوب)

القيود:
الحد الأقصى للطول = 400
البروتوكولات يصف البروتوكولات التي يمكن استدعاء العمليات في واجهة برمجة التطبيقات هذه. صفيف سلسلة يحتوي على أي من:
"http"
"https"
"ws"
"wss"
serviceUrl عنوان URL المطلق لخدمة الواجهة الخلفية التي تنفذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف. خيط

القيود:
الحد الأقصى للطول = 2000
sourceApiId معرف واجهة برمجة التطبيقات لواجهة برمجة التطبيقات المصدر. خيط
subscriptionKeyParameterNames البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها. SubscriptionKeyParameterNamesContract
الاشتراك مطلوبة تحديد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات. قيمة منطقية
termsOfServiceUrl عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL. خيط
معلمات طلب الترجمة استراتيجية ترجمة معلمات الاستعلام المطلوبة إلى معلمات القالب. بشكل افتراضي لها قيمة "قالب". القيم المحتملة: "قالب"، "استعلام" "استعلام"
"قالب"
نوع نوع واجهة برمجة التطبيقات. "graphql"
"grpc"
"http"
"odata"
"صابون"
"websocket"
قيمة قيمة المحتوى عند استيراد واجهة برمجة تطبيقات. خيط
wsdlSelector معايير للحد من استيراد WSDL إلى مجموعة فرعية من المستند. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

اسم وصف قيمة
oAuth2 إعدادات مصادقة OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings مجموعة من إعدادات مصادقة OAuth2 المضمنة في واجهة برمجة التطبيقات هذه. OAuth2AuthenticationSettingsContract[]
openid إعدادات مصادقة OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings مجموعة من إعدادات مصادقة Open ID Connect المضمنة في واجهة برمجة التطبيقات هذه. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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