다음을 통해 공유

Microsoft.ApiManagement 서비스/작업 영역/api/operations

  • 아티클

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/operations 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/operations 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/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'
  }
}

속성 값

service/workspaces/api/operations

이름 묘사 값
이름 리소스 이름

Bicep자식 리소스의 이름과 형식을 설정하는 방법을 알아보세요.		 string(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식의 리소스에 대한 기호 이름: api
속성 작업 계약의 속성입니다. OperationContractProperties

OperationContractProperties

이름 묘사 값
묘사 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열

제약 조건:
최대 길이 = 1000
displayName 작업 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 300
메서드 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. string(필수)
선언 작업 정책 문자열
요청 요청 세부 정보가 포함된 엔터티입니다. RequestContract
응답 작업 응답의 배열입니다. ResponseContract[]
templateParameters URL 템플릿 매개 변수의 컬렉션입니다. ParameterContract[]
urlTemplate 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 1000

RequestContract

이름 묘사 값
묘사 작업 요청 설명입니다. 문자열
헤더 작업 요청 헤더의 컬렉션입니다. ParameterContract[]
queryParameters 작업 요청 쿼리 매개 변수의 컬렉션입니다. ParameterContract[]
표현 작업 요청 표현의 컬렉션입니다. RepresentationContract[]

ParameterContract

이름 묘사 값
defaultValue 기본 매개 변수 값입니다. 문자열
묘사 매개 변수 설명입니다. 문자열
예제 매개 변수에 대해 정의된 예제입니다. ParameterExamplesContract
이름 매개 변수 이름입니다. string(필수)
필수 매개 변수가 필요한지 여부를 지정합니다. bool
schemaId 스키마 식별자입니다. 문자열
형 매개 변수 형식입니다. string(필수)
typeName 스키마에서 정의한 형식 이름입니다. 문자열
값 매개 변수 값입니다. string[]

ParameterExamplesContract

이름 묘사 값
{customized property} ParameterExampleContract

ParameterExampleContract

이름 묘사 값
묘사 예제에 대한 자세한 설명 문자열
externalValue 리터럴 예제를 가리키는 URL 문자열
요약 예제에 대한 간단한 설명 문자열
값 예제 값입니다. 기본 값 또는 개체일 수 있습니다. Bicep의 경우 any() 함수를 사용할 수 있습니다.

RepresentationContract

이름 묘사 값
contentType 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. string(필수)
예제 표현에 대해 정의된 예제입니다. ParameterExamplesContract
formParameters 양식 매개 변수의 컬렉션입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'인 경우 필요합니다. ParameterContract[]
schemaId 스키마 식별자입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열
typeName 스키마에서 정의한 형식 이름입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열

ResponseContract

이름 묘사 값
묘사 작업 응답 설명입니다. 문자열
헤더 작업 응답 헤더의 컬렉션입니다. ParameterContract[]
표현 작업 응답 표현의 컬렉션입니다. RepresentationContract[]
statusCode 작업 응답 HTTP 상태 코드입니다. int(필수)

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/operations 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/operations 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.ApiManagement/service/workspaces/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"
  }
}

속성 값

service/workspaces/api/operations

이름 묘사 값
형 리소스 종류 'Microsoft.ApiManagement/service/workspaces/api/operations'
apiVersion 리소스 api 버전 '2023-09-01-preview'
이름 리소스 이름

JSON ARM 템플릿자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.		 string(필수)
속성 작업 계약의 속성입니다. OperationContractProperties

OperationContractProperties

이름 묘사 값
묘사 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열

제약 조건:
최대 길이 = 1000
displayName 작업 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 300
메서드 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. string(필수)
선언 작업 정책 문자열
요청 요청 세부 정보가 포함된 엔터티입니다. RequestContract
응답 작업 응답의 배열입니다. ResponseContract[]
templateParameters URL 템플릿 매개 변수의 컬렉션입니다. ParameterContract[]
urlTemplate 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 1000

RequestContract

이름 묘사 값
묘사 작업 요청 설명입니다. 문자열
헤더 작업 요청 헤더의 컬렉션입니다. ParameterContract[]
queryParameters 작업 요청 쿼리 매개 변수의 컬렉션입니다. ParameterContract[]
표현 작업 요청 표현의 컬렉션입니다. RepresentationContract[]

ParameterContract

