다음을 통해 공유

Microsoft.ApiManagement 서비스/구독 2023-09-01-preview

  • 아티클

Bicep 리소스 정의

다음을 대상으로 하는 작업을 사용하여 서비스/구독 리소스 유형을 배포할 수 있습니다.

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

속성 값

서비스/구독

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

Bicep자식 리소스의 이름과 형식을 설정하는 방법을 알아보세요.		 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식의 리소스에 대한 기호 이름: 서비스
속성 구독 계약 속성입니다. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

이름 묘사 값
allowTracing 추적을 사용할 수 있는지 여부를 결정합니다. bool
displayName 구독 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ownerId /users/{userId} 형식으로 구독을 만드는 사용자(사용자 ID 경로) 문자열
primaryKey 기본 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
범위 /products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다. string(필수)
secondaryKey 보조 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
상태 초기 구독 상태입니다. 값을 지정하지 않으면 구독이 제출됨 상태로 만들어집니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다. 'active'
'취소됨'
'expired'
'거부됨'
'제출됨'
'suspended'

빠른 시작 템플릿

다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.

템플렛 묘사
템플릿 사용하여 API Management 인스턴스 및 모든 하위 리소스 만들기

Azure 배포 		이 템플릿은 API Management 서비스를 만들고 하위 엔터티를 구성하는 방법을 보여 줍니다.

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업을 사용하여 서비스/구독 리소스 유형을 배포할 수 있습니다.

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

속성 값

서비스/구독

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

JSON ARM 템플릿자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.		 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
속성 구독 계약 속성입니다. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

이름 묘사 값
allowTracing 추적을 사용할 수 있는지 여부를 결정합니다. bool
displayName 구독 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ownerId /users/{userId} 형식으로 구독을 만드는 사용자(사용자 ID 경로) 문자열
primaryKey 기본 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
범위 /products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다. string(필수)
secondaryKey 보조 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
상태 초기 구독 상태입니다. 값을 지정하지 않으면 구독이 제출됨 상태로 만들어집니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다. 'active'
'취소됨'
'expired'
'거부됨'
'제출됨'
'suspended'

빠른 시작 템플릿

다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.

템플렛 묘사
템플릿 사용하여 API Management 인스턴스 및 모든 하위 리소스 만들기

Azure 배포 		이 템플릿은 API Management 서비스를 만들고 하위 엔터티를 구성하는 방법을 보여 줍니다.

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

다음을 대상으로 하는 작업을 사용하여 서비스/구독 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

속성 값

서비스/구독

이름 묘사 값
형 리소스 종류 "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
이름 리소스 이름 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
속성 구독 계약 속성입니다. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

이름 묘사 값
allowTracing 추적을 사용할 수 있는지 여부를 결정합니다. bool
displayName 구독 이름입니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ownerId /users/{userId} 형식으로 구독을 만드는 사용자(사용자 ID 경로) 문자열
primaryKey 기본 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
범위 /products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다. string(필수)
secondaryKey 보조 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
상태 초기 구독 상태입니다. 값을 지정하지 않으면 구독이 제출됨 상태로 만들어집니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다. "활성"
"취소됨"
"expired"
"거부됨"
"제출됨"
"suspended"