Microsoft.ApiManagement service/apis/operations 2022-09-01-preview
Definice prostředku Bicep
Typ prostředku service/api/operations je možné nasadit s operacemi, na které cílí:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/operations, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2022-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()
}
{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'
}
}
Hodnoty vlastností
služba, rozhraní API nebo operace
Název | Description | Hodnota |
---|---|---|
name | Název prostředku Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu. |
string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: rozhraní API |
properties | Vlastnosti kontraktu operace. | OperationContractProperties |
OperationContractProperties
Název | Description | Hodnota |
---|---|---|
description | Popis operace Může obsahovat značky formátování HTML. | řetězec |
displayName | Název operace. | string (povinné) |
method | Platná metoda operace HTTP. Typické metody HTTP, jako jsou GET, PUT, POST, ale neomezují se jenom na ně. | string (povinné) |
Zásady | Zásady operací | řetězec |
Požadavek | Entita obsahující podrobnosti žádosti. | RequestContract |
Reakce | Pole odpovědí operace. | ResponseContract[] |
šablonaParameters | Kolekce parametrů šablony adresy URL. | ParametrContract[] |
urlTemplate | Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: /customers/{cid}/orders/{oid}/?date={date} | string (povinné) |
RequestContract
Název | Description | Hodnota |
---|---|---|
description | Popis žádosti o operaci | řetězec |
Záhlaví | Kolekce hlaviček žádostí o operaci. | ParametrContract[] |
queryParameters | Kolekce parametrů dotazu požadavků na operaci. | ParametrContract[] |
Reprezentace | Kolekce reprezentací požadavků na operace | RepresentationContract[] |
ParametrContract
Název | Description | Hodnota |
---|---|---|
Defaultvalue | Výchozí hodnota parametru. | řetězec |
description | Popis parametru. | řetězec |
příklady | Příklad definovaný pro parametr. | ParametrExamplesContract |
name | Názvy parametrů. | string (povinné) |
vyžadováno | Určuje, jestli je parametr povinný nebo ne. | bool |
schemaId (ID schématu) | Identifikátor schématu. | řetězec |
typ | Typ parametru. | string (povinné) |
Typename | Zadejte název definovaný schématem. | řetězec |
values | Hodnoty parametrů. | string[] |
ParametrExamplesContract
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ParametrExampleContract | |
{přizpůsobená vlastnost} | ParametrExampleContract |
ParametrExampleContract
Název | Description | Hodnota |
---|---|---|
description | Dlouhý popis příkladu | řetězec |
externí hodnota | Adresa URL, která odkazuje na příklad literálu | řetězec |
shrnutí | Krátký popis příkladu | řetězec |
hodnota | Příklad hodnoty Může to být primitivní hodnota nebo objekt. | Pro Bicep můžete použít funkci any(). |
RepresentationContract
Název | Description | Hodnota |
---|---|---|
Contenttype | Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, například application/xml. | string (povinné) |
příklady | Příklad definovaný pro reprezentaci. | ParametrExamplesContract |
parametry formuláře | Kolekce parametrů formuláře. Vyžaduje se, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data. | ParametrContract[] |
schemaId (ID schématu) | Identifikátor schématu. Platí jenom v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
Typename | Zadejte název definovaný schématem. Platí jenom v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
ResponseContract
Název | Description | Hodnota |
---|---|---|
description | Popis odpovědi operace | řetězec |
Záhlaví | Kolekce hlaviček odpovědi na operace. | ParametrContract[] |
Reprezentace | Kolekce reprezentací odpovědí na operace. | RepresentationContract[] |
statusCode | Stavový kód HTTP odpovědi operace | int (povinné) |
Definice prostředku šablony ARM
Typ prostředku service/api/operations je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/operations, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2022-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": {}
},
"{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"
}
}
Hodnoty vlastností
služba/rozhraní API/operace
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.ApiManagement/service/apis/operations |
apiVersion | Verze rozhraní API prostředku | 2022-09-01-preview |
name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
properties | Vlastnosti kontraktu operace. | OperationContractProperties |
OperationContractProperties
Název | Description | Hodnota |
---|---|---|
description | Popis operace. Mohou obsahovat značky formátování HTML. | řetězec |
displayName | Název operace. | string (povinné) |
method | Platná metoda operace HTTP. Typické metody HTTP, jako jsou GET, PUT, POST, ale neomezují se pouze na ně. | string (povinné) |
Zásady | Zásady operací | řetězec |
Požadavek | Entita obsahující podrobnosti požadavku. | RequestContract |
Reakce | Pole odpovědí operace | ResponseContract[] |
šablonyParameters | Kolekce parametrů šablony adresy URL. | ParametrContract[] |
urlNášplate | Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: /customers/{cid}/orders/{oid}/?date={date} | string (povinné) |
RequestContract
Název | Description | Hodnota |
---|---|---|
description | Popis žádosti o operaci | řetězec |
Záhlaví | Kolekce hlaviček žádostí o operaci. | ParametrContract[] |
parametry dotazu | Kolekce parametrů dotazu požadavku operace. | ParametrContract[] |
Reprezentace | Kolekce reprezentací žádostí o operaci. | RepresentationContract[] |
ParametrContract
Název | Description | Hodnota |
---|---|---|
Defaultvalue | Výchozí hodnota parametru. | řetězec |
description | Popis parametru. | řetězec |
příklady | Příklad definovaný pro parametr . | ParametrExamplesContract |
name | Názvy parametrů. | string (povinné) |
vyžadováno | Určuje, jestli je parametr povinný nebo ne. | bool |
schemaId (ID schématu) | Identifikátor schématu. | řetězec |
typ | Typ parametru. | string (povinné) |
Typename | Zadejte název definovaný schématem. | řetězec |
values | Hodnoty parametrů. | string[] |
ParametrExamplesContract
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ParametrExampleContract | |
{přizpůsobená vlastnost} | ParametrExampleContract |
ParametrExampleContract
Název | Description | Hodnota |
---|---|---|
description | Dlouhý popis příkladu | řetězec |
externí hodnota | Adresa URL, která odkazuje na příklad literálu | řetězec |
shrnutí | Krátký popis příkladu | řetězec |
hodnota | Příklad hodnoty Může to být primitivní hodnota nebo objekt. |
RepresentationContract
Název | Description | Hodnota |
---|---|---|
Contenttype | Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, například application/xml. | string (povinné) |
příklady | Příklad definovaný pro reprezentaci. | ParametrExamplesContract |
parametry formuláře | Kolekce parametrů formuláře. Vyžaduje se, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data. | ParametrContract[] |
schemaId (ID schématu) | Identifikátor schématu. Platí jenom v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
Typename | Zadejte název definovaný schématem. Platí jenom v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
ResponseContract
Název | Description | Hodnota |
---|---|---|
description | Popis odpovědi operace | řetězec |
Záhlaví | Kolekce hlaviček odpovědi na operace. | ParametrContract[] |
Reprezentace | Kolekce reprezentací odpovědí na operace. | RepresentationContract[] |
statusCode | Stavový kód HTTP odpovědi operace | int (povinné) |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku service/api/operations je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/operations, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2022-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"
}
{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"
}
})
}
Hodnoty vlastností
služba/rozhraní API/operace
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.ApiManagement/service/apis/operations@2022-09-01-preview |
name | Název prostředku | string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: rozhraní API |
properties | Vlastnosti kontraktu operace. | OperationContractProperties |
OperationContractProperties
Název | Description | Hodnota |
---|---|---|
description | Popis operace. Mohou obsahovat značky formátování HTML. | řetězec |
displayName | Název operace. | string (povinné) |
method | Platná metoda operace HTTP. Typické metody HTTP, jako jsou GET, PUT, POST, ale neomezují se pouze na ně. | string (povinné) |
Zásady | Zásady operací | řetězec |
Požadavek | Entita obsahující podrobnosti požadavku. | RequestContract |
Reakce | Pole odpovědí operace | ResponseContract[] |
šablonyParameters | Kolekce parametrů šablony adresy URL. | ParametrContract[] |
urlNášplate | Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: /customers/{cid}/orders/{oid}/?date={date} | string (povinné) |
RequestContract
Název | Description | Hodnota |
---|---|---|
description | Popis žádosti o operaci | řetězec |
Záhlaví | Kolekce hlaviček žádostí o operaci. | ParametrContract[] |
parametry dotazu | Kolekce parametrů dotazu požadavku operace. | ParametrContract[] |
Reprezentace | Kolekce reprezentací žádostí o operaci. | RepresentationContract[] |
ParametrContract
Název | Description | Hodnota |
---|---|---|
Defaultvalue | Výchozí hodnota parametru. | řetězec |
description | Popis parametru. | řetězec |
příklady | Příklad definovaný pro parametr . | ParametrExamplesContract |
name | Názvy parametrů. | string (povinné) |
vyžadováno | Určuje, jestli je parametr povinný nebo ne. | bool |
schemaId (ID schématu) | Identifikátor schématu. | řetězec |
typ | Typ parametru. | string (povinné) |
Typename | Zadejte název definovaný schématem. | řetězec |
values | Hodnoty parametrů. | string[] |
ParametrExamplesContract
Název | Description | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | ParametrExampleContract | |
{přizpůsobená vlastnost} | ParametrExampleContract |
ParametrExampleContract
Název | Description | Hodnota |
---|---|---|
description | Dlouhý popis příkladu | řetězec |
externí hodnota | Adresa URL, která odkazuje na příklad literálu | řetězec |
shrnutí | Krátký popis příkladu | řetězec |
hodnota | Příklad hodnoty Může to být primitivní hodnota nebo objekt. |
RepresentationContract
Název | Description | Hodnota |
---|---|---|
Contenttype | Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, například application/xml. | string (povinné) |
příklady | Příklad definovaný pro reprezentaci. | ParametrExamplesContract |
parametry formuláře | Kolekce parametrů formuláře. Vyžaduje se, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data. | ParametrContract[] |
schemaId (ID schématu) | Identifikátor schématu. Platí jenom v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
Typename | Zadejte název definovaný schématem. Platí pouze v případě, že hodnota contentType není application/x-www-form-urlencoded ani multipart/form-data. | řetězec |
ResponseContract
Název | Description | Hodnota |
---|---|---|
description | Popis odpovědi operace. | řetězec |
Záhlaví | Kolekce hlaviček odpovědí na operace. | ParametrContract[] |
Reprezentace | Kolekce reprezentací odpovědí na operace. | RepresentationContract[] |
statusCode | Stavový kód HTTP odpovědi operace. | int (povinné) |