이름 묘사 값
defaultValue 기본 매개 변수 값입니다. 문자열
묘사 매개 변수 설명입니다. 문자열
예제 매개 변수에 대해 정의된 예제입니다. ParameterExamplesContract
이름 매개 변수 이름입니다. string(필수)
필수 매개 변수가 필요한지 여부를 지정합니다. bool
schemaId 스키마 식별자입니다. 문자열
형 매개 변수 형식입니다. string(필수)
typeName 스키마에서 정의한 형식 이름입니다. 문자열
값 매개 변수 값입니다. string[]

ParameterExamplesContract

이름 묘사 값
{customized property} ParameterExampleContract

ParameterExampleContract

이름 묘사 값
묘사 예제에 대한 자세한 설명 문자열
externalValue 리터럴 예제를 가리키는 URL 문자열
요약 예제에 대한 간단한 설명 문자열
값 예제 값입니다. 기본 값 또는 개체일 수 있습니다.

RepresentationContract

이름 묘사 값
contentType 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. string(필수)
예제 표현에 대해 정의된 예제입니다. ParameterExamplesContract
formParameters 양식 매개 변수의 컬렉션입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'인 경우 필요합니다. ParameterContract[]
schemaId 스키마 식별자입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열
typeName 스키마에서 정의한 형식 이름입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열

ResponseContract

이름 묘사 값
묘사 작업 응답 설명입니다. 문자열
헤더 작업 응답 헤더의 컬렉션입니다. ParameterContract[]
표현 작업 응답 표현의 컬렉션입니다. RepresentationContract[]
statusCode 작업 응답 HTTP 상태 코드입니다. int(필수)

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/operations 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/operations 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/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"
    }
  })
}

속성 값

service/workspaces/api/operations

이름 묘사 값
형 리소스 종류 "Microsoft.ApiManagement/service/workspaces/api/operations@2023-09-01-preview"
이름 리소스 이름 string(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: api
속성 작업 계약의 속성입니다. OperationContractProperties

OperationContractProperties

이름 묘사 값
묘사 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열

제약 조건:
최대 길이 = 1000
displayName 작업 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 300
메서드 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. string(필수)
선언 작업 정책 문자열
요청 요청 세부 정보가 포함된 엔터티입니다. RequestContract
응답 작업 응답의 배열입니다. ResponseContract[]
templateParameters URL 템플릿 매개 변수의 컬렉션입니다. ParameterContract[]
urlTemplate 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 1000

RequestContract

이름 묘사 값
묘사 작업 요청 설명입니다. 문자열
헤더 작업 요청 헤더의 컬렉션입니다. ParameterContract[]
queryParameters 작업 요청 쿼리 매개 변수의 컬렉션입니다. ParameterContract[]
표현 작업 요청 표현의 컬렉션입니다. RepresentationContract[]

ParameterContract

이름 묘사 값
defaultValue 기본 매개 변수 값입니다. 문자열
묘사 매개 변수 설명입니다. 문자열
예제 매개 변수에 대해 정의된 예제입니다. ParameterExamplesContract
이름 매개 변수 이름입니다. string(필수)
필수 매개 변수가 필요한지 여부를 지정합니다. bool
schemaId 스키마 식별자입니다. 문자열
형 매개 변수 형식입니다. string(필수)
typeName 스키마에서 정의한 형식 이름입니다. 문자열
값 매개 변수 값입니다. string[]

ParameterExamplesContract

이름 묘사 값
{customized property} ParameterExampleContract

ParameterExampleContract

이름 묘사 값
묘사 예제에 대한 자세한 설명 문자열
externalValue 리터럴 예제를 가리키는 URL 문자열
요약 예제에 대한 간단한 설명 문자열
값 예제 값입니다. 기본 값 또는 개체일 수 있습니다.

RepresentationContract

이름 묘사 값
contentType 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. string(필수)
예제 표현에 대해 정의된 예제입니다. ParameterExamplesContract
formParameters 양식 매개 변수의 컬렉션입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'인 경우 필요합니다. ParameterContract[]
schemaId 스키마 식별자입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열
typeName 스키마에서 정의한 형식 이름입니다. 'contentType' 값이 'application/x-www-form-urlencoded' 또는 'multipart/form-data'가 아니면 적용할 수 있습니다. 문자열

ResponseContract

이름 묘사 값
묘사 작업 응답 설명입니다. 문자열
헤더 작업 응답 헤더의 컬렉션입니다. ParameterContract[]
표현 작업 응답 표현의 컬렉션입니다. RepresentationContract[]
statusCode 작업 응답 HTTP 상태 코드입니다. int(필수)