Udostępnij za pośrednictwem

Microsoft.ApiManagement service/apis/operations 2018-06-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu service/apis/operations można wdrożyć przy użyciu operacji, które są przeznaczone dla:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/operations, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2018-06-01-preview' = {
  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'
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/apis/operations

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: service/apis
Właściwości Właściwości kontraktu operacji. OperationContractProperties

OperationContractProperties

Nazwa Opis Wartość
opis Opis operacji. Może zawierać tagi formatowania HTML. struna

Ograniczenia:
Maksymalna długość =
displayName Nazwa operacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
metoda Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie. ciąg (wymagany)
manifest Zasady operacji struna
prosić Jednostka zawierająca szczegóły żądania. RequestContract
Odpowiedzi Tablica odpowiedzi operacji. ResponseContract[]
templateParameters Kolekcja parametrów szablonu adresu URL. ParameterContract[]
urlTemplate Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date} struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

ParametrContract

Nazwa Opis Wartość
defaultValue Wartość parametru domyślnego. struna
opis Opis parametru. struna
nazwa Nazwa parametru. ciąg (wymagany)
Wymagane czy parametr jest wymagany, czy nie. Bool
typ Typ parametru. ciąg (wymagany)
Wartości Wartości parametrów. string[]

ReprezentacjaKontract

Nazwa Opis Wartość
contentType Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, np. application/xml. ciąg (wymagany)
formParameters Kolekcja parametrów formularza. Wymagane, jeśli wartość "contentType" to "application/x-www-form-urlencoded" lub "multipart/form-data". ParameterContract[]
próbka Przykład reprezentacji. struna
schemaId Identyfikator schematu. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna
typeName Nazwa typu zdefiniowana przez schemat. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna

RequestContract

Nazwa Opis Wartość
opis Opis żądania operacji. struna
Nagłówki Kolekcja nagłówków żądań operacji. ParameterContract[]
queryParameters Kolekcja parametrów zapytania żądania operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji żądań operacji. RepresentationContract[]

ResponseContract

Nazwa Opis Wartość
opis Opis odpowiedzi operacji. struna
Nagłówki Kolekcja nagłówków odpowiedzi operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji odpowiedzi operacji. RepresentationContract[]
statusCode Kod stanu HTTP odpowiedzi operacji. int (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu service/apis/operations można wdrożyć przy użyciu operacji, które są przeznaczone dla:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/operations, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2018-06-01-preview",
  "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"
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/apis/operations

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2018-06-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości kontraktu operacji. OperationContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apis/operations"

OperationContractProperties

Nazwa Opis Wartość
opis Opis operacji. Może zawierać tagi formatowania HTML. struna

Ograniczenia:
Maksymalna długość =
displayName Nazwa operacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
metoda Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie. ciąg (wymagany)
manifest Zasady operacji struna
prosić Jednostka zawierająca szczegóły żądania. RequestContract
Odpowiedzi Tablica odpowiedzi operacji. ResponseContract[]
templateParameters Kolekcja parametrów szablonu adresu URL. ParameterContract[]
urlTemplate Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date} struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

ParametrContract

Nazwa Opis Wartość
defaultValue Wartość parametru domyślnego. struna
opis Opis parametru. struna
nazwa Nazwa parametru. ciąg (wymagany)
Wymagane czy parametr jest wymagany, czy nie. Bool
typ Typ parametru. ciąg (wymagany)
Wartości Wartości parametrów. string[]

ReprezentacjaKontract

Nazwa Opis Wartość
contentType Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, np. application/xml. ciąg (wymagany)
formParameters Kolekcja parametrów formularza. Wymagane, jeśli wartość "contentType" to "application/x-www-form-urlencoded" lub "multipart/form-data". ParameterContract[]
próbka Przykład reprezentacji. struna
schemaId Identyfikator schematu. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna
typeName Nazwa typu zdefiniowana przez schemat. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna

RequestContract

Nazwa Opis Wartość
opis Opis żądania operacji. struna
Nagłówki Kolekcja nagłówków żądań operacji. ParameterContract[]
queryParameters Kolekcja parametrów zapytania żądania operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji żądań operacji. RepresentationContract[]

ResponseContract

Nazwa Opis Wartość
opis Opis odpowiedzi operacji. struna
Nagłówki Kolekcja nagłówków odpowiedzi operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji odpowiedzi operacji. RepresentationContract[]
statusCode Kod stanu HTTP odpowiedzi operacji. int (wymagane)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/apis/operations można wdrożyć przy użyciu operacji, które są przeznaczone dla:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/operations, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2018-06-01-preview"
  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"
    }
  })
}

Wartości właściwości

Microsoft.ApiManagement/service/apis/operations

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: service/apis
Właściwości Właściwości kontraktu operacji. OperationContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apis/operations@2018-06-01-preview"

OperationContractProperties

Nazwa Opis Wartość
opis Opis operacji. Może zawierać tagi formatowania HTML. struna

Ograniczenia:
Maksymalna długość =
displayName Nazwa operacji. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
metoda Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie. ciąg (wymagany)
manifest Zasady operacji struna
prosić Jednostka zawierająca szczegóły żądania. RequestContract
Odpowiedzi Tablica odpowiedzi operacji. ResponseContract[]
templateParameters Kolekcja parametrów szablonu adresu URL. ParameterContract[]
urlTemplate Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date} struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

ParametrContract

Nazwa Opis Wartość
defaultValue Wartość parametru domyślnego. struna
opis Opis parametru. struna
nazwa Nazwa parametru. ciąg (wymagany)
Wymagane czy parametr jest wymagany, czy nie. Bool
typ Typ parametru. ciąg (wymagany)
Wartości Wartości parametrów. string[]

ReprezentacjaKontract

Nazwa Opis Wartość
contentType Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, np. application/xml. ciąg (wymagany)
formParameters Kolekcja parametrów formularza. Wymagane, jeśli wartość "contentType" to "application/x-www-form-urlencoded" lub "multipart/form-data". ParameterContract[]
próbka Przykład reprezentacji. struna
schemaId Identyfikator schematu. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna
typeName Nazwa typu zdefiniowana przez schemat. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data". struna

RequestContract

Nazwa Opis Wartość
opis Opis żądania operacji. struna
Nagłówki Kolekcja nagłówków żądań operacji. ParameterContract[]
queryParameters Kolekcja parametrów zapytania żądania operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji żądań operacji. RepresentationContract[]

ResponseContract

Nazwa Opis Wartość
opis Opis odpowiedzi operacji. struna
Nagłówki Kolekcja nagłówków odpowiedzi operacji. ParameterContract[]
Reprezentacje Kolekcja reprezentacji odpowiedzi operacji. RepresentationContract[]
statusCode Kod stanu HTTP odpowiedzi operacji. int (wymagane)