Microsoft.ApiManagement service/apis/operations 2016-07-07

• senaste
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep-resursdefinition

Resurstypen tjänst/apis/operations kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/operations-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2016-07-07' = {
  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'
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar.	sträng Begränsningar: Maxlängd = 1 000
metod	En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[^*#&+:<>?]+$ (krävs)
förälder	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen.	Symboliskt namn för resurs av typen: service/apis
begäran	En entitet som innehåller information om begäran.	RequestContract
Svaren	Matris med åtgärdssvar.	ResultContract[]
templateParameters	Samling url-mallparametrar.	ParameterContract[]
urlTemplate	Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date}	sträng Begränsningar: Min längd = 1 Maximal längd = 1 000 (krävs)

ParameterContract

Namn	Beskrivning	Värde
defaultValue	Standardparametervärde.	sträng
beskrivning	Parameterbeskrivning.	sträng
Namn	Parameternamn.	sträng (krävs)
krävs	om parametern krävs eller inte.	Bool
typ	Parametertyp.	sträng (krävs)
värden	Parametervärden.	string[]

RepresentationContract

Namn	Beskrivning	Värde
contentType	Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml.	sträng (krävs)
prov	Ett exempel på representationen.	sträng

RequestContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdsbegäran.	sträng
Headers	Samling med sidhuvuden för åtgärdsbegäran.	ParameterContract[]
queryParameters	Samling frågeparametrar för åtgärdsbegäran.	ParameterContract[]
kritiska anmärkningar	Samling av representationer av åtgärdsbegäran.	RepresentationContract[]

ResultContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdssvar.	sträng
kritiska anmärkningar	Samling av åtgärdssvarsrepresentationer.	RepresentationContract[]
statusCode	Http-statuskod för åtgärdssvar.	Int Begränsningar: Minsta värde = 100 Maxvärde = 599 (krävs)

Resursdefinition för ARM-mall

Resurstypen tjänst/apis/operations kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/operations-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2016-07-07",
  "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"
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2016-07-07'
beskrivning	Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar.	sträng Begränsningar: Maxlängd = 1 000
metod	En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[^*#&+:<>?]+$ (krävs)
begäran	En entitet som innehåller information om begäran.	RequestContract
Svaren	Matris med åtgärdssvar.	ResultContract[]
templateParameters	Samling url-mallparametrar.	ParameterContract[]
typ	Resurstypen	"Microsoft.ApiManagement/service/apis/operations"
urlTemplate	Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date}	sträng Begränsningar: Min längd = 1 Maximal längd = 1 000 (krävs)

ParameterContract

Namn	Beskrivning	Värde
defaultValue	Standardparametervärde.	sträng
beskrivning	Parameterbeskrivning.	sträng
Namn	Parameternamn.	sträng (krävs)
krävs	om parametern krävs eller inte.	Bool
typ	Parametertyp.	sträng (krävs)
värden	Parametervärden.	string[]

RepresentationContract

Namn	Beskrivning	Värde
contentType	Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml.	sträng (krävs)
prov	Ett exempel på representationen.	sträng

RequestContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdsbegäran.	sträng
Headers	Samling med sidhuvuden för åtgärdsbegäran.	ParameterContract[]
queryParameters	Samling frågeparametrar för åtgärdsbegäran.	ParameterContract[]
kritiska anmärkningar	Samling av representationer av åtgärdsbegäran.	RepresentationContract[]

ResultContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdssvar.	sträng
kritiska anmärkningar	Samling av åtgärdssvarsrepresentationer.	RepresentationContract[]
statusCode	Http-statuskod för åtgärdssvar.	Int Begränsningar: Minsta värde = 100 Maxvärde = 599 (krävs)

Användningsexempel

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/apis/operations kan distribueras med åtgärder som mål:

• Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/operations-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2016-07-07"
  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"
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar.	sträng Begränsningar: Maxlängd = 1 000
metod	En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[^*#&+:<>?]+$ (krävs)
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: service/apis
begäran	En entitet som innehåller information om begäran.	RequestContract
Svaren	Matris med åtgärdssvar.	ResultContract[]
templateParameters	Samling url-mallparametrar.	ParameterContract[]
typ	Resurstypen	"Microsoft.ApiManagement/service/apis/operations@2016-07-07"
urlTemplate	Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date}	sträng Begränsningar: Min längd = 1 Maximal längd = 1 000 (krävs)

ParameterContract

Namn	Beskrivning	Värde
defaultValue	Standardparametervärde.	sträng
beskrivning	Parameterbeskrivning.	sträng
Namn	Parameternamn.	sträng (krävs)
krävs	om parametern krävs eller inte.	Bool
typ	Parametertyp.	sträng (krävs)
värden	Parametervärden.	string[]

RepresentationContract

Namn	Beskrivning	Värde
contentType	Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml.	sträng (krävs)
prov	Ett exempel på representationen.	sträng

RequestContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdsbegäran.	sträng
Headers	Samling med sidhuvuden för åtgärdsbegäran.	ParameterContract[]
queryParameters	Samling frågeparametrar för åtgärdsbegäran.	ParameterContract[]
kritiska anmärkningar	Samling av representationer av åtgärdsbegäran.	RepresentationContract[]

ResultContract

Namn	Beskrivning	Värde
beskrivning	Beskrivning av åtgärdssvar.	sträng
kritiska anmärkningar	Samling av åtgärdssvarsrepresentationer.	RepresentationContract[]
statusCode	Http-statuskod för åtgärdssvar.	Int Begränsningar: Minsta värde = 100 Maxvärde = 599 (krävs)