Microsoft.ApiManagement 서비스/api 2016-10-10
- 최신
- 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 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
parent: resourceSymbolicName
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
}
description: 'string'
name: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
}
속성 값
AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| oAuth2 | API OAuth2 인증 설정 세부 정보입니다. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/api
| 이름 | 묘사 | 값 |
|---|---|---|
| authenticationSettings | 이 API에 포함된 인증 설정의 컬렉션입니다. | AuthenticationSettingsContract |
| 묘사 | API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 |
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1 패턴 = ^[^*#&+:<>?]+$(필수) |
| 부모 | Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 |
형식의 리소스에 대한 기호 이름: 서비스 |
| 길 | 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. | 문자열 제약 조건: 최대 길이 = (필수) |
| 프로토콜 | 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. | 다음 중 어느 것을 포함하는 문자열 배열: 'Http' 'Https'(필수) |
| serviceUrl | 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| subscriptionKeyParameterNames | API를 사용할 수 있는 프로토콜입니다. | SubscriptionKeyParameterNamesContract |
OAuth2AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| authorizationServerId | OAuth 권한 부여 서버 식별자입니다. | 문자열 |
| 범위 | 작업 범위입니다. | 문자열 |
SubscriptionKeyParameterNamesContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 머리글 | 구독 키 헤더 이름입니다. | 문자열 |
| 쿼리 | 구독 키 쿼리 문자열 매개 변수 이름입니다. | 문자열 |
ARM 템플릿 리소스 정의
다음을 대상으로 하는 작업을 사용하여 서비스/api 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹 - 리소스 그룹 배포 명령 참조
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2016-10-10",
"name": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
}
},
"description": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
}
}
속성 값
AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| oAuth2 | API OAuth2 인증 설정 세부 정보입니다. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/api
| 이름 | 묘사 | 값 |
|---|---|---|
| apiVersion | api 버전 | '2016-10-10' |
| authenticationSettings | 이 API에 포함된 인증 설정의 컬렉션입니다. | AuthenticationSettingsContract |
| 묘사 | API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 |
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1 패턴 = ^[^*#&+:<>?]+$(필수) |
| 길 | 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. | 문자열 제약 조건: 최대 길이 = (필수) |
| 프로토콜 | 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. | 다음 중 어느 것을 포함하는 문자열 배열: 'Http' 'Https'(필수) |
| serviceUrl | 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| subscriptionKeyParameterNames | API를 사용할 수 있는 프로토콜입니다. | SubscriptionKeyParameterNamesContract |
| 형 | 리소스 종류 | 'Microsoft.ApiManagement/service/api' |
OAuth2AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| authorizationServerId | OAuth 권한 부여 서버 식별자입니다. | 문자열 |
| 범위 | 작업 범위입니다. | 문자열 |
SubscriptionKeyParameterNamesContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 머리글 | 구독 키 헤더 이름입니다. | 문자열 |
| 쿼리 | 구독 키 쿼리 문자열 매개 변수 이름입니다. | 문자열 |
Terraform(AzAPI 공급자) 리소스 정의
다음을 대상으로 하는 작업을 사용하여 서비스/api 리소스 유형을 배포할 수 있습니다.
- 리소스 그룹
각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.
리소스 형식
Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2016-10-10"
name = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
}
description = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
}
속성 값
AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| oAuth2 | API OAuth2 인증 설정 세부 정보입니다. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/api
| 이름 | 묘사 | 값 |
|---|---|---|
| authenticationSettings | 이 API에 포함된 인증 설정의 컬렉션입니다. | AuthenticationSettingsContract |
| 묘사 | API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. | 문자열 |
| 이름 | 리소스 이름 | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1 패턴 = ^[^*#&+:<>?]+$(필수) |
| parent_id | 이 리소스의 부모인 리소스의 ID입니다. | 유형의 리소스에 대한 ID: 서비스 |
| 길 | 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. | 문자열 제약 조건: 최대 길이 = (필수) |
| 프로토콜 | 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. | 다음 중 어느 것을 포함하는 문자열 배열: 'Http' 'Https'(필수) |
| serviceUrl | 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. | 문자열 제약 조건: 최소 길이 = 1 최대 길이 = 1(필수) |
| subscriptionKeyParameterNames | API를 사용할 수 있는 프로토콜입니다. | SubscriptionKeyParameterNamesContract |
| 형 | 리소스 종류 | "Microsoft.ApiManagement/service/apis@2016-10-10" |
OAuth2AuthenticationSettingsContract
| 이름 | 묘사 | 값 |
|---|---|---|
| authorizationServerId | OAuth 권한 부여 서버 식별자입니다. | 문자열 |
| 범위 | 작업 범위입니다. | 문자열 |
SubscriptionKeyParameterNamesContract
| 이름 | 묘사 | 값 |
|---|---|---|
| 머리글 | 구독 키 헤더 이름입니다. | 문자열 |
| 쿼리 | 구독 키 쿼리 문자열 매개 변수 이름입니다. | 문자열 |