Microsoft.ApiManagement szolgáltatás/apis/operations 2022-08-01
Bicep-erőforrásdefiníció
A service/apis/operations erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőket célják:
- Erőforráscsoportok – Lásd : Erőforráscsoport üzembehelyezési parancsai
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/apis/operations erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = {
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()
}
{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()
}
{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()
}
{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()
}
{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()
}
{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()
}
{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()
}
{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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Tulajdonságértékek
service/apis/operations
Név | Leírás | Érték |
---|---|---|
name | Az erőforrás neve Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát a Bicepben. |
sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel, és végződés alfanumerikussal. |
Szülő | A Bicepben megadhatja egy gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva. További információ: Gyermekerőforrás a szülőerőforráson kívül. |
A következő típusú erőforrás szimbolikus neve: apis |
properties | A műveleti szerződés tulajdonságai. | OperationContractProperties |
OperationContractProperties
Név | Leírás | Érték |
---|---|---|
leírás | A művelet leírása. Html-formázási címkéket is tartalmazhat. | sztring |
displayName | Művelet neve. | sztring (kötelező) |
method | Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem korlátozódnak rájuk. | sztring (kötelező) |
policies | Műveleti szabályzatok | sztring |
Kérés | Egy kérelemadatokat tartalmazó entitás. | RequestContract |
Válaszok | Műveleti válaszok tömbje. | ResponseContract[] |
templateParameters | URL-sablonparaméterek gyűjteménye. | ParameterContract[] |
urlTemplate | A művelet célerőforrását azonosító relatív URL-sablon. Paramétereket is tartalmazhat. Példa: /customers/{cid}/orders/{oid}/?date={date} | sztring (kötelező) |
RequestContract
Név | Leírás | Érték |
---|---|---|
leírás | Műveletkérés leírása. | sztring |
Fejlécek | Műveleti kérelem fejléceinek gyűjteménye. | ParameterContract[] |
queryParameters | Műveleti kérelem lekérdezési paramétereinek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti kérelmek reprezentációinak gyűjteménye. | RepresentationContract[] |
ParameterContract
Név | Leírás | Érték |
---|---|---|
defaultValue | Alapértelmezett paraméterérték. | sztring |
leírás | Paraméter leírása. | sztring |
példák | Példa a paraméterhez definiálva. | ParameterExamplesContract |
name | A paraméter neve. | sztring (kötelező) |
kötelező | Megadja, hogy a paraméter kötelező-e vagy sem. | logikai |
schemaId | Sémaazonosító. | sztring |
típus | Paraméter típusa. | sztring (kötelező) |
typeName | Írja be a séma által definiált nevet. | sztring |
values | Paraméterértékek. | sztring[] |
ParameterExamplesContract
Név | Leírás | Érték |
---|---|---|
{customized property} | ParameterExampleContract | |
{customized property} | ParameterExampleContract |
ParameterExampleContract
Név | Leírás | Érték |
---|---|---|
leírás | Hosszú leírás a példához | sztring |
externalValue | Egy URL-cím, amely a konstans példára mutat | sztring |
összegzés | A példa rövid leírása | sztring |
érték | Példaérték. Lehet primitív érték vagy objektum. | A Bicep esetében használhatja az any() függvényt. |
RepresentationContract
Név | Leírás | Érték |
---|---|---|
contentType | A reprezentáció regisztrált vagy egyéni tartalomtípusát adja meg, például alkalmazás/xml. | sztring (kötelező) |
példák | Példa a reprezentációhoz. | ParameterExamplesContract |
formParameters | Űrlapparaméterek gyűjteménye. Kötelező, ha a "contentType" érték "application/x-www-form-urlencoded" vagy "multipart/form-data". | ParameterContract[] |
schemaId | Sémaazonosító. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
typeName | Írja be a séma által definiált nevet. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
ResponseContract
Név | Leírás | Érték |
---|---|---|
leírás | A művelet válaszának leírása. | sztring |
Fejlécek | Műveleti válaszfejlécek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti válaszok reprezentációinak gyűjteménye. | RepresentationContract[] |
statusCode | Műveleti válasz HTTP-állapotkódja. | int (kötelező) |
ARM-sablon erőforrás-definíciója
A service/apis/operations erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőket célják:
- Erőforráscsoportok – Lásd : Erőforráscsoport üzembehelyezési parancsai
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/apis/operations erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2022-08-01",
"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": {}
},
"{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": {}
},
"{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": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{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": {}
},
"{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": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{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": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Tulajdonságértékek
service/apis/operations
Név | Leírás | Érték |
---|---|---|
típus | Az erőforrás típusa | "Microsoft.ApiManagement/service/apis/operations" |
apiVersion | Az erőforrás API-verziója | '2022-08-01' |
name | Az erőforrás neve Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát JSON ARM-sablonokban. |
sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel, és végződés alfanumerikussal. |
properties | A műveleti szerződés tulajdonságai. | OperationContractProperties |
OperationContractProperties
Név | Leírás | Érték |
---|---|---|
leírás | A művelet leírása. Html-formázási címkéket is tartalmazhat. | sztring |
displayName | Művelet neve. | sztring (kötelező) |
method | Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem korlátozódnak rájuk. | sztring (kötelező) |
policies | Műveleti szabályzatok | sztring |
Kérés | Egy kérelemadatokat tartalmazó entitás. | RequestContract |
Válaszok | Műveleti válaszok tömbje. | ResponseContract[] |
templateParameters | URL-sablonparaméterek gyűjteménye. | ParameterContract[] |
urlTemplate | A művelet célerőforrását azonosító relatív URL-sablon. Paramétereket is tartalmazhat. Példa: /customers/{cid}/orders/{oid}/?date={date} | sztring (kötelező) |
RequestContract
Név | Leírás | Érték |
---|---|---|
leírás | Műveletkérés leírása. | sztring |
Fejlécek | Műveleti kérelem fejléceinek gyűjteménye. | ParameterContract[] |
queryParameters | Műveleti kérelem lekérdezési paramétereinek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti kérelmek reprezentációinak gyűjteménye. | RepresentationContract[] |
ParameterContract
Név | Leírás | Érték |
---|---|---|
defaultValue | Alapértelmezett paraméterérték. | sztring |
leírás | Paraméter leírása. | sztring |
példák | Példa a paraméterhez definiálva. | ParameterExamplesContract |
name | A paraméter neve. | sztring (kötelező) |
kötelező | Megadja, hogy a paraméter kötelező-e vagy sem. | logikai |
schemaId | Sémaazonosító. | sztring |
típus | Paraméter típusa. | sztring (kötelező) |
typeName | Írja be a séma által definiált nevet. | sztring |
values | Paraméterértékek. | sztring[] |
ParameterExamplesContract
Név | Leírás | Érték |
---|---|---|
{customized property} | ParameterExampleContract | |
{customized property} | ParameterExampleContract |
ParameterExampleContract
Név | Leírás | Érték |
---|---|---|
leírás | Hosszú leírás a példához | sztring |
externalValue | Egy URL-cím, amely a konstans példára mutat | sztring |
összegzés | A példa rövid leírása | sztring |
érték | Példaérték. Lehet primitív érték vagy objektum. |
RepresentationContract
Név | Leírás | Érték |
---|---|---|
contentType | A reprezentáció regisztrált vagy egyéni tartalomtípusát adja meg, például alkalmazás/xml. | sztring (kötelező) |
példák | Példa a reprezentációhoz. | ParameterExamplesContract |
formParameters | Űrlapparaméterek gyűjteménye. Kötelező, ha a "contentType" érték "application/x-www-form-urlencoded" vagy "multipart/form-data". | ParameterContract[] |
schemaId | Sémaazonosító. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
typeName | Írja be a séma által definiált nevet. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
ResponseContract
Név | Leírás | Érték |
---|---|---|
leírás | A művelet válaszának leírása. | sztring |
Fejlécek | Műveleti válaszfejlécek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti válaszok reprezentációinak gyűjteménye. | RepresentationContract[] |
statusCode | Műveleti válasz HTTP-állapotkódja. | int (kötelező) |
Terraform -erőforrásdefiníció (AzAPI-szolgáltató)
A service/apis/operations erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőket célják:
- Erőforráscsoportok
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/apis/operations erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2022-08-01"
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"
}
{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"
}
{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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{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"
}
{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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Tulajdonságértékek
service/apis/operations
Név | Leírás | Érték |
---|---|---|
típus | Az erőforrás típusa | "Microsoft.ApiManagement/service/apis/operations@2022-08-01" |
name | Az erőforrás neve | sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel, és végződés alfanumerikussal. |
parent_id | Annak az erőforrásnak az azonosítója, amely ennek az erőforrásnak a szülője. | A következő típusú erőforrás azonosítója: apis |
properties | A műveleti szerződés tulajdonságai. | OperationContractProperties |
OperationContractProperties
Név | Leírás | Érték |
---|---|---|
leírás | A művelet leírása. Html-formázási címkéket is tartalmazhat. | sztring |
displayName | Művelet neve. | sztring (kötelező) |
method | Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem korlátozódnak rájuk. | sztring (kötelező) |
policies | Műveleti szabályzatok | sztring |
Kérés | Egy kérelemadatokat tartalmazó entitás. | RequestContract |
Válaszok | Műveleti válaszok tömbje. | ResponseContract[] |
templateParameters | URL-sablonparaméterek gyűjteménye. | ParameterContract[] |
urlTemplate | A művelet célerőforrását azonosító relatív URL-sablon. Paramétereket is tartalmazhat. Példa: /customers/{cid}/orders/{oid}/?date={date} | sztring (kötelező) |
RequestContract
Név | Leírás | Érték |
---|---|---|
leírás | Műveletkérés leírása. | sztring |
Fejlécek | Műveleti kérelem fejléceinek gyűjteménye. | ParameterContract[] |
queryParameters | Műveleti kérelem lekérdezési paramétereinek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti kérelmek reprezentációinak gyűjteménye. | RepresentationContract[] |
ParameterContract
Név | Leírás | Érték |
---|---|---|
defaultValue | Alapértelmezett paraméterérték. | sztring |
leírás | Paraméter leírása. | sztring |
példák | Példa a paraméterhez definiálva. | ParameterExamplesContract |
name | A paraméter neve. | sztring (kötelező) |
kötelező | Megadja, hogy a paraméter kötelező-e vagy sem. | logikai |
schemaId | Sémaazonosító. | sztring |
típus | Paraméter típusa. | sztring (kötelező) |
typeName | Írja be a séma által definiált nevet. | sztring |
values | Paraméterértékek. | sztring[] |
ParameterExamplesContract
Név | Leírás | Érték |
---|---|---|
{customized property} | ParameterExampleContract | |
{customized property} | ParameterExampleContract |
ParameterExampleContract
Név | Leírás | Érték |
---|---|---|
leírás | Hosszú leírás a példához | sztring |
externalValue | Egy URL-cím, amely a konstans példára mutat | sztring |
összegzés | A példa rövid leírása | sztring |
érték | Példaérték. Lehet primitív érték vagy objektum. |
RepresentationContract
Név | Leírás | Érték |
---|---|---|
contentType | A reprezentáció regisztrált vagy egyéni tartalomtípusát adja meg, például alkalmazás/xml. | sztring (kötelező) |
példák | Példa a reprezentációhoz. | ParameterExamplesContract |
formParameters | Űrlapparaméterek gyűjteménye. Kötelező, ha a "contentType" érték "application/x-www-form-urlencoded" vagy "multipart/form-data". | ParameterContract[] |
schemaId | Sémaazonosító. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
typeName | Írja be a séma által definiált nevet. Csak akkor alkalmazható, ha a "contentType" érték nem "application/x-www-form-urlencoded" vagy "multipart/form-data". | sztring |
ResponseContract
Név | Leírás | Érték |
---|---|---|
leírás | A művelet válaszának leírása. | sztring |
Fejlécek | Műveleti válaszfejlécek gyűjteménye. | ParameterContract[] |
Képviseletek | Műveleti válaszok reprezentációinak gyűjteménye. | RepresentationContract[] |
statusCode | Műveleti válasz HTTP-állapotkódja. | int (kötelező) |