Služba Microsoft.ApiManagement/apis/operations 2020-12-01

• nejnovější
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 1. 3. 2023 ve verzi Preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 12. 12. 2021 ve verzi Preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 12. 12. 2020
• 2020-06-01-preview
• 12. 12. 2019
• 12. 12. 2019
• 1. 1. 2019
• 06. 6. 2018 ve verzi Preview
• 1. 1. 2018
• 03.03.2017
• 10. 10. 2016
• 2016-07-07

Definice prostředku Bicep

Typ prostředku služby/apis/operations je možné nasadit s operacemi, 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@2020-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: 'string'
    request: {
      description: 'string'
      headers: [
        {
          defaultValue: 'string'
          description: 'string'
          name: 'string'
          required: bool
          type: 'string'
          values: [
            'string'
          ]
        }
      ]
      queryParameters: [
        {
          defaultValue: 'string'
          description: 'string'
          name: 'string'
          required: bool
          type: 'string'
          values: [
            'string'
          ]
        }
      ]
      representations: [
        {
          contentType: 'string'
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              name: 'string'
              required: bool
              type: 'string'
              values: [
                'string'
              ]
            }
          ]
          sample: 'string'
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            name: 'string'
            required: bool
            type: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                name: 'string'
                required: bool
                type: 'string'
                values: [
                  'string'
                ]
              }
            ]
            sample: 'string'
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
rodič	V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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: služba /apis
vlastnosti	Vlastnosti kontraktu operace.	OperationContractProperties

OperationContractProperties

Jméno	Popis	Hodnota
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka =
displayName	Název operace.	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
politiky	Zásady operací	řetězec
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	ResponseContract[]
templateParameters	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}	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)

ParametrContract

Jméno	Popis	Hodnota
defaultValue	Výchozí hodnota parametru	řetězec
popis	Popis parametru	řetězec
Jméno	Název parametru	string (povinné)
požadovaný	Určuje, jestli je parametr povinný nebo ne.	Bool
typ	Typ parametru.	string (povinné)
hodnoty	Hodnoty parametrů.	string[]

RepresentationContract

Jméno	Popis	Hodnota
contentType	Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, např. application/xml.	string (povinné)
formParameters	Kolekce parametrů formuláře Povinný argument, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data.	ParametrContract[]
ukázka	Příklad reprezentace.	řetězec
schemaId	Identifikátor schématu. Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec
typeName	Název typu definovaný schématem Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec

RequestContract

Jméno	Popis	Hodnota
popis	Popis žádosti o operaci.	řetězec
hlavičky	Kolekce hlaviček požadavků operací	ParametrContract[]
queryParameters	Kolekce parametrů dotazu požadavku na operace	ParametrContract[]
reprezentace	Kolekce reprezentací žádostí o operaci	RepresentationContract[]

ResponseContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
hlavičky	Kolekce hlaviček odpovědí operací	ParametrContract[]
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	int (povinné)

Definice prostředku šablony ARM

Typ prostředku služby/apis/operations je možné nasadit s operacemi, 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í JSON.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2020-12-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "string",
    "request": {
      "description": "string",
      "headers": [
        {
          "defaultValue": "string",
          "description": "string",
          "name": "string",
          "required": "bool",
          "type": "string",
          "values": [ "string" ]
        }
      ],
      "queryParameters": [
        {
          "defaultValue": "string",
          "description": "string",
          "name": "string",
          "required": "bool",
          "type": "string",
          "values": [ "string" ]
        }
      ],
      "representations": [
        {
          "contentType": "string",
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "name": "string",
              "required": "bool",
              "type": "string",
              "values": [ "string" ]
            }
          ],
          "sample": "string",
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "name": "string",
            "required": "bool",
            "type": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "name": "string",
                "required": "bool",
                "type": "string",
                "values": [ "string" ]
              }
            ],
            "sample": "string",
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	'2020-12-01'
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
vlastnosti	Vlastnosti kontraktu operace.	OperationContractProperties
typ	Typ prostředku	Microsoft.ApiManagement/service/apis/operations

OperationContractProperties

Jméno	Popis	Hodnota
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka =
displayName	Název operace.	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
politiky	Zásady operací	řetězec
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	ResponseContract[]
templateParameters	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}	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)

