ApiManagementServiceUpdateParameters interface
المعلمة المتوفرة لتحديث خدمة إدارة واجهة برمجة التطبيقات.
- يمتد
الخصائص
| additional |
مواقع مركز بيانات إضافية لخدمة APIM. |
| api |
قيد إصدار وحدة التحكم Apis لخدمة APIM. |
| certificates | قائمة الشهادات التي تحتاج إلى تثبيت في خدمة APIM. الحد الأقصى للشهادات المدعومة التي يمكن تثبيتها هو 10. |
| configuration |
تكوين واجهة برمجة تطبيقات التكوين لخدمة APIM. |
| created |
تاريخ إنشاء UTC لخدمة APIM. يتوافق التاريخ مع التنسيق التالي: |
| custom |
خصائص مخصصة لخدمة APIM. سيقوم إعداد |
| developer |
حالة مدخل المطور في خدمة APIM هذه. |
| developer |
عنوان URL لنقطة نهاية مدخل DEveloper لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| disable |
الخاصية صالحة فقط لخدمة APIM المنشورة في مواقع متعددة. يمكن استخدام هذا لتعطيل البوابة في المنطقة الرئيسية. |
| enable |
الخاصية المقصود بها فقط أن تستخدم لخدمة SKU الاستهلاك. يفرض هذا شهادة عميل ليتم تقديمها على كل طلب إلى البوابة. وهذا يتيح أيضا القدرة على مصادقة الشهادة في النهج على البوابة. |
| etag | ETag للمورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| gateway |
عنوان URL للبوابة لخدمة APIM في المنطقة الافتراضية. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| gateway |
عنوان URL للبوابة لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| hostname |
تكوين اسم المضيف المخصص لخدمة APIM. |
| identity | هوية الخدمة المدارة لخدمة APIM. |
| legacy |
حالة المدخل القديم في خدمة APIM. |
| management |
عنوان URL لنقطة نهاية واجهة برمجة تطبيقات الإدارة لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| nat |
يمكن استخدام الخاصية لتمكين بوابة NAT لخدمة APIM هذه. |
| notification |
عنوان البريد الإلكتروني الذي سيتم إرسال الإعلام منه. |
| outbound |
بادئات عناوين IPV4 العامة الصادرة المقترنة بالخدمة المنشورة لبوابة NAT. متوفر فقط ل Premium SKU على منصة stv2. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| platform |
حساب إصدار النظام الأساسي الذي يقوم بتشغيل الخدمة في هذا الموقع. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| portal |
عنوان URL لنقطة نهاية مدخل Publisher لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| private |
قائمة اتصالات نقطة النهاية الخاصة لهذه الخدمة. |
| private |
عناوين IP الخاصة لموازنة التحميل الثابت لخدمة APIM في المنطقة الأساسية التي يتم نشرها في شبكة ظاهرية داخلية. متوفر فقط ل SKU الأساسية والقياسية والمميزة والمعزولة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| provisioning |
حالة التوفير الحالية لخدمة APIM التي يمكن أن تكون واحدة مما يلي: تم الإنشاء/التنشيط/النجاح/التحديث/فشل/توقف/إنهاء/إنهاءFailed/حذف. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| public |
عناوين IP العامة لموازنة التحميل الثابت لخدمة APIM في المنطقة الأساسية. متوفر فقط ل SKU الأساسية والقياسية والمميزة والمعزولة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| public |
عنوان IP المستند إلى SKU IP V4 القياسي العام ليتم إقرانه بخدمة الشبكة الظاهرية المنشورة في المنطقة. مدعوم فقط للمطور وPremium SKU الذي يتم نشره في الشبكة الظاهرية. |
| public |
ما إذا كان يسمح بالوصول إلى نقطة النهاية العامة لخدمة APIM هذه أم لا. القيمة اختيارية ولكن إذا تم تمريرها، يجب أن تكون "ممكن" أو "معطل". إذا كانت "معطل"، فإن نقاط النهاية الخاصة هي أسلوب الوصول الحصري. القيمة الافتراضية هي "ممكن" |
| publisher |
البريد الإلكتروني للناشر. |
| publisher |
اسم الناشر. |
| restore | إلغاء حذف خدمة إدارة واجهة برمجة التطبيقات إذا تم حذفها مبدئيا مسبقا. إذا تم تحديد هذه العلامة وتعيينها إلى True سيتم تجاهل كافة الخصائص الأخرى. |
| scm |
عنوان URL لنقطة نهاية SCM لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| sku | خصائص SKU لخدمة APIM. |
| target |
حالة التزويد لخدمة APIM، والتي تستهدفها عملية التشغيل الطويل التي بدأت على الخدمة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| virtual |
تكوين الشبكة الظاهرية لخدمة APIM. |
| virtual |
نوع VPN الذي يجب تكوين خدمة APIM فيه. لا شيء (القيمة الافتراضية) يعني أن خدمة إدارة واجهة برمجة التطبيقات ليست جزءا من أي شبكة ظاهرية، ويعني خارجي أنه تم إعداد نشر إدارة واجهة برمجة التطبيقات داخل شبكة ظاهرية تحتوي على نقطة نهاية مواجهة للإنترنت، ويعني داخلي أنه يتم إعداد نشر إدارة واجهة برمجة التطبيقات داخل شبكة ظاهرية تحتوي على نقطة نهاية مواجهة إنترانت فقط. |
| zones | قائمة بمناطق التوفر التي تدل على المكان الذي يجب أن يأتي منه المورد. |
الخصائص الموروثة
| id | معرف المورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| name | اسم المورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| tags | علامات الموارد. |
| type | يتم تعيين نوع المورد لمورد APIM إلى Microsoft.ApiManagement. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
تفاصيل الخاصية
additionalLocations
مواقع مركز بيانات إضافية لخدمة APIM.
additionalLocations?: AdditionalLocation[]
قيمة الخاصية
apiVersionConstraint
قيد إصدار وحدة التحكم Apis لخدمة APIM.
apiVersionConstraint?: ApiVersionConstraint
قيمة الخاصية
certificates
قائمة الشهادات التي تحتاج إلى تثبيت في خدمة APIM. الحد الأقصى للشهادات المدعومة التي يمكن تثبيتها هو 10.
certificates?: CertificateConfiguration[]
قيمة الخاصية
configurationApi
تكوين واجهة برمجة تطبيقات التكوين لخدمة APIM.
configurationApi?: ConfigurationApi
قيمة الخاصية
createdAtUtc
تاريخ إنشاء UTC لخدمة APIM. يتوافق التاريخ مع التنسيق التالي: yyyy-MM-ddTHH:mm:ssZ كما هو محدد بواسطة معيار ISO 8601.
ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
createdAtUtc?: Date
قيمة الخاصية
Date
customProperties
خصائص مخصصة لخدمة APIM. سيقوم إعداد Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168بتعطيل TLS_RSA_WITH_3DES_EDE_CBC_SHA التشفير لكافة TLS(1.0 و1.1 و1.2). يمكن استخدام
إعدادMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11لتعطيل TLS 1.1 فقط. يمكن استخدام
إعدادMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10لتعطيل TLS 1.0 على خدمة APIM. يمكن استخدام
إعداد Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 لتعطيل TLS 1.1 فقط للاتصالات مع الخلفيات. يمكن استخدام
إعداد Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 لتعطيل TLS 1.0 للاتصالات مع الخلفيات. يمكن استخدام
إعدادMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2لتمكين بروتوكول HTTP2 على خدمة APIM.
سيؤدي عدم تحديد أي من هذه الخصائص في عملية PATCH إلى إعادة تعيين قيم الخصائص المحذفة إلى الإعدادات الافتراضية الخاصة بها. بالنسبة لجميع الإعدادات باستثناء Http2، يتم True القيمة الافتراضية إذا تم إنشاء الخدمة في 1 أبريل 2018 أو قبل ذلك False خلاف ذلك. القيمة الافتراضية لإعداد Http2 هي False.
يمكنك تعطيل أي من الشفرات التالية باستخدام الإعدادات Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA، TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA، TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA، TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA، TLS_RSA_WITH_AES_128_GCM_SHA256، TLS_RSA_WITH_AES_256_CBC_SHA256، TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA على سبيل المثال، Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. القيمة الافتراضية هي true لهم.ملاحظة
: لا يمكن تعطيل الشفرات التالية نظرا لأنها مطلوبة من قبل مكونات النظام الأساسي الداخلية: TLS_AES_256_GCM_SHA384،TLS_AES_128_GCM_SHA256،TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384،TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256،TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384،TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256، TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384، TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256، TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384، TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
customProperties?: {[propertyName: string]: string}
قيمة الخاصية
{[propertyName: string]: string}
developerPortalStatus
حالة مدخل المطور في خدمة APIM هذه.
developerPortalStatus?: string
قيمة الخاصية
string
developerPortalUrl
عنوان URL لنقطة نهاية مدخل DEveloper لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
developerPortalUrl?: string
قيمة الخاصية
string
disableGateway
الخاصية صالحة فقط لخدمة APIM المنشورة في مواقع متعددة. يمكن استخدام هذا لتعطيل البوابة في المنطقة الرئيسية.
disableGateway?: boolean
قيمة الخاصية
boolean
enableClientCertificate
الخاصية المقصود بها فقط أن تستخدم لخدمة SKU الاستهلاك. يفرض هذا شهادة عميل ليتم تقديمها على كل طلب إلى البوابة. وهذا يتيح أيضا القدرة على مصادقة الشهادة في النهج على البوابة.
enableClientCertificate?: boolean
قيمة الخاصية
boolean
etag
ETag للمورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
etag?: string
قيمة الخاصية
string
gatewayRegionalUrl
عنوان URL للبوابة لخدمة APIM في المنطقة الافتراضية. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
gatewayRegionalUrl?: string
قيمة الخاصية
string
gatewayUrl
عنوان URL للبوابة لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
gatewayUrl?: string
قيمة الخاصية
string
hostnameConfigurations
تكوين اسم المضيف المخصص لخدمة APIM.
hostnameConfigurations?: HostnameConfiguration[]
قيمة الخاصية
identity
هوية الخدمة المدارة لخدمة APIM.
identity?: ApiManagementServiceIdentity
قيمة الخاصية
legacyPortalStatus
حالة المدخل القديم في خدمة APIM.
legacyPortalStatus?: string
قيمة الخاصية
string
managementApiUrl
عنوان URL لنقطة نهاية واجهة برمجة تطبيقات الإدارة لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
managementApiUrl?: string
قيمة الخاصية
string
natGatewayState
يمكن استخدام الخاصية لتمكين بوابة NAT لخدمة APIM هذه.
natGatewayState?: string
قيمة الخاصية
string
notificationSenderEmail
عنوان البريد الإلكتروني الذي سيتم إرسال الإعلام منه.
notificationSenderEmail?: string
قيمة الخاصية
string
outboundPublicIPAddresses
بادئات عناوين IPV4 العامة الصادرة المقترنة بالخدمة المنشورة لبوابة NAT. متوفر فقط ل Premium SKU على منصة stv2. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
outboundPublicIPAddresses?: string[]
قيمة الخاصية
string[]
platformVersion
حساب إصدار النظام الأساسي الذي يقوم بتشغيل الخدمة في هذا الموقع. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
platformVersion?: string
قيمة الخاصية
string
portalUrl
عنوان URL لنقطة نهاية مدخل Publisher لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
portalUrl?: string
قيمة الخاصية
string
privateEndpointConnections
قائمة اتصالات نقطة النهاية الخاصة لهذه الخدمة.
privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]
قيمة الخاصية
privateIPAddresses
عناوين IP الخاصة لموازنة التحميل الثابت لخدمة APIM في المنطقة الأساسية التي يتم نشرها في شبكة ظاهرية داخلية. متوفر فقط ل SKU الأساسية والقياسية والمميزة والمعزولة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
privateIPAddresses?: string[]
قيمة الخاصية
string[]
provisioningState
حالة التوفير الحالية لخدمة APIM التي يمكن أن تكون واحدة مما يلي: تم الإنشاء/التنشيط/النجاح/التحديث/فشل/توقف/إنهاء/إنهاءFailed/حذف. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
provisioningState?: string
قيمة الخاصية
string
publicIPAddresses
عناوين IP العامة لموازنة التحميل الثابت لخدمة APIM في المنطقة الأساسية. متوفر فقط ل SKU الأساسية والقياسية والمميزة والمعزولة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
publicIPAddresses?: string[]
قيمة الخاصية
string[]
publicIpAddressId
عنوان IP المستند إلى SKU IP V4 القياسي العام ليتم إقرانه بخدمة الشبكة الظاهرية المنشورة في المنطقة. مدعوم فقط للمطور وPremium SKU الذي يتم نشره في الشبكة الظاهرية.
publicIpAddressId?: string
قيمة الخاصية
string
publicNetworkAccess
ما إذا كان يسمح بالوصول إلى نقطة النهاية العامة لخدمة APIM هذه أم لا. القيمة اختيارية ولكن إذا تم تمريرها، يجب أن تكون "ممكن" أو "معطل". إذا كانت "معطل"، فإن نقاط النهاية الخاصة هي أسلوب الوصول الحصري. القيمة الافتراضية هي "ممكن"
publicNetworkAccess?: string
قيمة الخاصية
string
publisherEmail
البريد الإلكتروني للناشر.
publisherEmail?: string
قيمة الخاصية
string
publisherName
اسم الناشر.
publisherName?: string
قيمة الخاصية
string
restore
إلغاء حذف خدمة إدارة واجهة برمجة التطبيقات إذا تم حذفها مبدئيا مسبقا. إذا تم تحديد هذه العلامة وتعيينها إلى True سيتم تجاهل كافة الخصائص الأخرى.
restore?: boolean
قيمة الخاصية
boolean
scmUrl
عنوان URL لنقطة نهاية SCM لخدمة APIM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
scmUrl?: string
قيمة الخاصية
string
sku
خصائص SKU لخدمة APIM.
sku?: ApiManagementServiceSkuProperties
قيمة الخاصية
targetProvisioningState
حالة التزويد لخدمة APIM، والتي تستهدفها عملية التشغيل الطويل التي بدأت على الخدمة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
targetProvisioningState?: string
قيمة الخاصية
string
virtualNetworkConfiguration
تكوين الشبكة الظاهرية لخدمة APIM.
virtualNetworkConfiguration?: VirtualNetworkConfiguration
قيمة الخاصية
virtualNetworkType
نوع VPN الذي يجب تكوين خدمة APIM فيه. لا شيء (القيمة الافتراضية) يعني أن خدمة إدارة واجهة برمجة التطبيقات ليست جزءا من أي شبكة ظاهرية، ويعني خارجي أنه تم إعداد نشر إدارة واجهة برمجة التطبيقات داخل شبكة ظاهرية تحتوي على نقطة نهاية مواجهة للإنترنت، ويعني داخلي أنه يتم إعداد نشر إدارة واجهة برمجة التطبيقات داخل شبكة ظاهرية تحتوي على نقطة نهاية مواجهة إنترانت فقط.
virtualNetworkType?: string
قيمة الخاصية
string
zones
قائمة بمناطق التوفر التي تدل على المكان الذي يجب أن يأتي منه المورد.
zones?: string[]
قيمة الخاصية
string[]
تفاصيل الخاصية الموروثة
id
معرف المورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
id?: string
قيمة الخاصية
string
موروث منApimResource.id
name
اسم المورد. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
name?: string
قيمة الخاصية
string
موروث منApimResource.name
tags
علامات الموارد.
tags?: {[propertyName: string]: string}
قيمة الخاصية
{[propertyName: string]: string}
موروثة منApimResource.tags
type
يتم تعيين نوع المورد لمورد APIM إلى Microsoft.ApiManagement. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
type?: string
قيمة الخاصية
string
موروث منApimResource.type