Delen via


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

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

Eigenschapswaarden

Microsoft.ApiManagement/service/apis/operations

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

Beperkingen:
Maximale lengte =
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[^*#&+:<>?]+$ (vereist)
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: service/api's
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResultContract[]
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} snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
naam Parameternaam. tekenreeks (vereist)
Vereist of parameter vereist is of niet. Bool
type Parametertype. tekenreeks (vereist)
waarden Parameterwaarden. tekenreeks[]

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
monster Een voorbeeld van de weergave. snaar

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[]

ResultContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. Int

Beperkingen:
Minimumwaarde = 100
Maximumwaarde = 599 (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": "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"
}

Eigenschapswaarden

Microsoft.ApiManagement/service/apis/operations

Naam Beschrijving Waarde
apiVersion De API-versie '2016-10-10'
beschrijving Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. snaar

Beperkingen:
Maximale lengte =
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[^*#&+:<>?]+$ (vereist)
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResultContract[]
templateParameters Verzameling url-sjabloonparameters. ParameterContract[]
type Het resourcetype 'Microsoft.ApiManagement/service/apis/operations'
urlTemplate Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
naam Parameternaam. tekenreeks (vereist)
Vereist of parameter vereist is of niet. Bool
type Parametertype. tekenreeks (vereist)
waarden Parameterwaarden. tekenreeks[]

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
monster Een voorbeeld van de weergave. snaar

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[]

ResultContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. Int

Beperkingen:
Minimumwaarde = 100
Maximumwaarde = 599 (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@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"
}

Eigenschapswaarden

Microsoft.ApiManagement/service/apis/operations

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

Beperkingen:
Maximale lengte =
methode Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. tekenreeks (vereist)
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: service/API's
verzoek Een entiteit met aanvraaggegevens. RequestContract
Reacties Matrix van bewerkingsreacties. ResultContract[]
templateParameters Verzameling url-sjabloonparameters. ParameterContract[]
type Het resourcetype "Microsoft.ApiManagement/service/apis/operations@2016-10-10"
urlTemplate Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

ParameterContract

Naam Beschrijving Waarde
defaultValue Standaardparameterwaarde. snaar
beschrijving Parameterbeschrijving. snaar
naam Parameternaam. tekenreeks (vereist)
Vereist of parameter vereist is of niet. Bool
type Parametertype. tekenreeks (vereist)
waarden Parameterwaarden. tekenreeks[]

RepresentationContract

Naam Beschrijving Waarde
contentType Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. tekenreeks (vereist)
monster Een voorbeeld van de weergave. snaar

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[]

ResultContract

Naam Beschrijving Waarde
beschrijving Beschrijving van het antwoord van de bewerking. snaar
Vertegenwoordigingen Verzameling weergaven van bewerkingsreacties. RepresentationContract[]
statusCode HTTP-statuscode van het bewerkingsantwoord. Int

Beperkingen:
Minimumwaarde = 100
Maximumwaarde = 599 (vereist)