Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2021-07-01-미리보기

Bicep 리소스 정의

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

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

사용 예제

Bicep 샘플

Cosmos DB SQL 역할 정의를 배포하는 기본 예제입니다.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'Strong'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource sqlRoleDefinition 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15' = {
  name: 'c3ce1661-d0b9-3476-0a7c-2654ce2f3055'
  parent: databaseAccount
  properties: {
    assignableScopes: [
      databaseAccount.id
    ]
    permissions: [
      {
        dataActions: [
          'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read'
        ]
      }
    ]
    roleName: resourceName
    type: 'CustomRole'
  }
}

Azure 확인된 모듈

다음 Azure 확인된 모듈 사용하여 이 리소스 유형을 배포할 수 있습니다.

모듈 묘사
코스모스 DB - SQL 역할 정의 Cosmos DB용 AVM 자식 모듈 - SQL 역할 정의

Azure 빠른 시작 샘플

다음 Azure 빠른 시작 템플릿에는 이 리소스 유형을 배포하기 위한 Bicep 샘플이 포함되어 있습니다.

Bicep 파일 묘사
데이터 평면 RBAC 사용하여 Azure Cosmos DB SQL 계정 만들기 이 템플릿은 SQL Cosmos 계정, 고유하게 유지 관리되는 역할 정의 및 AAD ID에 대해 고유하게 유지 관리되는 역할 할당을 만듭니다.

리소스 형식

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-07-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

속성 값

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

이름 묘사 값
이름 리소스 이름 string(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식 리소스의 기호 이름: databaseAccounts
속성 Azure Cosmos DB SQL 역할 정의를 만들고 업데이트하는 속성입니다. sqlRoleDefinitionResource

허가

이름 묘사 값
dataActions 허용되는 데이터 작업의 배열입니다. 문자열[]
데이터 작업 아님 거부된 데이터 작업의 배열입니다. 문자열[]

SqlRoleDefinitionResource

이름 묘사 값
assignableScopes 이 역할 정의를 사용하여 역할 할당을 만들 수 있는 정규화된 범위의 집합입니다. 이렇게 하면 전체 데이터베이스 계정 또는 기본 데이터베이스/컬렉션에 이 역할 정의를 적용할 수 있습니다. 요소가 하나 이상 있어야 합니다. 데이터베이스 계정보다 높은 범위는 할당 가능한 범위로 적용할 수 없습니다. 할당 가능한 범위에서 참조되는 리소스는 존재하지 않아도 됩니다. 문자열[]
권한을 이 역할 정의를 통해 허용되는 작업 집합입니다. 사용 권한[]
roleName 역할 정의에 대한 사용자 친화적인 이름입니다. 데이터베이스 계정에 대해 고유해야 합니다. 문자열
형 역할 정의가 기본 제공되었는지 또는 사용자가 만들어졌는지 여부를 나타냅니다. 'BuiltInRole'
'CustomRole'

ARM 템플릿 리소스 정의

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

사용 예제

Azure 빠른 시작 템플릿

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

템플렛 묘사
데이터 평면 RBAC 사용하여 Azure Cosmos DB SQL 계정 만들기

Azure 배포
이 템플릿은 SQL Cosmos 계정, 고유하게 유지 관리되는 역할 정의 및 AAD ID에 대해 고유하게 유지 관리되는 역할 할당을 만듭니다.

리소스 형식

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "apiVersion": "2021-07-01-preview",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

속성 값

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

이름 묘사 값
apiVersion api 버전 '2021-07-01-preview'
이름 리소스 이름 string(필수)
속성 Azure Cosmos DB SQL 역할 정의를 만들고 업데이트하는 속성입니다. sqlRoleDefinitionResource
형 리소스 종류 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

허가

이름 묘사 값
dataActions 허용되는 데이터 작업의 배열입니다. 문자열[]
데이터 작업 아님 거부된 데이터 작업의 배열입니다. 문자열[]

SqlRoleDefinitionResource

이름 묘사 값
assignableScopes 이 역할 정의를 사용하여 역할 할당을 만들 수 있는 정규화된 범위의 집합입니다. 이렇게 하면 전체 데이터베이스 계정 또는 기본 데이터베이스/컬렉션에 이 역할 정의를 적용할 수 있습니다. 요소가 하나 이상 있어야 합니다. 데이터베이스 계정보다 높은 범위는 할당 가능한 범위로 적용할 수 없습니다. 할당 가능한 범위에서 참조되는 리소스는 존재하지 않아도 됩니다. 문자열[]
권한을 이 역할 정의를 통해 허용되는 작업 집합입니다. 사용 권한[]
roleName 역할 정의에 대한 사용자 친화적인 이름입니다. 데이터베이스 계정에 대해 고유해야 합니다. 문자열
형 역할 정의가 기본 제공되었는지 또는 사용자가 만들어졌는지 여부를 나타냅니다. 'BuiltInRole'
'CustomRole'

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

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

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

사용 예제

Terraform 샘플

Cosmos DB SQL 역할 정의를 배포하는 기본 예제입니다.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlRoleDefinition" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = "c3ce1661-d0b9-3476-0a7c-2654ce2f3055"
  body = {
    properties = {
      assignableScopes = [
        azapi_resource.databaseAccount.id,
      ]
      permissions = [
        {
          dataActions = [
            "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read",
          ]
        },
      ]
      roleName = var.resource_name
      type     = "CustomRole"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-07-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  }
}

속성 값

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

이름 묘사 값
이름 리소스 이름 string(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: databaseAccounts
속성 Azure Cosmos DB SQL 역할 정의를 만들고 업데이트하는 속성입니다. sqlRoleDefinitionResource
형 리소스 종류 "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-07-01-preview"

허가

이름 묘사 값
dataActions 허용되는 데이터 작업의 배열입니다. 문자열[]
데이터 작업 아님 거부된 데이터 작업의 배열입니다. 문자열[]

SqlRoleDefinitionResource

이름 묘사 값
assignableScopes 이 역할 정의를 사용하여 역할 할당을 만들 수 있는 정규화된 범위의 집합입니다. 이렇게 하면 전체 데이터베이스 계정 또는 기본 데이터베이스/컬렉션에 이 역할 정의를 적용할 수 있습니다. 요소가 하나 이상 있어야 합니다. 데이터베이스 계정보다 높은 범위는 할당 가능한 범위로 적용할 수 없습니다. 할당 가능한 범위에서 참조되는 리소스는 존재하지 않아도 됩니다. 문자열[]
권한을 이 역할 정의를 통해 허용되는 작업 집합입니다. 사용 권한[]
roleName 역할 정의에 대한 사용자 친화적인 이름입니다. 데이터베이스 계정에 대해 고유해야 합니다. 문자열
형 역할 정의가 기본 제공되었는지 또는 사용자가 만들어졌는지 여부를 나타냅니다. 'BuiltInRole'
'CustomRole'