Azure API Management 템플릿 데이터 모델 참조
이 항목에서는 Azure API Management에서 개발자 포털 템플릿용 데이터 모델에서 사용되는 일반적인 항목에 대한 엔터티 및 유형 표현을 설명합니다.
템플릿 작업에 대한 자세한 내용은 템플릿을 사용하여 API Management 개발자 포털을 사용자 지정하는 방법을 참조하세요.
참고
다음 설명서 콘텐츠는 더 이상 사용되지 않는 개발자 포털에 대한 것입니다. 모든 API Management 서비스에서 제거되는 2023년 10월 만료될 때까지 평상시와 같이 계속 사용할 수 있습니다. 사용되지 않는 포털은 중요 보안 업데이트만 받습니다. 자세한 내용은 다음 문서를 참조하세요.
가용성
참조
- API
- API 요약
- 애플리케이션
- Attachment
- 코드 샘플
- 설명
- 필터링
- Header
- HTTP 요청
- HTTP 응답
- 문제점
- 연산
- 작업 메뉴
- 작업 메뉴 항목
- 페이징
- 매개 변수
- 제품
- 공급자
- 표현
- 구독
- 구독 요약
- 사용자 계정 정보
- 사용자 로그인
- 사용자 등록
API
API 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 API를 고유하게 식별합니다. 값은 {id}가 API 식별자인 apis/{id} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
name |
문자열 | API 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
description |
문자열 | API에 대한 설명입니다. 비어 있지 않아야 합니다. HTML 서식 지정 태그를 포함할 수 있습니다. 최대 길이는 1000자입니다. |
serviceUrl |
문자열 | 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. |
path |
문자열 | API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다. 이 API에 대한 공용 URL을 형성하는 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기준 URL에 추가됩니다. |
protocols |
숫자의 배열 | 이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다. 허용되는 값은 1 - http 및 2 - https 또는 둘 다입니다. |
authenticationSettings |
권한 부여 서버 인증 설정 | 이 API에 포함된 인증 설정의 컬렉션입니다. |
subscriptionKeyParameterNames |
object | 구독 키가 포함된 쿼리 및/또는 헤더 매개 변수에 대한 사용자 지정 이름을 지정하는 데 사용할 수 있는 선택적 속성입니다. 이 속성이 있으면 다음 두 속성 중 하나 이상을 포함해야 합니다.{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } } |
API 요약
API summary 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 API를 고유하게 식별합니다. 값은 {id}가 API 식별자인 apis/{id} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
name |
문자열 | API 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
description |
문자열 | API에 대한 설명입니다. 비어 있지 않아야 합니다. HTML 서식 지정 태그를 포함할 수 있습니다. 최대 길이는 1000자입니다. |
애플리케이션
application 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 애플리케이션의 고유 식별자입니다. |
Title |
문자열 | 애플리케이션의 제목입니다. |
Description |
문자열 | 애플리케이션의 설명입니다. |
Url |
URI | 애플리케이션에 대한 URI입니다. |
Version |
문자열 | 애플리케이션에 대한 버전 정보입니다. |
Requirements |
문자열 | 애플리케이션에 대한 요구 사항의 설명입니다. |
State |
number | 애플리케이션의 현재 상태입니다. - 0 - 등록됨 - 1 - 제출됨 - 2 - 게시됨 - 3 - 거부됨 - 4 - 게시 취소됨 |
RegistrationDate |
DateTime | 애플리케이션이 등록된 날짜 및 시간입니다. |
CategoryId |
number | 애플리케이션(금융, 엔터테인먼트 등)의 범주입니다. |
DeveloperId |
문자열 | 애플리케이션을 제출한 개발자의 고유 식별자입니다. |
Attachments |
첨부 파일 엔터티의 컬렉션입니다. | 스크린샷 또는 아이콘과 같은 애플리케이션에 대한 첨부 파일입니다. |
Icon |
Attachment | 애플리케이션에 대한 아이콘입니다. |
첨부 파일
attachment 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
UniqueId |
문자열 | 첨부 파일의 고유한 식별자입니다. |
Url |
문자열 | 리소스의 URL입니다. |
Type |
문자열 | 첨부 파일의 형식입니다. |
ContentType |
문자열 | 첨부 파일의 미디어 형식입니다. |
코드 샘플
| 속성 | 형식 | Description |
|---|---|---|
title |
문자열 | 작업의 이름입니다. |
snippet |
문자열 | 이 속성은 사용되지 않으며 사용할 수 없습니다. |
brush |
문자열 | 코드 샘플을 표시할 때 사용할 템플릿을 강조하는 코드 구문입니다. 허용되는 값은 plain, php, java, xml, objc, python, ruby 및 csharp입니다. |
template |
문자열 | 이 코드 샘플 템플릿의 이름입니다. |
body |
문자열 | 코드 조각의 코드 샘플 부분에 대한 자리 표시자입니다. |
method |
문자열 | 작업의 HTTP 메서드입니다. |
scheme |
문자열 | 작업 요청에 사용할 프로토콜입니다. |
path |
문자열 | 작업의 경로입니다. |
query |
문자열 | 정의된 매개 변수가 있는 쿼리 문자열 예제입니다. |
host |
문자열 | 이 작업을 포함하는 API에 대한 API Management 서비스 게이트웨이의 URL입니다. |
headers |
헤더 엔터티의 컬렉션입니다. | 이 작업에 대한 헤더입니다. |
parameters |
매개 변수 엔터티의 컬렉션입니다. | 이 작업에 대해 정의된 매개 변수입니다. |
의견
API 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
number | 주석의 ID입니다. |
CommentText |
문자열 | 주석의 본문입니다. HTML을 포함할 수 있습니다. |
DeveloperCompany |
문자열 | 개발자의 회사 이름입니다. |
PostedOn |
DateTime | 의견이 게시된 날짜 및 시간입니다. |
문제
issue 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 문제의 고유한 식별자입니다. |
ApiID |
문자열 | 이 문제가 보고된 API에 대한 ID입니다. |
Title |
문자열 | 문제의 제목입니다. |
Description |
문자열 | 문제에 대한 설명입니다. |
SubscriptionDeveloperName |
문자열 | 문제를 보고한 개발자의 이름입니다. |
IssueState |
문자열 | 문제의 현재 상태입니다. 가능한 값은 Proposed, Opened, Closed입니다. |
ReportedOn |
DateTime | 문제가 보고된 날짜 및 시간입니다. |
Comments |
주석 엔터티의 컬렉션입니다. | 이 문제에 대한 주석입니다. |
Attachments |
첨부 파일 엔터티의 컬렉션입니다. | 문제에 대한 첨부 파일입니다. |
Services |
API 엔터티의 컬렉션입니다. | 문제를 정리하는 사용자가 구독한 API입니다. |
필터링
filtering 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Pattern |
문자열 | 검색 용어가 없는 경우 현재 검색 용어 또는 null입니다. |
Placeholder |
문자열 | 지정된 검색 용어가 없는 경우 검색 상자에 표시할 텍스트입니다. |
헤더
이 섹션에서는 parameter 표현을 설명합니다.
| 속성 | 형식 | Description |
|---|---|---|
name |
문자열 | 매개 변수 이름입니다. |
description |
문자열 | 매개 변수 설명입니다. |
value |
문자열 | 헤더 값입니다. |
typeName |
문자열 | 헤더 값의 데이터 형식입니다. |
options |
문자열 | 옵션입니다. |
required |
boolean | 필수 헤더인지 여부입니다. |
readOnly |
boolean | 헤더가 읽기 전용인지 여부입니다. |
HTTP 요청
이 섹션에서는 request 표현을 설명합니다.
| 속성 | 형식 | Description |
|---|---|---|
description |
문자열 | 작업 요청 설명입니다. |
headers |
헤더 엔터티의 배열입니다. | 요청 헤더입니다. |
parameters |
매개 변수의 배열 | 작업 요청 매개 변수의 컬렉션입니다. |
representations |
표현의 배열 | 작업 요청 표현의 컬렉션입니다. |
HTTP 응답
이 섹션에서는 response 표현을 설명합니다.
| 속성 | 형식 | Description |
|---|---|---|
statusCode |
양의 정수 | 작업 응답 상태 코드입니다. |
description |
문자열 | 작업 응답 설명입니다. |
representations |
표현의 배열 | 작업 응답 표현의 컬렉션입니다. |
작업
operation 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 작업을 고유하게 식별합니다. 값은 {aid}가 API 식별자이고 {id}가 작업 식별자인 apis/{aid}/operations/{id} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
name |
문자열 | 작업의 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
description |
문자열 | 작업에 대한 설명입니다. 비어 있지 않아야 합니다. HTML 서식 지정 태그를 포함할 수 있습니다. 최대 길이는 1000자입니다. |
scheme |
문자열 | 이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다. 허용되는 값은 http, https 또는 http 및 https 모두입니다. |
uriTemplate |
문자열 | 이 작업에 대한 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다. 예: customers/{cid}/orders/{oid}/?date={date} |
host |
문자열 | API를 호스팅하는 API Management 게이트웨이 URL입니다. |
httpMethod |
문자열 | 작업 HTTP 메서드입니다. |
request |
HTTP 요청 | 요청 세부 정보를 포함하는 엔터티입니다. |
responses |
HTTP 응답의 배열 | 작업 HTTP 응답 엔터티의 배열입니다. |
작업 메뉴
operation menu 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
ApiId |
문자열 | 현재 API의 ID입니다. |
CurrentOperationId |
문자열 | 현재 작업의 ID입니다. |
Action |
문자열 | 메뉴 형식입니다. |
MenuItems |
작업 메뉴 항목 엔터티의 컬렉션입니다. | 현재 API에 대한 작업입니다. |
작업 메뉴 항목
operation menu item 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 작업 ID입니다. |
Title |
문자열 | 작업에 대한 설명입니다. |
HttpMethod |
문자열 | 작업의 Http 메서드입니다. |
페이징
paging 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Page |
number | 현재 페이지 번호입니다. |
PageSize |
number | 단일 페이지에 표시될 최대 결과입니다. |
TotalItemCount |
number | 표시할 항목의 수입니다. |
ShowAll |
boolean | 단일 페이지에 모든 결과를 표시할지 여부입니다. |
PageCount |
number | 결과의 페이지 수입니다. |
매개 변수
이 섹션에서는 parameter 표현을 설명합니다.
| 속성 | 형식 | Description |
|---|---|---|
name |
문자열 | 매개 변수 이름입니다. |
description |
문자열 | 매개 변수 설명입니다. |
value |
문자열 | 매개 변수 값입니다. |
options |
문자열의 배열 | 쿼리 매개 변수 값에 대해 정의된 값입니다. |
required |
boolean | 매개 변수가 필요한지 여부를 지정합니다. |
kind |
number | 이 매개 변수가 경로 매개 변수(1) 또는 쿼리 문자열 매개 변수(2)인지 여부입니다. |
typeName |
문자열 | 매개 변수 유형입니다. |
제품
product 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 제품을 고유하게 식별합니다. 값은 {pid}가 제품 식별자인 products/{pid} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
Title |
문자열 | 제품의 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
Description |
문자열 | 제품에 대한 설명입니다. 비어 있지 않아야 합니다. HTML 서식 지정 태그를 포함할 수 있습니다. 최대 길이는 1000자입니다. |
Terms |
문자열 | 제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. |
ProductState |
number | 제품 게시 여부를 지정합니다. 게시된 제품은 개발자 포털에서 개발자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 보입니다. 제품 상태에 대해 허용되는 값은 다음과 같습니다. - 0 - Not Published- 1 - Published- 2 - Deleted |
AllowMultipleSubscriptions |
boolean | 사용자가 동시에 이 제품에 여러 구독을 소유할 수 있는지 여부를 지정합니다. |
MultipleSubscriptionsCount |
number | 사용자가 동시에 가질 수 있는 이 제품의 최대 구독 수입니다. |
공급자
provider 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Properties |
문자열 사전 | 이 인증 공급자에 대한 속성입니다. |
AuthenticationType |
문자열 | 공급자 유형입니다. (Microsoft Entra ID, Facebook 로그인, Google 계정, Microsoft 계정, Twitter). |
Caption |
문자열 | 공급자의 표시 이름입니다. |
표현
이 섹션에서는 representation을 설명합니다.
| 속성 | 형식 | Description |
|---|---|---|
contentType |
문자열 | 이 표현에 대한 등록된 또는 사용자 지정 콘텐츠 형식을 지정합니다(예: application/xml). |
sample |
문자열 | 표현의 예제입니다. |
Subscription
subscription 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 구독을 고유하게 식별합니다. 값은 {sid}가 구독 식별자인 subscriptions/{sid} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
ProductId |
문자열 | 구독된 제품의 제품 리소스 식별자입니다. 값은 {pid}가 제품 식별자인 products/{pid} 형식의 유효한 상대 URL입니다. |
ProductTitle |
문자열 | 제품의 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
ProductDescription |
문자열 | 제품에 대한 설명입니다. 비어 있지 않아야 합니다. HTML 서식 지정 태그를 포함할 수 있습니다. 최대 길이는 1000자입니다. |
ProductDetailsUrl |
문자열 | 제품 세부 정보에 대한 상대 URL입니다. |
state |
문자열 | 구독의 상태입니다. 가능한 상태는 다음과 같습니다. - 0 - suspended – 구독이 차단되고 구독자는 제품의 API를 호출할 수 없습니다.- 1 - active – 구독이 활성화되어 있습니다.- 2 - expired - 구독이 만료 날짜에 도달되었고 비활성화되었습니다.- 3 - submitted - 구독 요청이 개발자에 의해 발생했지만 아직 승인 또는 거부되지 않았습니다.- 4 - rejected – 구독 요청이 관리자에 의해 거부되었습니다.- 5 - cancelled - 구독이 개발자 또는 관리자에 의해 취소되었습니다. |
DisplayName |
문자열 | 구독의 표시 이름입니다. |
CreatedDate |
dateTime | ISO 8601 형식(2014-06-24T16:25:00Z)의 구독이 만들어진 날짜입니다. |
CanBeCancelled |
boolean | 현재 사용자가 구독을 취소할 수 있는지 여부입니다. |
IsAwaitingApproval |
boolean | 구독이 승인 대기 중인지 여부입니다. |
StartDate |
dateTime | ISO 8601 형식(2014-06-24T16:25:00Z)의 구독에 대한 시작 날짜입니다. |
ExpirationDate |
dateTime | ISO 8601 형식(2014-06-24T16:25:00Z)의 구독에 대한 만료 날짜입니다. |
NotificationDate |
dateTime | ISO 8601 형식(2014-06-24T16:25:00Z)의 구독에 대한 알림 날짜입니다. |
primaryKey |
문자열 | 기본 구독 키입니다. 최대 길이는 256자입니다. |
secondaryKey |
문자열 | 보조 구독 키입니다. 최대 길이는 256자입니다. |
CanBeRenewed |
boolean | 현재 사용자가 구독을 갱신할 수 있는지 여부입니다. |
HasExpired |
boolean | 구독이 만료되었는지 여부입니다. |
IsRejected |
boolean | 구독 요청이 거부되었는지 여부입니다. |
CancelUrl |
문자열 | 구독을 취소하는 상대 Url입니다. |
RenewUrl |
문자열 | 구독을 갱신하는 상대 Url입니다. |
구독 요약
subscription summary 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Id |
문자열 | 리소스 식별자. 현재 API Management 서비스 인스턴스 내의 구독을 고유하게 식별합니다. 값은 {sid}가 구독 식별자인 subscriptions/{sid} 형식의 유효한 상대 URL입니다. 이 속성은 읽기 전용입니다. |
DisplayName |
문자열 | 구독의 표시 이름 |
사용자 계정 정보
user account info 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
FirstName |
문자열 | 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
LastName |
문자열 | 성입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
Email |
문자열 | 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. 최대 길이는 254자입니다. |
Password |
문자열 | 사용자 계정 암호입니다. |
NameIdentifier |
문자열 | 사용자 전자 메일과 동일한 계정 식별자입니다. |
ProviderName |
문자열 | 인증 공급자 이름입니다. |
IsBasicAccount |
boolean | 이 계정이 전자 메일 및 암호를 사용하여 등록된 경우 true이며 공급자를 사용하여 등록된 경우 false입니다. |
사용자 로그인
user sign in 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
Email |
문자열 | 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. 최대 길이는 254자입니다. |
Password |
문자열 | 사용자 계정 암호입니다. |
ReturnUrl |
문자열 | 사용자가 로그인을 클릭하는 페이지의 URL입니다. |
RememberMe |
boolean | 현재 사용자의 정보를 저장할지 여부입니다. |
RegistrationEnabled |
boolean | 등록이 활성화되어 있는지 여부입니다. |
DelegationEnabled |
boolean | 위임된 로그인이 활성화되어 있는지 여부입니다. |
DelegationUrl |
문자열 | 활성화된 경우 url의 위임된 로그인입니다. |
SsoSignUpUrl |
문자열 | 있는 경우 사용자에 대한 Single Sign-On URL입니다. |
AuxServiceUrl |
문자열 | 현재 사용자가 관리자인 경우 Azure Portal의 서비스 인스턴스에 대한 링크입니다. |
Providers |
공급자 엔터티의 컬렉션 | 이 사용자에 대한 인증 공급자입니다. |
UserRegistrationTerms |
문자열 | 로그인하기 전에 사용자가 동의해야 하는 약관입니다. |
UserRegistrationTermsEnabled |
boolean | 약관이 활성화되었는지 여부입니다. |
사용자 등록
user sign up 엔터티에는 다음과 같은 속성이 있습니다.
| 속성 | 형식 | Description |
|---|---|---|
PasswordConfirm |
boolean | 등록등록 제어에서 사용되는 값입니다. |
Password |
문자열 | 사용자 계정 암호입니다. |
PasswordVerdictLevel |
number | 등록등록 제어에서 사용되는 값입니다. |
UserRegistrationTerms |
문자열 | 로그인하기 전에 사용자가 동의해야 하는 약관입니다. |
UserRegistrationTermsOptions |
number | 등록등록 제어에서 사용되는 값입니다. |
ConsentAccepted |
boolean | 등록등록 제어에서 사용되는 값입니다. |
Email |
문자열 | 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. 최대 길이는 254자입니다. |
FirstName |
문자열 | 이름입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
LastName |
문자열 | 성입니다. 비어 있지 않아야 합니다. 최대 길이는 100자입니다. |
UserData |
문자열 | 등록 제어에서 사용되는 값입니다. |
NameIdentifier |
문자열 | 등록등록 제어에서 사용되는 값입니다. |
ProviderName |
문자열 | 인증 공급자 이름입니다. |
다음 단계
템플릿 작업에 대한 자세한 내용은 템플릿을 사용하여 API Management 개발자 포털을 사용자 지정하는 방법을 참조하세요.