Microsoft.ApiManagement 서비스/작업 영역/제품 2022-09-01-preview
Bicep 리소스 정의
다음을 대상으로 하는 작업으로 서비스/작업 영역/제품 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/workspaces/products 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
속성 값
Microsoft.ApiManagement/service/workspaces/products
| 이름 | 묘사 | 값 |
|---|---|---|
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| 부모 | Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 |
형식 리소스의 기호 이름: 서비스/작업 영역 |
| 속성 | 제품 엔터티 계약 속성입니다. | ProductContractProperties |
ProductContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| approvalRequired | 구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | bool |
| 묘사 | 제품 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = |
| displayName | 제품 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| 상태 | 제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 NotPublished입니다. | 'notPublished' '게시됨' |
| subscriptionRequired | 이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. | bool |
| subscriptionsLimit | 사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | int |
| 용어 | 제품 사용 약관. 제품을 구독하려는 개발자는 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. | 문자열 |
ARM 템플릿 리소스 정의
다음을 대상으로 하는 작업으로 서비스/작업 영역/제품 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/workspaces/products 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.ApiManagement/service/workspaces/products",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
속성 값
Microsoft.ApiManagement/service/workspaces/products
| 이름 | 묘사 | 값 |
|---|---|---|
| apiVersion | api 버전 | '2022-09-01-preview' |
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| 속성 | 제품 엔터티 계약 속성입니다. | ProductContractProperties |
| 형 | 리소스 종류 | 'Microsoft.ApiManagement/service/workspaces/products' |
ProductContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| approvalRequired | 구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | bool |
| 묘사 | 제품 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = |
| displayName | 제품 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| 상태 | 제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 NotPublished입니다. | 'notPublished' '게시됨' |
| subscriptionRequired | 이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. | bool |
| subscriptionsLimit | 사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | int |
| 용어 | 제품 사용 약관. 제품을 구독하려는 개발자는 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. | 문자열 |
Terraform(AzAPI 공급자) 리소스 정의
다음을 대상으로 하는 작업으로 서비스/작업 영역/제품 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/workspaces/products 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview"
name = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
속성 값
Microsoft.ApiManagement/service/workspaces/products
| 이름 | 묘사 | 값 |
|---|---|---|
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| parent_id | 이 리소스의 부모인 리소스의 ID입니다. | 형식의 리소스 ID: 서비스/작업 영역 |
| 속성 | 제품 엔터티 계약 속성입니다. | ProductContractProperties |
| 형 | 리소스 종류 | "Microsoft.ApiManagement/service/workspaces/products@2022-09-01-preview" |
ProductContractProperties
| 이름 | 묘사 | 값 |
|---|---|---|
| approvalRequired | 구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | bool |
| 묘사 | 제품 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 제약 조건: 최대 길이 = |
| displayName | 제품 이름입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| 상태 | 제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 NotPublished입니다. | 'notPublished' '게시됨' |
| subscriptionRequired | 이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. | bool |
| subscriptionsLimit | 사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. | int |
| 용어 | 제품 사용 약관. 제품을 구독하려는 개발자는 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. | 문자열 |