Microsoft.ApiManagement service/apis/operations 2023-09-01-preview
تعريف مورد Bicep
يمكن نشر نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:
للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير .
تنسيق المورد
لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف Bicep التالي إلى القالب الخاص بك.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
method: 'string'
policies: 'string'
request: {
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
queryParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
}
responses: [
{
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
statusCode: int
}
]
templateParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
قيم الخصائص
الخدمة/apis/العمليات
اسم | وصف | قيمة |
---|---|---|
اسم | اسم المورد راجع كيفية تعيين الأسماء والأنواع للموارد التابعة في Bicep. |
سلسلة (مطلوب) حد الحرف: 1-80 الأحرف الصالحة: الأبجدية الرقمية والواصلات. ابدأ بحرف وانتهي بالأبجدية الرقمية. |
الوالد | في Bicep، يمكنك تحديد المورد الأصل لمورد تابع. تحتاج فقط إلى إضافة هذه الخاصية عند الإعلان عن المورد التابع خارج المورد الأصل. لمزيد من المعلومات، راجع مورد تابع خارج المورد الأصل. |
اسم رمزي للمورد من النوع: apis |
خصائص | خصائص عقد العملية. | |
خصائص العملية
اسم | وصف | قيمة |
---|---|---|
وصف | وصف العملية. قد تتضمن علامات تنسيق HTML. | خيط القيود: الحد الأقصى للطول = 1000 |
اسم العرض | اسم العملية. | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 300 |
أسلوب | أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET وPUT وPOST ولكن لا تقتصر عليها فقط. | سلسلة (مطلوب) |
سياسات | نهج العملية | خيط |
طلب | كيان يحتوي على تفاصيل الطلب. | طلب التعاقد |
الاستجابات | صفيف استجابات العملية. | ResponseContract[] |
معلمات القالب | مجموعة من معلمات قالب URL. | ParameterContract[] |
urlTemplate | قالب URL نسبي يحدد المورد الهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 1000 |
طلب التعاقد
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طلب العملية. | خيط |
رؤوس | مجموعة من عناوين طلب العملية. | ParameterContract[] |
معلمات الاستعلام | مجموعة من معلمات استعلام طلب العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات طلب العملية. |
تم التعاقد مع المعلمة
اسم | وصف | قيمة |
---|---|---|
القيمة الافتراضية | قيمة المعلمة الافتراضية. | خيط |
وصف | وصف المعلمة. | خيط |
امثله | مثال معرف للمعلمة . | ParameterExamplesContract |
اسم | اسم المعلمة. | سلسلة (مطلوب) |
مطلوب | تحديد ما إذا كانت المعلمة مطلوبة أم لا. | قيمة منطقية |
معرف المخطط | معرف المخطط. | خيط |
نوع | نوع المعلمة. | سلسلة (مطلوب) |
typeName | اكتب اسما معرفا بواسطة المخطط. | خيط |
القيم | قيم المعلمات. | سلسلة[] |
ParameterExamplesContract
اسم | وصف | قيمة |
---|---|---|
{خاصية مخصصة} | ParameterExampleContract |
ParameterExampleContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طويل للمثال | خيط |
القيمة الخارجية | عنوان URL يشير إلى المثال الحرفي | خيط |
ملخص | وصف مختصر للمثال | خيط |
قيمة | قيمة المثال. قد تكون قيمة بدائية أو كائن. | بالنسبة ل Bicep، يمكنك استخدام الدالة any(). |
تم التعاقد على التمثيل
اسم | وصف | قيمة |
---|---|---|
نوع المحتوى | تحديد نوع محتوى مسجل أو مخصص لهذا التمثيل، على سبيل المثال application/xml. | سلسلة (مطلوب) |
امثله | مثال معرف للتمثيل. | ParameterExamplesContract |
معلمات النموذج | مجموعة من معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. | ParameterContract[] |
معرف المخطط | معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
typeName | اكتب اسما معرفا بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
ResponseContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف استجابة العملية. | خيط |
رؤوس | مجموعة من رؤوس استجابة العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات استجابة العملية. | |
رمز الحالة | رمز حالة HTTP للاستجابة للعملية. | int (مطلوب) |
تعريف مورد قالب ARM
يمكن نشر نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:
للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير .
تنسيق المورد
لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف JSON التالي إلى القالب الخاص بك.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"method": "string",
"policies": "string",
"request": {
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"queryParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
]
},
"responses": [
{
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
],
"statusCode": "int"
}
],
"templateParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
قيم الخصائص
الخدمة/apis/العمليات
اسم | وصف | قيمة |
---|---|---|
نوع | نوع المورد | 'Microsoft.ApiManagement/service/apis/operations' |
apiVersion | إصدار واجهة برمجة تطبيقات المورد | '2023-09-01-preview' |
اسم | اسم المورد راجع كيفية تعيين الأسماء والأنواع للموارد التابعة في قوالب JSON ARM. |
سلسلة (مطلوب) حد الحرف: 1-80 الأحرف الصالحة: الأبجدية الرقمية والواصلات. ابدأ بحرف وانتهي بالأبجدية الرقمية. |
خصائص | خصائص عقد العملية. | |
خصائص العملية
اسم | وصف | قيمة |
---|---|---|
وصف | وصف العملية. قد تتضمن علامات تنسيق HTML. | خيط القيود: الحد الأقصى للطول = 1000 |
اسم العرض | اسم العملية. | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 300 |
أسلوب | أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET وPUT وPOST ولكن لا تقتصر عليها فقط. | سلسلة (مطلوب) |
سياسات | نهج العملية | خيط |
طلب | كيان يحتوي على تفاصيل الطلب. | طلب التعاقد |
الاستجابات | صفيف استجابات العملية. | ResponseContract[] |
معلمات القالب | مجموعة من معلمات قالب URL. | ParameterContract[] |
urlTemplate | قالب URL نسبي يحدد المورد الهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 1000 |
طلب التعاقد
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طلب العملية. | خيط |
رؤوس | مجموعة من عناوين طلب العملية. | ParameterContract[] |
معلمات الاستعلام | مجموعة من معلمات استعلام طلب العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات طلب العملية. |
تم التعاقد مع المعلمة
اسم | وصف | قيمة |
---|---|---|
القيمة الافتراضية | قيمة المعلمة الافتراضية. | خيط |
وصف | وصف المعلمة. | خيط |
امثله | مثال معرف للمعلمة . | ParameterExamplesContract |
اسم | اسم المعلمة. | سلسلة (مطلوب) |
مطلوب | تحديد ما إذا كانت المعلمة مطلوبة أم لا. | قيمة منطقية |
معرف المخطط | معرف المخطط. | خيط |
نوع | نوع المعلمة. | سلسلة (مطلوب) |
typeName | اكتب اسما معرفا بواسطة المخطط. | خيط |
القيم | قيم المعلمات. | سلسلة[] |
ParameterExamplesContract
اسم | وصف | قيمة |
---|---|---|
{خاصية مخصصة} | ParameterExampleContract |
ParameterExampleContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طويل للمثال | خيط |
القيمة الخارجية | عنوان URL يشير إلى المثال الحرفي | خيط |
ملخص | وصف مختصر للمثال | خيط |
قيمة | قيمة المثال. قد تكون قيمة بدائية أو كائن. |
تم التعاقد على التمثيل
اسم | وصف | قيمة |
---|---|---|
نوع المحتوى | تحديد نوع محتوى مسجل أو مخصص لهذا التمثيل، على سبيل المثال application/xml. | سلسلة (مطلوب) |
امثله | مثال معرف للتمثيل. | ParameterExamplesContract |
معلمات النموذج | مجموعة من معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. | ParameterContract[] |
معرف المخطط | معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
typeName | اكتب اسما معرفا بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
ResponseContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف استجابة العملية. | خيط |
رؤوس | مجموعة من رؤوس استجابة العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات استجابة العملية. | |
رمز الحالة | رمز حالة HTTP للاستجابة للعملية. | int (مطلوب) |
تعريف مورد Terraform (موفر AzAPI)
يمكن نشر نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:
- مجموعات الموارد
للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير .
تنسيق المورد
لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف Terraform التالي إلى القالب الخاص بك.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
method = "string"
policies = "string"
request = {
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
queryParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
}
responses = [
{
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
statusCode = int
}
]
templateParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
قيم الخصائص
الخدمة/apis/العمليات
اسم | وصف | قيمة |
---|---|---|
نوع | نوع المورد | "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview" |
اسم | اسم المورد | سلسلة (مطلوب) حد الحرف: 1-80 الأحرف الصالحة: الأبجدية الرقمية والواصلات. ابدأ بحرف وانتهي بالأبجدية الرقمية. |
parent_id | معرف المورد الأصل لهذا المورد. | معرف المورد من النوع: apis |
خصائص | خصائص عقد العملية. | |
خصائص العملية
اسم | وصف | قيمة |
---|---|---|
وصف | وصف العملية. قد تتضمن علامات تنسيق HTML. | خيط القيود: الحد الأقصى للطول = 1000 |
اسم العرض | اسم العملية. | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 300 |
أسلوب | أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET وPUT وPOST ولكن لا تقتصر عليها فقط. | سلسلة (مطلوب) |
سياسات | نهج العملية | خيط |
طلب | كيان يحتوي على تفاصيل الطلب. | طلب التعاقد |
الاستجابات | صفيف استجابات العملية. | ResponseContract[] |
معلمات القالب | مجموعة من معلمات قالب URL. | ParameterContract[] |
urlTemplate | قالب URL نسبي يحدد المورد الهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} | سلسلة (مطلوب) القيود: الحد الأدنى للطول = 1 الحد الأقصى للطول = 1000 |
طلب التعاقد
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طلب العملية. | خيط |
رؤوس | مجموعة من عناوين طلب العملية. | ParameterContract[] |
معلمات الاستعلام | مجموعة من معلمات استعلام طلب العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات طلب العملية. |
تم التعاقد مع المعلمة
اسم | وصف | قيمة |
---|---|---|
القيمة الافتراضية | قيمة المعلمة الافتراضية. | خيط |
وصف | وصف المعلمة. | خيط |
امثله | مثال معرف للمعلمة . | ParameterExamplesContract |
اسم | اسم المعلمة. | سلسلة (مطلوب) |
مطلوب | تحديد ما إذا كانت المعلمة مطلوبة أم لا. | قيمة منطقية |
معرف المخطط | معرف المخطط. | خيط |
نوع | نوع المعلمة. | سلسلة (مطلوب) |
typeName | اكتب اسما معرفا بواسطة المخطط. | خيط |
القيم | قيم المعلمات. | سلسلة[] |
ParameterExamplesContract
اسم | وصف | قيمة |
---|---|---|
{خاصية مخصصة} | ParameterExampleContract |
ParameterExampleContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف طويل للمثال | خيط |
القيمة الخارجية | عنوان URL يشير إلى المثال الحرفي | خيط |
ملخص | وصف مختصر للمثال | خيط |
قيمة | قيمة المثال. قد تكون قيمة بدائية أو كائن. |
تم التعاقد على التمثيل
اسم | وصف | قيمة |
---|---|---|
نوع المحتوى | تحديد نوع محتوى مسجل أو مخصص لهذا التمثيل، على سبيل المثال application/xml. | سلسلة (مطلوب) |
امثله | مثال معرف للتمثيل. | ParameterExamplesContract |
معلمات النموذج | مجموعة من معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. | ParameterContract[] |
معرف المخطط | معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
typeName | اكتب اسما معرفا بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. | خيط |
ResponseContract
اسم | وصف | قيمة |
---|---|---|
وصف | وصف استجابة العملية. | خيط |
رؤوس | مجموعة من رؤوس استجابة العملية. | ParameterContract[] |
تمثيلات | مجموعة من تمثيلات استجابة العملية. | |
رمز الحالة | رمز حالة HTTP للاستجابة للعملية. | int (مطلوب) |