Delen via

Microsoft.ApiManagement-service/apis/operations

  • Artikel

Bicep-resourcedefinitie

Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-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()
            }
          }
          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()
            }
          }
          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()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {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()
              }
            }
            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()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {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()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Eigenschapswaarden

service/apis/operations

Naam Beschrijving Waarde
naam De resourcenaam

Zie hoe u namen en typen instelt voor onderliggende resources in Bicep-.		 tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: API's
Eigenschappen Eigenschappen van het bewerkingscontract. OperationContractProperties-

OperationContractProperties

Naam Beschrijving Waarde
beschrijving Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. snaar

Beperkingen:
Maximale lengte = 1000
displayName Bewerkingsnaam. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 300
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
Beleid Bewerkingsbeleid snaar
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResponseContract[]
templateParameters Verzameling url-sjabloonparameters. ParameterContract[]
urlTemplate Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1000

RequestContract

Naam Beschrijving Waarde
beschrijving Beschrijving van bewerkingsaanvraag. snaar
Headers Verzameling aanvraagheaders voor bewerkingen. ParameterContract[]
queryParameters Verzameling queryparameters voor bewerkingsaanvragen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsaanvragen. RepresentationContract[]

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
Voorbeelden Voorbeeld gedefinieerd voor de parameter. ParameterExamplesContract
naam Parameternaam. tekenreeks (vereist)
Vereist Hiermee geeft u op of parameter is vereist of niet. Bool
schemaId Schema-id. snaar
type Parametertype. tekenreeks (vereist)
typeName Typ de naam die is gedefinieerd door het schema. snaar
waarden Parameterwaarden. tekenreeks[]

ParameterExamplesContract

Naam Beschrijving Waarde
{aangepaste eigenschap} ParameterExampleContract

ParameterExampleContract

Naam Beschrijving Waarde
beschrijving Lange beschrijving voor het voorbeeld snaar
externalValue Een URL die verwijst naar het letterlijke voorbeeld snaar
samenvatting Korte beschrijving voor het voorbeeld snaar
waarde Voorbeeldwaarde. Dit kan een primitieve waarde of een object zijn. Voor Bicep kunt u de functie any() gebruiken.

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
Voorbeelden Voorbeeld gedefinieerd voor de weergave. ParameterExamplesContract
formParameters Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. ParameterContract[]
schemaId Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar
typeName Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar

ResponseContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Headers Verzameling antwoordheaders voor bewerkingen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. int (vereist)

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2023-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": {}
            }
          },
          "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": {}
            }
          },
          "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": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{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": {}
              }
            },
            "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": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{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": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Eigenschapswaarden

service/apis/operations

Naam Beschrijving Waarde
type Het resourcetype 'Microsoft.ApiManagement/service/apis/operations'
apiVersion De versie van de resource-API '2023-09-01-preview'
naam De resourcenaam

Zie hoe u namen en typen instelt voor onderliggende resources in JSON ARM-sjablonen.		 tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.
Eigenschappen Eigenschappen van het bewerkingscontract. OperationContractProperties-

OperationContractProperties

Naam Beschrijving Waarde
beschrijving Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. snaar

Beperkingen:
Maximale lengte = 1000
displayName Bewerkingsnaam. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 300
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
Beleid Bewerkingsbeleid snaar
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResponseContract[]
templateParameters Verzameling url-sjabloonparameters. ParameterContract[]
urlTemplate Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1000

RequestContract

Naam Beschrijving Waarde
beschrijving Beschrijving van bewerkingsaanvraag. snaar
Headers Verzameling aanvraagheaders voor bewerkingen. ParameterContract[]
queryParameters Verzameling queryparameters voor bewerkingsaanvragen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsaanvragen. RepresentationContract[]

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
Voorbeelden Voorbeeld gedefinieerd voor de parameter. ParameterExamplesContract
naam Parameternaam. tekenreeks (vereist)
Vereist Hiermee geeft u op of parameter is vereist of niet. Bool
schemaId Schema-id. snaar
type Parametertype. tekenreeks (vereist)
typeName Typ de naam die is gedefinieerd door het schema. snaar
waarden Parameterwaarden. tekenreeks[]

ParameterExamplesContract

Naam Beschrijving Waarde
{aangepaste eigenschap} ParameterExampleContract

ParameterExampleContract

Naam Beschrijving Waarde
beschrijving Lange beschrijving voor het voorbeeld snaar
externalValue Een URL die verwijst naar het letterlijke voorbeeld snaar
samenvatting Korte beschrijving voor het voorbeeld snaar
waarde Voorbeeldwaarde. Dit kan een primitieve waarde of een object zijn.

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
Voorbeelden Voorbeeld gedefinieerd voor de weergave. ParameterExamplesContract
formParameters Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. ParameterContract[]
schemaId Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar
typeName Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar

ResponseContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Headers Verzameling antwoordheaders voor bewerkingen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. int (vereist)

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2023-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"
              }
            }
            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"
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {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"
                }
              }
              name = "string"
              required = bool
              schemaId = "string"
              type = "string"
              typeName = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {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"
            }
          }
          name = "string"
          required = bool
          schemaId = "string"
          type = "string"
          typeName = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Eigenschapswaarden

service/apis/operations

Naam Beschrijving Waarde
type Het resourcetype "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-80

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: API's
Eigenschappen Eigenschappen van het bewerkingscontract. OperationContractProperties-

OperationContractProperties

Naam Beschrijving Waarde
beschrijving Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. snaar

Beperkingen:
Maximale lengte = 1000
displayName Bewerkingsnaam. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 300
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
Beleid Bewerkingsbeleid snaar
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResponseContract[]
templateParameters Verzameling url-sjabloonparameters. ParameterContract[]
urlTemplate Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1000

RequestContract

Naam Beschrijving Waarde
beschrijving Beschrijving van bewerkingsaanvraag. snaar
Headers Verzameling aanvraagheaders voor bewerkingen. ParameterContract[]
queryParameters Verzameling queryparameters voor bewerkingsaanvragen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsaanvragen. RepresentationContract[]

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
Voorbeelden Voorbeeld gedefinieerd voor de parameter. ParameterExamplesContract
naam Parameternaam. tekenreeks (vereist)
Vereist Hiermee geeft u op of parameter is vereist of niet. Bool
schemaId Schema-id. snaar
type Parametertype. tekenreeks (vereist)
typeName Typ de naam die is gedefinieerd door het schema. snaar
waarden Parameterwaarden. tekenreeks[]

ParameterExamplesContract

Naam Beschrijving Waarde
{aangepaste eigenschap} ParameterExampleContract

ParameterExampleContract

Naam Beschrijving Waarde
beschrijving Lange beschrijving voor het voorbeeld snaar
externalValue Een URL die verwijst naar het letterlijke voorbeeld snaar
samenvatting Korte beschrijving voor het voorbeeld snaar
waarde Voorbeeldwaarde. Dit kan een primitieve waarde of een object zijn.

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
Voorbeelden Voorbeeld gedefinieerd voor de weergave. ParameterExamplesContract
formParameters Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. ParameterContract[]
schemaId Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar
typeName Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. snaar

ResponseContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Headers Verzameling antwoordheaders voor bewerkingen. ParameterContract[]
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. int (vereist)