Microsoft.ApiManagement 서비스/authorizationServers 2021-01-01-preview

아티클
12/21/2024

Bicep 리소스 정의

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

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

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-01-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
  }
}

속성 값

AuthorizationServerContractProperties

이름	묘사	값
authorizationEndpoint	OAuth 권한 부여 엔드포인트. http://tools.ietf.org/html/rfc6749#section-3.2참조하세요.	string(필수)
authorizationMethods	권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	액세스 토큰이 API에 전달되는 메커니즘을 지정합니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationHeader' 'query'
clientAuthenticationMethod	이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.	다음 중 어느 것을 포함하는 문자열 배열: '기본' 'Body'
clientId	이 권한 부여 서버에 등록된 클라이언트 또는 앱 ID입니다.	string(필수)
clientRegistrationEndpoint	이 권한 부여 서버에 대한 클라이언트 또는 앱 등록이 수행되는 페이지에 대한 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.	string(필수)
clientSecret	이 권한 부여 서버에 등록된 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.	문자열 제약 조건: 중요한 값입니다. 보안 매개 변수로 전달합니다.
defaultScope	기본적으로 요청될 액세스 토큰 범위입니다. API 수준에서 재정의할 수 있습니다. 공백으로 구분된 값을 포함하는 문자열 형식으로 제공해야 합니다.	문자열
묘사	권한 부여 서버에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.	문자열
displayName	사용자에게 친숙한 권한 부여 서버 이름입니다.	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 50(필수)
grantTypes	클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationCode' 'clientCredentials' '암시적' 'resourceOwnerPassword'(필수)
resourceOwnerPassword	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.	문자열
resourceOwnerUsername	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.	문자열
supportState	true이면 권한 부여 서버에는 권한 부여 요청의 상태 매개 변수가 해당 응답에 포함됩니다. 클라이언트는 상태 매개 변수를 사용하여 프로토콜 보안을 높일 수 있습니다.	bool
tokenBodyParameters	이름 및 값 문자열 속성(예: {"name": "name value", "value": "a value"})이 있는 JSON 개체의 배열로 표시되는 이 권한 부여 서버의 토큰 엔드포인트에 필요한 추가 매개 변수입니다.	TokenBodyParameterContract[]
tokenEndpoint	OAuth 토큰 엔드포인트입니다. 참조되는 엔터티에 대한 절대 URI를 포함합니다.	문자열

Microsoft.ApiManagement/service/authorizationServers

이름	묘사	값
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = `^[^*#&+:<>?]+$`(필수)
부모	Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.	형식의 리소스에 대한 기호 이름: 서비스
속성	외부 OAuth 권한 부여 서버 계약의 속성입니다.	AuthorizationServerContractProperties

TokenBodyParameterContract

이름	묘사	값
이름	본문 매개 변수 이름입니다.	string(필수)
값	body 매개 변수 값입니다.	string(필수)

ARM 템플릿 리소스 정의

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

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

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2021-01-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string"
  }
}

속성 값

AuthorizationServerContractProperties

이름	묘사	값
authorizationEndpoint	OAuth 권한 부여 엔드포인트. http://tools.ietf.org/html/rfc6749#section-3.2참조하세요.	string(필수)
authorizationMethods	권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	액세스 토큰이 API에 전달되는 메커니즘을 지정합니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationHeader' 'query'
clientAuthenticationMethod	이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.	다음 중 어느 것을 포함하는 문자열 배열: '기본' 'Body'
clientId	이 권한 부여 서버에 등록된 클라이언트 또는 앱 ID입니다.	string(필수)
clientRegistrationEndpoint	이 권한 부여 서버에 대한 클라이언트 또는 앱 등록이 수행되는 페이지에 대한 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.	string(필수)
clientSecret	이 권한 부여 서버에 등록된 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.	문자열 제약 조건: 중요한 값입니다. 보안 매개 변수로 전달합니다.
defaultScope	기본적으로 요청될 액세스 토큰 범위입니다. API 수준에서 재정의할 수 있습니다. 공백으로 구분된 값을 포함하는 문자열 형식으로 제공해야 합니다.	문자열
묘사	권한 부여 서버에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.	문자열
displayName	사용자에게 친숙한 권한 부여 서버 이름입니다.	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 50(필수)
grantTypes	클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationCode' 'clientCredentials' '암시적' 'resourceOwnerPassword'(필수)
resourceOwnerPassword	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.	문자열
resourceOwnerUsername	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.	문자열
supportState	true이면 권한 부여 서버에는 권한 부여 요청의 상태 매개 변수가 해당 응답에 포함됩니다. 클라이언트는 상태 매개 변수를 사용하여 프로토콜 보안을 높일 수 있습니다.	bool
tokenBodyParameters	이름 및 값 문자열 속성(예: {"name": "name value", "value": "a value"})이 있는 JSON 개체의 배열로 표시되는 이 권한 부여 서버의 토큰 엔드포인트에 필요한 추가 매개 변수입니다.	TokenBodyParameterContract[]
tokenEndpoint	OAuth 토큰 엔드포인트입니다. 참조되는 엔터티에 대한 절대 URI를 포함합니다.	문자열

