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

• neueste
• 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-Vorschau-
• 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-Ressourcendefinition

Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/operations

Name	Beschreibung	Wert
Beschreibung	Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.	Schnur Zwänge: Max. Länge =
Methode	Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Elternteil	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource vom Typ: Dienst/APIs
bitten	Eine Entität, die Anforderungsdetails enthält.	RequestContract-
Antworten	Array von Vorgangsantworten.	ResultContract[]
templateParameters	Sammlung von URL-Vorlagenparametern.	ParameterContract[]
urlTemplate	Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich)

ParameterContract

Name	Beschreibung	Wert
defaultValue	Standardwert.	Schnur
Beschreibung	Parameterbeschreibung.	Schnur
Name	Parametername.	Zeichenfolge (erforderlich)
Erforderlich	ob parameter erforderlich ist oder nicht.	Bool
Art	Parametertyp.	Zeichenfolge (erforderlich)
Werte	Parameterwerte.	string[]

RepresentationContract

Name	Beschreibung	Wert
contentType	Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml.	Zeichenfolge (erforderlich)
Probe	Ein Beispiel für die Darstellung.	Schnur

RequestContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsanforderung.	Schnur
Header	Sammlung von Vorgangsanforderungsheadern.	ParameterContract[]
queryParameters	Sammlung der Abfrageparameter der Vorgangsanforderung.	ParameterContract[]
darstellungen	Sammlung von Vorgangsanforderungsdarstellungen.	RepresentationContract[]

ResultContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsantwort.	Schnur
darstellungen	Sammlung von Vorgangsantwortdarstellungen.	RepresentationContract[]
statusCode	HTTP-Statuscode der Vorgangsantwort.	Int Zwänge: Min.-Wert = 100 Maximalwert = 599 (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.

{
  "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"
}

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/operations

Name	Beschreibung	Wert
apiVersion	Die API-Version	'2016-10-10'
Beschreibung	Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.	Schnur Zwänge: Max. Länge =
Methode	Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
bitten	Eine Entität, die Anforderungsdetails enthält.	RequestContract-
Antworten	Array von Vorgangsantworten.	ResultContract[]
templateParameters	Sammlung von URL-Vorlagenparametern.	ParameterContract[]
Art	Der Ressourcentyp	"Microsoft.ApiManagement/service/apis/operations"
urlTemplate	Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich)

ParameterContract

Name	Beschreibung	Wert
defaultValue	Standardwert.	Schnur
Beschreibung	Parameterbeschreibung.	Schnur
Name	Parametername.	Zeichenfolge (erforderlich)
Erforderlich	ob parameter erforderlich ist oder nicht.	Bool
Art	Parametertyp.	Zeichenfolge (erforderlich)
Werte	Parameterwerte.	string[]

RepresentationContract

Name	Beschreibung	Wert
contentType	Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml.	Zeichenfolge (erforderlich)
Probe	Ein Beispiel für die Darstellung.	Schnur

RequestContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsanforderung.	Schnur
Header	Sammlung von Vorgangsanforderungsheadern.	ParameterContract[]
queryParameters	Sammlung der Abfrageparameter der Vorgangsanforderung.	ParameterContract[]
darstellungen	Sammlung von Vorgangsanforderungsdarstellungen.	RepresentationContract[]

ResultContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsantwort.	Schnur
darstellungen	Sammlung von Vorgangsantwortdarstellungen.	RepresentationContract[]
statusCode	HTTP-Statuscode der Vorgangsantwort.	Int Zwänge: Min.-Wert = 100 Maximalwert = 599 (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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"
}

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/operations

Name	Beschreibung	Wert
Beschreibung	Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.	Schnur Zwänge: Max. Länge =
Methode	Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource des Typs: Dienst/APIs
bitten	Eine Entität, die Anforderungsdetails enthält.	RequestContract-
Antworten	Array von Vorgangsantworten.	ResultContract[]
templateParameters	Sammlung von URL-Vorlagenparametern.	ParameterContract[]
Art	Der Ressourcentyp	"Microsoft.ApiManagement/service/apis/operations@2016-10-10"
urlTemplate	Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich)

ParameterContract

Name	Beschreibung	Wert
defaultValue	Standardwert.	Schnur
Beschreibung	Parameterbeschreibung.	Schnur
Name	Parametername.	Zeichenfolge (erforderlich)
Erforderlich	ob parameter erforderlich ist oder nicht.	Bool
Art	Parametertyp.	Zeichenfolge (erforderlich)
Werte	Parameterwerte.	string[]

RepresentationContract

Name	Beschreibung	Wert
contentType	Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml.	Zeichenfolge (erforderlich)
Probe	Ein Beispiel für die Darstellung.	Schnur

RequestContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsanforderung.	Schnur
Header	Sammlung von Vorgangsanforderungsheadern.	ParameterContract[]
queryParameters	Sammlung der Abfrageparameter der Vorgangsanforderung.	ParameterContract[]
darstellungen	Sammlung von Vorgangsanforderungsdarstellungen.	RepresentationContract[]

ResultContract

Name	Beschreibung	Wert
Beschreibung	Beschreibung der Vorgangsantwort.	Schnur
darstellungen	Sammlung von Vorgangsantwortdarstellungen.	RepresentationContract[]
statusCode	HTTP-Statuscode der Vorgangsantwort.	Int Zwänge: Min.-Wert = 100 Maximalwert = 599 (erforderlich)