ParametrContract

Jméno	Popis	Hodnota
defaultValue	Výchozí hodnota parametru	řetězec
popis	Popis parametru	řetězec
Jméno	Název parametru	string (povinné)
požadovaný	Určuje, jestli je parametr povinný nebo ne.	Bool
typ	Typ parametru.	string (povinné)
hodnoty	Hodnoty parametrů.	string[]

RepresentationContract

Jméno	Popis	Hodnota
contentType	Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, např. application/xml.	string (povinné)
formParameters	Kolekce parametrů formuláře Povinný argument, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data.	ParametrContract[]
ukázka	Příklad reprezentace.	řetězec
schemaId	Identifikátor schématu. Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec
typeName	Název typu definovaný schématem Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec

RequestContract

Jméno	Popis	Hodnota
popis	Popis žádosti o operaci.	řetězec
hlavičky	Kolekce hlaviček požadavků operací	ParametrContract[]
queryParameters	Kolekce parametrů dotazu požadavku na operace	ParametrContract[]
reprezentace	Kolekce reprezentací žádostí o operaci	RepresentationContract[]

ResponseContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
hlavičky	Kolekce hlaviček odpovědí operací	ParametrContract[]
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	int (povinné)

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby/apis/operations je možné nasadit s operacemi, které cílí:

• 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@2020-12-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      method = "string"
      policies = "string"
      request = {
        description = "string"
        headers = [
          {
            defaultValue = "string"
            description = "string"
            name = "string"
            required = bool
            type = "string"
            values = [
              "string"
            ]
          }
        ]
        queryParameters = [
          {
            defaultValue = "string"
            description = "string"
            name = "string"
            required = bool
            type = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                name = "string"
                required = bool
                type = "string"
                values = [
                  "string"
                ]
              }
            ]
            sample = "string"
            schemaId = "string"
            typeName = "string"
          }
        ]
      }
      responses = [
        {
          description = "string"
          headers = [
            {
              defaultValue = "string"
              description = "string"
              name = "string"
              required = bool
              type = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  name = "string"
                  required = bool
                  type = "string"
                  values = [
                    "string"
                  ]
                }
              ]
              sample = "string"
              schemaId = "string"
              typeName = "string"
            }
          ]
          statusCode = int
        }
      ]
      templateParameters = [
        {
          defaultValue = "string"
          description = "string"
          name = "string"
          required = bool
          type = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: služba/ rozhraní API
vlastnosti	Vlastnosti kontraktu operace.	OperationContractProperties
typ	Typ prostředku	Microsoft.ApiManagement/service/apis/operations@2020-12-01

OperationContractProperties

Jméno	Popis	Hodnota
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka =
displayName	Název operace.	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
politiky	Zásady operací	řetězec
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	ResponseContract[]
templateParameters	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}	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 (povinné)

ParametrContract

Jméno	Popis	Hodnota
defaultValue	Výchozí hodnota parametru	řetězec
popis	Popis parametru	řetězec
Jméno	Název parametru	string (povinné)
požadovaný	Určuje, jestli je parametr povinný nebo ne.	Bool
typ	Typ parametru.	string (povinné)
hodnoty	Hodnoty parametrů.	string[]

RepresentationContract

Jméno	Popis	Hodnota
contentType	Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, např. application/xml.	string (povinné)
formParameters	Kolekce parametrů formuláře Povinný argument, pokud je hodnota contentType buď application/x-www-form-urlencoded, nebo multipart/form-data.	ParametrContract[]
ukázka	Příklad reprezentace.	řetězec
schemaId	Identifikátor schématu. Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec
typeName	Název typu definovaný schématem Platí pouze v případě, že hodnota contentType není "application/x-www-form-urlencoded" ani "multipart/form-data".	řetězec

RequestContract

Jméno	Popis	Hodnota
popis	Popis žádosti o operaci.	řetězec
hlavičky	Kolekce hlaviček požadavků operací	ParametrContract[]
queryParameters	Kolekce parametrů dotazu požadavku na operace	ParametrContract[]
reprezentace	Kolekce reprezentací žádostí o operaci	RepresentationContract[]

ResponseContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
hlavičky	Kolekce hlaviček odpovědí operací	ParametrContract[]
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	int (povinné)