다음을 통해 공유

Microsoft.ApiManagement 서비스/openidConnectProviders

  • 아티클

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

속성 값

service/openidConnectProviders

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

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

문자 제한: 1-80

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

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

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

OpenidConnectProviderContractProperties

이름 묘사 값
clientId 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 ID입니다. string(필수)
clientSecret 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 암호입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
묘사 OpenID Connect 공급자에 대한 사용자 친화적인 설명입니다. 문자열
displayName 사용자에게 친숙한 OpenID Connect 공급자 이름입니다. string(필수)

제약 조건:
최대 길이 = 50
metadataEndpoint 메타데이터 엔드포인트 URI입니다. string(필수)
useInApiDocumentation true이면 Open ID Connect 공급자가 개발자 포털의 API 설명서에서 사용됩니다. 값이 제공되지 않으면 기본적으로 False입니다. bool
useInTestConsole true이면 개발자 포털 테스트 콘솔에서 Open ID Connect 공급자를 사용할 수 있습니다. 값이 제공되지 않으면 기본적으로 True입니다. bool

빠른 시작 템플릿

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

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

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

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

속성 값

service/openidConnectProviders

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

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

문자 제한: 1-80

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

문자로 시작하고 영숫자로 끝납니다.
속성 OpenId Connect 공급자 계약 속성입니다. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

이름 묘사 값
clientId 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 ID입니다. string(필수)
clientSecret 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 암호입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
묘사 OpenID Connect 공급자에 대한 사용자 친화적인 설명입니다. 문자열
displayName 사용자에게 친숙한 OpenID Connect 공급자 이름입니다. string(필수)

제약 조건:
최대 길이 = 50
metadataEndpoint 메타데이터 엔드포인트 URI입니다. string(필수)
useInApiDocumentation true이면 Open ID Connect 공급자가 개발자 포털의 API 설명서에서 사용됩니다. 값이 제공되지 않으면 기본적으로 False입니다. bool
useInTestConsole true이면 개발자 포털 테스트 콘솔에서 Open ID Connect 공급자를 사용할 수 있습니다. 값이 제공되지 않으면 기본적으로 True입니다. bool

빠른 시작 템플릿

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

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

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

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

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

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

속성 값

service/openidConnectProviders

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

문자 제한: 1-80

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

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

OpenidConnectProviderContractProperties

이름 묘사 값
clientId 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 ID입니다. string(필수)
clientSecret 클라이언트 애플리케이션인 개발자 콘솔의 클라이언트 암호입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
묘사 OpenID Connect 공급자에 대한 사용자 친화적인 설명입니다. 문자열
displayName 사용자에게 친숙한 OpenID Connect 공급자 이름입니다. string(필수)

제약 조건:
최대 길이 = 50
metadataEndpoint 메타데이터 엔드포인트 URI입니다. string(필수)
useInApiDocumentation true이면 Open ID Connect 공급자가 개발자 포털의 API 설명서에서 사용됩니다. 값이 제공되지 않으면 기본적으로 False입니다. bool
useInTestConsole true이면 개발자 포털 테스트 콘솔에서 Open ID Connect 공급자를 사용할 수 있습니다. 값이 제공되지 않으면 기본적으로 True입니다. bool