Microsoft.ApiManagement 서비스/api/operations 2020-12-01
- 최신
- 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-preview
- 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 리소스 정의
다음을 대상으로 하는 작업으로 서비스/api/operations 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api/operations 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2020-12-01' = {
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'
}
}
속성 값
Microsoft.ApiManagement/service/api/operations
| 이름 | 묘사 | 값 |
|---|---|---|
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80(필수) |
| 부모 | Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 |
형식 리소스의 기호 이름: 서비스/api |
| 속성 | 작업 계약의 속성입니다. | OperationContractProperties |
OperationContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = 1000 |
| displayName | 작업 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 300(필수) |
| 메서드 | 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. | string(필수) |
| 선언 | 작업 정책 | 문자열 |
| 요청 | 요청 세부 정보가 포함된 엔터티입니다. | RequestContract |
| 응답 | 작업 응답의 배열입니다. | ResponseContract[] |
| templateParameters | URL 템플릿 매개 변수의 컬렉션입니다. | ParameterContract[] |
| urlTemplate | 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1000(필수) |
ParameterContract
| 이름 | 묘사 | 값 |
|---|---|---|
| defaultValue | 기본 매개 변수 값입니다. | 문자열 |
| 묘사 | 매개 변수 설명입니다. | 문자열 |
| 이름 | 매개 변수 이름입니다. | string(필수) |
| 필수 | 매개 변수가 필요한지 여부를 지정합니다. | bool |
| 형 | 매개 변수 형식입니다. | string(필수) |
| 값 | 매개 변수 값입니다. | string[] |
RepresentationContract
| 이름 | 묘사 | 값 |
|---|---|---|
| contentType | 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. | string(필수) |
| 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'가 아니면 적용할 수 있습니다. | 문자열 |
RequestContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 요청 설명입니다. | 문자열 |
| 헤더 | 작업 요청 헤더의 컬렉션입니다. | ParameterContract[] |
| queryParameters | 작업 요청 쿼리 매개 변수의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 요청 표현의 컬렉션입니다. | RepresentationContract[] |
ResponseContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 응답 설명입니다. | 문자열 |
| 헤더 | 작업 응답 헤더의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 응답 표현의 컬렉션입니다. | RepresentationContract[] |
| statusCode | 작업 응답 HTTP 상태 코드입니다. | int(필수) |
ARM 템플릿 리소스 정의
다음을 대상으로 하는 작업으로 서비스/api/operations 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api/operations 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2020-12-01",
"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"
}
}
속성 값
Microsoft.ApiManagement/service/api/operations
| 이름 | 묘사 | 값 |
|---|---|---|
| apiVersion | api 버전 | '2020-12-01' |
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80(필수) |
| 속성 | 작업 계약의 속성입니다. | OperationContractProperties |
| 형 | 리소스 종류 | 'Microsoft.ApiManagement/service/api/operations' |
OperationContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = 1000 |
| displayName | 작업 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 300(필수) |
| 메서드 | 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. | string(필수) |
| 선언 | 작업 정책 | 문자열 |
| 요청 | 요청 세부 정보가 포함된 엔터티입니다. | RequestContract |
| 응답 | 작업 응답의 배열입니다. | ResponseContract[] |
| templateParameters | URL 템플릿 매개 변수의 컬렉션입니다. | ParameterContract[] |
| urlTemplate | 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1000(필수) |
ParameterContract
| 이름 | 묘사 | 값 |
|---|---|---|
| defaultValue | 기본 매개 변수 값입니다. | 문자열 |
| 묘사 | 매개 변수 설명입니다. | 문자열 |
| 이름 | 매개 변수 이름입니다. | string(필수) |
| 필수 | 매개 변수가 필요한지 여부를 지정합니다. | bool |
| 형 | 매개 변수 형식입니다. | string(필수) |
| 값 | 매개 변수 값입니다. | string[] |
RepresentationContract
| 이름 | 묘사 | 값 |
|---|---|---|
| contentType | 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. | string(필수) |
| 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'가 아니면 적용할 수 있습니다. | 문자열 |
RequestContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 요청 설명입니다. | 문자열 |
| 헤더 | 작업 요청 헤더의 컬렉션입니다. | ParameterContract[] |
| queryParameters | 작업 요청 쿼리 매개 변수의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 요청 표현의 컬렉션입니다. | RepresentationContract[] |
ResponseContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 응답 설명입니다. | 문자열 |
| 헤더 | 작업 응답 헤더의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 응답 표현의 컬렉션입니다. | RepresentationContract[] |
| statusCode | 작업 응답 HTTP 상태 코드입니다. | int(필수) |
Terraform(AzAPI 공급자) 리소스 정의
다음을 대상으로 하는 작업으로 서비스/api/operations 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api/operations 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2020-12-01"
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"
}
})
}
속성 값
Microsoft.ApiManagement/service/api/operations
| 이름 | 묘사 | 값 |
|---|---|---|
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80(필수) |
| parent_id | 이 리소스의 부모인 리소스의 ID입니다. | 유형의 리소스에 대한 ID: 서비스/api |
| 속성 | 작업 계약의 속성입니다. | OperationContractProperties |
| 형 | 리소스 종류 | "Microsoft.ApiManagement/service/api/operations@2020-12-01" |
OperationContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = 1000 |
| displayName | 작업 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 300(필수) |
| 메서드 | 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다. | string(필수) |
| 선언 | 작업 정책 | 문자열 |
| 요청 | 요청 세부 정보가 포함된 엔터티입니다. | RequestContract |
| 응답 | 작업 응답의 배열입니다. | ResponseContract[] |
| templateParameters | URL 템플릿 매개 변수의 컬렉션입니다. | ParameterContract[] |
| urlTemplate | 이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: /customers/{cid}/orders/{oid}/?date={date} | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1000(필수) |
ParameterContract
| 이름 | 묘사 | 값 |
|---|---|---|
| defaultValue | 기본 매개 변수 값입니다. | 문자열 |
| 묘사 | 매개 변수 설명입니다. | 문자열 |
| 이름 | 매개 변수 이름입니다. | string(필수) |
| 필수 | 매개 변수가 필요한지 여부를 지정합니다. | bool |
| 형 | 매개 변수 형식입니다. | string(필수) |
| 값 | 매개 변수 값입니다. | string[] |
RepresentationContract
| 이름 | 묘사 | 값 |
|---|---|---|
| contentType | 이 표현의 등록된 콘텐츠 형식 또는 사용자 지정 콘텐츠 형식(예: application/xml)을 지정합니다. | string(필수) |
| 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'가 아니면 적용할 수 있습니다. | 문자열 |
RequestContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 요청 설명입니다. | 문자열 |
| 헤더 | 작업 요청 헤더의 컬렉션입니다. | ParameterContract[] |
| queryParameters | 작업 요청 쿼리 매개 변수의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 요청 표현의 컬렉션입니다. | RepresentationContract[] |
ResponseContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 묘사 | 작업 응답 설명입니다. | 문자열 |
| 헤더 | 작업 응답 헤더의 컬렉션입니다. | ParameterContract[] |
| 표현 | 작업 응답 표현의 컬렉션입니다. | RepresentationContract[] |
| statusCode | 작업 응답 HTTP 상태 코드입니다. | int(필수) |