다음을 통해 공유


Microsoft.ApiManagement 서비스/사용자 2022-08-01

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

속성 값

서비스/사용자

이름 묘사
이름 리소스 이름

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

문자 제한: 1-80

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

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

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식의 리소스에 대한 기호 이름: 서비스
속성 사용자 엔터티는 계약 속성을 만듭니다. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

이름 묘사
appType 사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다. 'developerPortal'
'portal'
확인 새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다. '초대'
'등록'
메일 주소 전자 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 254
firstName 이름. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ID 사용자 ID의 컬렉션입니다. UserIdentityContract[]
lastName 성. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
메모 관리자가 설정한 사용자에 대한 선택적 참고 사항입니다. 문자열
암호 사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다. 문자열
상태 계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다. 'active'
'차단됨'
'deleted'
'보류 중'

UserIdentityContract

이름 묘사
아이디 공급자 내의 식별자 값입니다. 문자열
공급자 ID 공급자 이름입니다. 문자열

빠른 시작 템플릿

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

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

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

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

속성 값

서비스/사용자

이름 묘사
리소스 종류 'Microsoft.ApiManagement/service/users'
apiVersion 리소스 api 버전 '2022-08-01'
이름 리소스 이름

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

문자 제한: 1-80

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

문자로 시작하고 영숫자로 끝납니다.
속성 사용자 엔터티는 계약 속성을 만듭니다. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

이름 묘사
appType 사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다. 'developerPortal'
'portal'
확인 새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다. '초대'
'등록'
메일 주소 전자 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 254
firstName 이름. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ID 사용자 ID의 컬렉션입니다. UserIdentityContract[]
lastName 성. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
메모 관리자가 설정한 사용자에 대한 선택적 참고 사항입니다. 문자열
암호 사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다. 문자열
상태 계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다. 'active'
'차단됨'
'deleted'
'보류 중'

UserIdentityContract

이름 묘사
아이디 공급자 내의 식별자 값입니다. 문자열
공급자 ID 공급자 이름입니다. 문자열

빠른 시작 템플릿

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

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

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

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

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

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

속성 값

서비스/사용자

이름 묘사
리소스 종류 "Microsoft.ApiManagement/service/users@2022-08-01"
이름 리소스 이름 string(필수)

문자 제한: 1-80

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

문자로 시작하고 영숫자로 끝납니다.
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
속성 사용자 엔터티는 계약 속성을 만듭니다. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

이름 묘사
appType 사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다. "developerPortal"
"portal"
확인 새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다. "초대"
"등록"
메일 주소 전자 메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 254
firstName 이름. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
ID 사용자 ID의 컬렉션입니다. UserIdentityContract[]
lastName 성. string(필수)

제약 조건:
최소 길이 = 1
최대 길이 = 100
메모 관리자가 설정한 사용자에 대한 선택적 참고 사항입니다. 문자열
암호 사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다. 문자열
상태 계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다. "활성"
"차단됨"
"deleted"
"보류 중"

UserIdentityContract

이름 묘사
아이디 공급자 내의 식별자 값입니다. 문자열
공급자 ID 공급자 이름입니다. 문자열