Služba Microsoft.ApiManagement/apis/operations 2016-10-10

Článek
12/21/2024

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@2016-10-10' = {
  parent: resourceSymbolicName
  description: 'string'
  method: 'string'
  name: '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'
        sample: 'string'
      }
    ]
  }
  responses: [
    {
      description: 'string'
      representations: [
        {
          contentType: 'string'
          sample: '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
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka = 1000
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = `^[^*#&+:<>?]+$` (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
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	resultContract[]
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 = 1000 (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ý	bez ohledu na to, 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é)
ukázka	Příklad reprezentace.	ř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[]

ResultContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	Int Omezení: Minimální hodnota = 100 Maximální hodnota = 599 (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": "2016-10-10",
  "name": "string",
  "description": "string",
  "method": "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",
        "sample": "string"
      }
    ]
  },
  "responses": [
    {
      "description": "string",
      "representations": [
        {
          "contentType": "string",
          "sample": "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	'2016-10-10'
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka = 1000
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = `^[^*#&+:<>?]+$` (povinné)
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	resultContract[]
templateParameters	Kolekce parametrů šablony adresy URL	ParametrContract[]
typ	Typ prostředku	Microsoft.ApiManagement/service/apis/operations
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 = 1000 (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ý	bez ohledu na to, 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é)
ukázka	Příklad reprezentace.	ř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[]

ResultContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	Int Omezení: Minimální hodnota = 100 Maximální hodnota = 599 (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@2016-10-10"
  name = "string"
  description = "string"
  method = "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"
        sample = "string"
      }
    ]
  }
  responses = [
    {
      description = "string"
      representations = [
        {
          contentType = "string"
          sample = "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
popis	Popis operace Může obsahovat značky formátování HTML.	řetězec Omezení: Maximální délka = 1000
metoda	Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = `^[^*#&+:<>?]+$` (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: služba/ rozhraní API
prosba	Entita obsahující podrobnosti žádosti.	RequestContract
odpovědi	Pole odpovědí operací.	resultContract[]
templateParameters	Kolekce parametrů šablony adresy URL	ParametrContract[]
typ	Typ prostředku	"Microsoft.ApiManagement/service/apis/operations@2016-10-10"
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 = 1000 (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ý	bez ohledu na to, 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é)
ukázka	Příklad reprezentace.	ř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[]

ResultContract

Jméno	Popis	Hodnota
popis	Popis odpovědi operace.	řetězec
reprezentace	Kolekce reprezentací odpovědí operací	RepresentationContract[]
statusCode	Stavový kód HTTP odpovědi operace.	Int Omezení: Minimální hodnota = 100 Maximální hodnota = 599 (povinné)

Sdílet prostřednictvím

Služba Microsoft.ApiManagement/apis/operations 2016-10-10

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

ParametrContract

RepresentationContract

RequestContract

ResultContract

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

ParametrContract

RepresentationContract

RequestContract

ResultContract

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

Microsoft.ApiManagement/service/apis/operations

ParametrContract

RepresentationContract

RequestContract

ResultContract

Váš názor

Další materiály