Dela via

Microsoft.ApiManagement service/apis/operations 2017-03-01

  • Artikel

Bicep-resursdefinition

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

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@2017-03-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'
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
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
Egenskaper Egenskaper för åtgärdskontraktet. OperationContractProperties

OperationContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. sträng

Begränsningar:
Max längd =
displayName Åtgärdsnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
metod En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. sträng (krävs)
Politik Åtgärdsprinciper sträng
begäran En entitet som innehåller information om begäran. RequestContract
Svaren Matris med åtgärdssvar. ResponseContract[]
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 (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)
formParametrar Insamling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". ParameterContract[]
prov Ett exempel på representationen. sträng
schemaId Schemaidentifierare. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". sträng
typeName Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". 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[]

ResponseContract

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärdssvar. sträng
Headers Samling av åtgärdssvarshuvuden. ParameterContract[]
kritiska anmärkningar Samling av åtgärdssvarsrepresentationer. RepresentationContract[]
statusCode Http-statuskod för åtgärdssvar. int (krävs)

Resursdefinition för ARM-mall

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

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": "2017-03-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"
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn Beskrivning Värde
apiVersion API-versionen '2017-03-01'
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
Egenskaper Egenskaper för åtgärdskontraktet. OperationContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/operations"

OperationContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. sträng

Begränsningar:
Max längd =
displayName Åtgärdsnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
metod En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. sträng (krävs)
Politik Åtgärdsprinciper sträng
begäran En entitet som innehåller information om begäran. RequestContract
Svaren Matris med åtgärdssvar. ResponseContract[]
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 (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)
formParametrar Insamling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". ParameterContract[]
prov Ett exempel på representationen. sträng
schemaId Schemaidentifierare. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". sträng
typeName Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". 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[]

ResponseContract

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärdssvar. sträng
Headers Samling av åtgärdssvarshuvuden. ParameterContract[]
kritiska anmärkningar Samling av åtgärdssvarsrepresentationer. RepresentationContract[]
statusCode Http-statuskod för åtgärdssvar. int (krävs)

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@2017-03-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"
    }
  })
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/operations

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
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
Egenskaper Egenskaper för åtgärdskontraktet. OperationContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/operations@2017-03-01"

OperationContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. sträng

Begränsningar:
Max längd =
displayName Åtgärdsnamn. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
metod En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. sträng (krävs)
Politik Åtgärdsprinciper sträng
begäran En entitet som innehåller information om begäran. RequestContract
Svaren Matris med åtgärdssvar. ResponseContract[]
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 (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)
formParametrar Insamling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". ParameterContract[]
prov Ett exempel på representationen. sträng
schemaId Schemaidentifierare. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". sträng
typeName Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". 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[]

ResponseContract

Namn Beskrivning Värde
beskrivning Beskrivning av åtgärdssvar. sträng
Headers Samling av åtgärdssvarshuvuden. ParameterContract[]
kritiska anmärkningar Samling av åtgärdssvarsrepresentationer. RepresentationContract[]
statusCode Http-statuskod för åtgärdssvar. int (krävs)