다음을 통해 공유

Microsoft.ApiManagement 서비스/api/tagDescriptions 2019-12-01

  • 아티클

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/api/tagDescriptions 리소스 유형을 배포할 수 있습니다.

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    externalDocsDescription: 'string'
    externalDocsUrl: 'string'
  }
}

속성 값

Microsoft.ApiManagement/service/api/tagDescriptions

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식 리소스의 기호 이름: 서비스/api
속성 TagDescription 만들기 작업에 제공된 속성입니다. TagDescriptionBasePropertiesOrTagDescriptionContractProperties

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

이름 묘사 값
묘사 태그에 대한 설명입니다. 문자열
externalDocsDescription 태그를 설명하는 외부 리소스에 대한 설명입니다. 문자열
externalDocsUrl 태그를 설명하는 외부 리소스의 절대 URL입니다. 문자열

제약 조건:
최대 길이 = 2000

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/api/tagDescriptions 리소스 유형을 배포할 수 있습니다.

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "apiVersion": "2019-12-01",
  "name": "string",
  "properties": {
    "description": "string",
    "externalDocsDescription": "string",
    "externalDocsUrl": "string"
  }
}

속성 값

Microsoft.ApiManagement/service/api/tagDescriptions

이름 묘사 값
apiVersion api 버전 '2019-12-01'
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
속성 TagDescription 만들기 작업에 제공된 속성입니다. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
형 리소스 종류 'Microsoft.ApiManagement/service/api/tagDescriptions'

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

이름 묘사 값
묘사 태그에 대한 설명입니다. 문자열
externalDocsDescription 태그를 설명하는 외부 리소스에 대한 설명입니다. 문자열
externalDocsUrl 태그를 설명하는 외부 리소스의 절대 URL입니다. 문자열

제약 조건:
최대 길이 = 2000

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

다음을 대상으로 하는 작업으로 서비스/api/tagDescriptions 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      externalDocsDescription = "string"
      externalDocsUrl = "string"
    }
  })
}

속성 값

Microsoft.ApiManagement/service/api/tagDescriptions

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스/api
속성 TagDescription 만들기 작업에 제공된 속성입니다. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
형 리소스 종류 "Microsoft.ApiManagement/service/api/tagDescriptions@2019-12-01"

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

이름 묘사 값
묘사 태그에 대한 설명입니다. 문자열
externalDocsDescription 태그를 설명하는 외부 리소스에 대한 설명입니다. 문자열
externalDocsUrl 태그를 설명하는 외부 리소스의 절대 URL입니다. 문자열

제약 조건:
최대 길이 = 2000