Microsoft.ApiManagement/service/authorizationServers

이름	묘사	값
apiVersion	api 버전	'2021-01-01-preview'
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = `^[^*#&+:<>?]+$`(필수)
속성	외부 OAuth 권한 부여 서버 계약의 속성입니다.	AuthorizationServerContractProperties
형	리소스 종류	'Microsoft.ApiManagement/service/authorizationServers'

TokenBodyParameterContract

이름	묘사	값
이름	본문 매개 변수 이름입니다.	string(필수)
값	body 매개 변수 값입니다.	string(필수)

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

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

리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2021-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
    }
  })
}

속성 값

AuthorizationServerContractProperties

이름	묘사	값
authorizationEndpoint	OAuth 권한 부여 엔드포인트. http://tools.ietf.org/html/rfc6749#section-3.2참조하세요.	string(필수)
authorizationMethods	권한 부여 엔드포인트에서 지원하는 HTTP 동사입니다. GET은 항상 있어야 합니다. POST는 선택 사항입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	액세스 토큰이 API에 전달되는 메커니즘을 지정합니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationHeader' 'query'
clientAuthenticationMethod	이 권한 부여 서버의 토큰 엔드포인트에서 지원하는 인증 방법입니다. 가능한 값은 기본 및/또는 본문입니다. 본문을 지정하면 클라이언트 자격 증명 및 기타 매개 변수가 애플리케이션/x-www-form-urlencoded 형식으로 요청 본문 내에 전달됩니다.	다음 중 어느 것을 포함하는 문자열 배열: '기본' 'Body'
clientId	이 권한 부여 서버에 등록된 클라이언트 또는 앱 ID입니다.	string(필수)
clientRegistrationEndpoint	이 권한 부여 서버에 대한 클라이언트 또는 앱 등록이 수행되는 페이지에 대한 선택적 참조입니다. 참조되는 엔터티에 대한 절대 URL을 포함합니다.	string(필수)
clientSecret	이 권한 부여 서버에 등록된 클라이언트 또는 앱 암호입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.	문자열 제약 조건: 중요한 값입니다. 보안 매개 변수로 전달합니다.
defaultScope	기본적으로 요청될 액세스 토큰 범위입니다. API 수준에서 재정의할 수 있습니다. 공백으로 구분된 값을 포함하는 문자열 형식으로 제공해야 합니다.	문자열
묘사	권한 부여 서버에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.	문자열
displayName	사용자에게 친숙한 권한 부여 서버 이름입니다.	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 50(필수)
grantTypes	클라이언트가 액세스 토큰을 요청하는 데 사용하는 권한 부여 형식입니다.	다음 중 어느 것을 포함하는 문자열 배열: 'authorizationCode' 'clientCredentials' '암시적' 'resourceOwnerPassword'(필수)
resourceOwnerPassword	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 암호입니다.	문자열
resourceOwnerUsername	이 권한 부여 서버에서 리소스 소유자 암호 부여 유형을 지원하는 경우 필요에 따라 지정할 수 있습니다. 기본 리소스 소유자 사용자 이름입니다.	문자열
supportState	true이면 권한 부여 서버에는 권한 부여 요청의 상태 매개 변수가 해당 응답에 포함됩니다. 클라이언트는 상태 매개 변수를 사용하여 프로토콜 보안을 높일 수 있습니다.	bool
tokenBodyParameters	이름 및 값 문자열 속성(예: {"name": "name value", "value": "a value"})이 있는 JSON 개체의 배열로 표시되는 이 권한 부여 서버의 토큰 엔드포인트에 필요한 추가 매개 변수입니다.	TokenBodyParameterContract[]
tokenEndpoint	OAuth 토큰 엔드포인트입니다. 참조되는 엔터티에 대한 절대 URI를 포함합니다.	문자열

Microsoft.ApiManagement/service/authorizationServers

이름	묘사	값
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = `^[^*#&+:<>?]+$`(필수)
parent_id	이 리소스의 부모인 리소스의 ID입니다.	유형의 리소스에 대한 ID: 서비스
속성	외부 OAuth 권한 부여 서버 계약의 속성입니다.	AuthorizationServerContractProperties
형	리소스 종류	"Microsoft.ApiManagement/service/authorizationServers@2021-01-01-preview"

TokenBodyParameterContract

이름	묘사	값
이름	본문 매개 변수 이름입니다.	string(필수)
값	body 매개 변수 값입니다.	string(필수)

다음을 통해 공유

Microsoft.ApiManagement 서비스/authorizationServers 2021-01-01-preview

Bicep 리소스 정의

리소스 형식

속성 값

AuthorizationServerContractProperties

Microsoft.ApiManagement/service/authorizationServers

TokenBodyParameterContract

ARM 템플릿 리소스 정의

리소스 형식

속성 값

AuthorizationServerContractProperties

Microsoft.ApiManagement/service/authorizationServers

TokenBodyParameterContract

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

리소스 형식

속성 값

AuthorizationServerContractProperties

Microsoft.ApiManagement/service/authorizationServers

TokenBodyParameterContract

피드백

추가 리소스