Microsoft.Web customApis 2016-06-01

아티클
02/23/2025

Bicep 리소스 정의

customApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

리소스 그룹 - 리소스 그룹 배포 명령 참조

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

리소스 형식

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

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {
      {customized property}: {
        oAuthSettings: {
          clientId: 'string'
          clientSecret: 'string'
          customParameters: {
            {customized property}: {
              options: any(...)
              uiDefinition: any(...)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(...)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(...)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

속성 값

ApiOAuthSettings

이름	묘사	값
clientId	리소스 공급자 클라이언트 ID	문자열
clientSecret	OAuth에 필요한 클라이언트 암호	문자열
customParameters	OAuth 매개 변수 키는 매개 변수의 이름입니다.	ApiOAuthSettingsCustomParameters
identityProvider	ID 공급자	문자열
속성	이 oauth 설정에 대한 속성만 읽습니다.	어떤
redirectUrl	URL	문자열
범위	OAuth 범위	string[]

ApiOAuthSettingsCustomParameters

이름	묘사	값

ApiOAuthSettingsParameter

이름	묘사	값
옵션	이 매개 변수에 사용할 수 있는 옵션	어떤
uiDefinition	호출자가 문화권을 지정할 수 있는 문화권별 UI 정의	어떤
값	설정 값	문자열

ApiResourceBackendService

이름	묘사	값
serviceUrl	서비스 URL	문자열

ApiResourceDefinitions

이름	묘사	값
modifiedSwaggerUrl	수정된 swagger URL	문자열
originalSwaggerUrl	원래 swagger URL	문자열

ConnectionParameter

이름	묘사	값
oAuthSettings	연결 공급자에 대한 OAuth 설정	ApiOAuthSettings
형	매개 변수의 형식	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

이름	묘사	값
apiDefinitions	API 정의	ApiResourceDefinitions
apiType	API 형식	'NotSpecified' 'Rest' 'Soap'
backendService	API 백 엔드 서비스	ApiResourceBackendService
brandColor	브랜드 색	문자열
기능	사용자 지정 API 기능	string[]
connectionParameters	연결 매개 변수	CustomApiPropertiesDefinitionConnectionParameters
묘사	사용자 지정 API 설명	문자열
displayName	표시 이름	문자열
iconUri	아이콘 URI	문자열
runtimeUrls	런타임 URL	string[]
허세	swagger의 JSON 표현	어떤
wsdlDefinition	WSDL 정의	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

이름	묘사	값

Microsoft.Web/customApis

이름	묘사	값
etag	Resource ETag	문자열
위치	리소스 위치	문자열
이름	리소스 이름	string(필수)
속성	사용자 지정 API 속성	CustomApiPropertiesDefinition
태그	리소스 태그	태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요.

TagsDictionary

이름	묘사	값

WsdlDefinition

이름	묘사	값
콘텐츠	WSDL 콘텐츠	문자열
importMethod	WSDL 가져오기 메서드	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
서비스	이름 및 엔드포인트 이름을 가진 서비스	WsdlService
url	The WSDL URL	문자열

WsdlService

이름	묘사	값
endpointQualifiedNames	엔드포인트의 정규화된 이름 목록	string[]
qualifiedName	서비스의 정규화된 이름	string(필수)

ARM 템플릿 리소스 정의

customApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

리소스 그룹 - 리소스 그룹 배포 명령 참조

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

리소스 형식

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

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "apiDefinitions": {
      "modifiedSwaggerUrl": "string",
      "originalSwaggerUrl": "string"
    },
    "apiType": "string",
    "backendService": {
      "serviceUrl": "string"
    },
    "brandColor": "string",
    "capabilities": [ "string" ],
    "connectionParameters": {
      "{customized property}": {
        "oAuthSettings": {
          "clientId": "string",
          "clientSecret": "string",
          "customParameters": {
            "{customized property}": {
              "options": {},
              "uiDefinition": {},
              "value": "string"
            }
          },
          "identityProvider": "string",
          "properties": {},
          "redirectUrl": "string",
          "scopes": [ "string" ]
        },
        "type": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "runtimeUrls": [ "string" ],
    "swagger": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

속성 값

ApiOAuthSettings

이름	묘사	값
clientId	리소스 공급자 클라이언트 ID	문자열
clientSecret	OAuth에 필요한 클라이언트 암호	문자열
customParameters	OAuth 매개 변수 키는 매개 변수의 이름입니다.	ApiOAuthSettingsCustomParameters
identityProvider	ID 공급자	문자열
속성	이 oauth 설정에 대한 속성만 읽습니다.	어떤
redirectUrl	URL	문자열
범위	OAuth 범위	string[]

ApiOAuthSettingsCustomParameters

이름	묘사	값

ApiOAuthSettingsParameter

이름	묘사	값
옵션	이 매개 변수에 사용할 수 있는 옵션	어떤
uiDefinition	호출자가 문화권을 지정할 수 있는 문화권별 UI 정의	어떤
값	설정 값	문자열

ApiResourceBackendService

이름	묘사	값
serviceUrl	서비스 URL	문자열

ApiResourceDefinitions

이름	묘사	값
modifiedSwaggerUrl	수정된 swagger URL	문자열
originalSwaggerUrl	원래 swagger URL	문자열

ConnectionParameter

이름	묘사	값
oAuthSettings	연결 공급자에 대한 OAuth 설정	ApiOAuthSettings
형	매개 변수의 형식	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

이름	묘사	값
apiDefinitions	API 정의	ApiResourceDefinitions
apiType	API 형식	'NotSpecified' 'Rest' 'Soap'
backendService	API 백 엔드 서비스	ApiResourceBackendService
brandColor	브랜드 색	문자열
기능	사용자 지정 API 기능	string[]
connectionParameters	연결 매개 변수	CustomApiPropertiesDefinitionConnectionParameters
묘사	사용자 지정 API 설명	문자열
displayName	표시 이름	문자열
iconUri	아이콘 URI	문자열
runtimeUrls	런타임 URL	string[]
허세	swagger의 JSON 표현	어떤
wsdlDefinition	WSDL 정의	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

이름	묘사	값

Microsoft.Web/customApis

이름	묘사	값
apiVersion	api 버전	'2016-06-01'
etag	Resource ETag	문자열
위치	리소스 위치	문자열
이름	리소스 이름	string(필수)
속성	사용자 지정 API 속성	CustomApiPropertiesDefinition
태그	리소스 태그	태그 이름 및 값의 사전입니다. 템플릿 태그를 참조하세요.
형	리소스 종류	'Microsoft.Web/customApis'

TagsDictionary

이름	묘사	값

WsdlDefinition

이름	묘사	값
콘텐츠	WSDL 콘텐츠	문자열
importMethod	WSDL 가져오기 메서드	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
서비스	이름 및 엔드포인트 이름을 가진 서비스	WsdlService
url	The WSDL URL	문자열

WsdlService

이름	묘사	값
endpointQualifiedNames	엔드포인트의 정규화된 이름 목록	string[]
qualifiedName	서비스의 정규화된 이름	string(필수)

사용 예제

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

customApis 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      apiDefinitions = {
        modifiedSwaggerUrl = "string"
        originalSwaggerUrl = "string"
      }
      apiType = "string"
      backendService = {
        serviceUrl = "string"
      }
      brandColor = "string"
      capabilities = [
        "string"
      ]
      connectionParameters = {
        {customized property} = {
          oAuthSettings = {
            clientId = "string"
            clientSecret = "string"
            customParameters = {
              {customized property} = {
                options = ?
                uiDefinition = ?
                value = "string"
              }
            }
            identityProvider = "string"
            properties = ?
            redirectUrl = "string"
            scopes = [
              "string"
            ]
          }
          type = "string"
        }
      }
      description = "string"
      displayName = "string"
      iconUri = "string"
      runtimeUrls = [
        "string"
      ]
      swagger = ?
      wsdlDefinition = {
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
      }
    }
  })
}

속성 값

ApiOAuthSettings

이름	묘사	값
clientId	리소스 공급자 클라이언트 ID	문자열
clientSecret	OAuth에 필요한 클라이언트 암호	문자열
customParameters	OAuth 매개 변수 키는 매개 변수의 이름입니다.	ApiOAuthSettingsCustomParameters
identityProvider	ID 공급자	문자열
속성	이 oauth 설정에 대한 속성만 읽습니다.	어떤
redirectUrl	URL	문자열
범위	OAuth 범위	string[]

ApiOAuthSettingsCustomParameters

이름	묘사	값

ApiOAuthSettingsParameter

이름	묘사	값
옵션	이 매개 변수에 사용할 수 있는 옵션	어떤
uiDefinition	호출자가 문화권을 지정할 수 있는 문화권별 UI 정의	어떤
값	설정 값	문자열

ApiResourceBackendService

이름	묘사	값
serviceUrl	서비스 URL	문자열

ApiResourceDefinitions

이름	묘사	값
modifiedSwaggerUrl	수정된 swagger URL	문자열
originalSwaggerUrl	원래 swagger URL	문자열

ConnectionParameter

이름	묘사	값
oAuthSettings	연결 공급자에 대한 OAuth 설정	ApiOAuthSettings
형	매개 변수의 형식	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

이름	묘사	값
apiDefinitions	API 정의	ApiResourceDefinitions
apiType	API 형식	'NotSpecified' 'Rest' 'Soap'
backendService	API 백 엔드 서비스	ApiResourceBackendService
brandColor	브랜드 색	문자열
기능	사용자 지정 API 기능	string[]
connectionParameters	연결 매개 변수	CustomApiPropertiesDefinitionConnectionParameters
묘사	사용자 지정 API 설명	문자열
displayName	표시 이름	문자열
iconUri	아이콘 URI	문자열
runtimeUrls	런타임 URL	string[]
허세	swagger의 JSON 표현	어떤
wsdlDefinition	WSDL 정의	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

이름	묘사	값

Microsoft.Web/customApis

이름	묘사	값
etag	Resource ETag	문자열
위치	리소스 위치	문자열
이름	리소스 이름	string(필수)
속성	사용자 지정 API 속성	CustomApiPropertiesDefinition
태그	리소스 태그	태그 이름 및 값의 사전입니다.
형	리소스 종류	"Microsoft.Web/customApis@2016-06-01"

TagsDictionary

이름	묘사	값

WsdlDefinition

이름	묘사	값
콘텐츠	WSDL 콘텐츠	문자열
importMethod	WSDL 가져오기 메서드	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
서비스	이름 및 엔드포인트 이름을 가진 서비스	WsdlService
url	The WSDL URL	문자열

WsdlService

이름	묘사	값
endpointQualifiedNames	엔드포인트의 정규화된 이름 목록	string[]
qualifiedName	서비스의 정규화된 이름	string(필수)

다음을 통해 공유

Microsoft.Web customApis 2016-06-01

Bicep 리소스 정의

리소스 형식

속성 값

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

ARM 템플릿 리소스 정의

리소스 형식

속성 값

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

사용 예제

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

리소스 형식

속성 값

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

피드백

추가 리소스