Share via


Microsoft.DocumentDB cassandraClusters 2021-07-01-preview

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    authenticationMethod: 'string'
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    delegatedManagementSubnetId: 'string'
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

속성 값

cassandraClusters

Name Description
name 리소스 이름 string(필수)
위치 리소스가 속한 리소스 그룹의 위치입니다. string
tags 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. 태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요.
identity 리소스의 ID입니다. ManagedServiceIdentity
properties 관리되는 Cassandra 클러스터의 속성입니다. ClusterResourceProperties

ManagedServiceIdentity

Name Description
형식 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': 리소스에 사용되는 ID 유형입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.
userAssignedIdentities 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.

ClusterResourceProperties

Name Description
authenticationMethod Cassandra가 클라이언트를 인증하는 데 사용해야 하는 인증 방법입니다. 'None'은 인증을 해제하므로 비상 시를 제외하고는 사용하지 않아야 합니다. 'Cassandra'는 기본 암호 기반 인증입니다. 기본값은 'Cassandra'입니다. 'Cassandra'
'None'
cassandraVersion 이 클러스터가 실행 중으로 수렴되어야 하는 Cassandra 버전(예: 3.11). 업데이트되면 클러스터가 새 버전으로 마이그레이션하는 데 다소 시간이 걸릴 수 있습니다. 문자열
clientCertificates 클러스터에 연결하는 클라이언트에 권한을 부여하는 데 사용되는 TLS 인증서 목록입니다. 모든 연결은 clientCertificates가 설정되었는지 여부에 관계없이 TLS 암호화되지만 clientCertificates가 설정된 경우 관리되는 Cassandra 클러스터는 이 속성의 하나 이상의 공용 인증서에서 유효성을 검사할 수 있는 TLS 클라이언트 인증서를 포함하지 않는 모든 연결을 거부합니다. Certificate[]
clusterNameOverride cassandra.yaml의 clusterName 속성을 클러스터의 리소스 이름 외에 다른 항목으로 설정해야 하는 경우 이 속성에 사용할 값을 설정합니다. string
delegatedManagementSubnetId 이 클러스터의 관리 서비스에 네트워크 인터페이스가 연결되어 있어야 하는 서브넷의 리소스 ID입니다. 서브넷은 데이터 센터에 위임될 모든 서브넷으로 라우팅할 수 있어야 합니다. 리소스 ID는 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' 형식이어야 합니다. string
externalGossipCertificates 관리되지 않는 데이터 센터에서 가십을 승인하는 데 사용되는 TLS 인증서 목록입니다. 관리되지 않는 데이터 센터에 있는 모든 노드의 TLS 인증서는 이 속성에 제공된 인증서 중 하나를 사용하여 확인할 수 있어야 합니다. Certificate[]
externalSeedNodes 관리되지 않는 데이터 센터에 있는 시드 노드의 IP 주소 목록입니다. 이러한 노드는 모든 관리되는 노드의 시드 노드 목록에 추가됩니다. SeedNode[]
hoursBetweenBackups 클러스터의 백업을 수행하는 동안 대기하는 시간 수입니다. 백업을 사용하지 않도록 설정하려면 이 속성을 0으로 설정합니다. int
initialCassandraAdminPassword 클러스터에 관리자로 연결하는 클라이언트의 초기 암호입니다. 클러스터를 만든 후에 변경해야 합니다. GET에서 null을 반환합니다. 이 필드는 authenticationMethod 필드가 'Cassandra'인 경우에만 적용됩니다. string

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
prometheusEndpoint 관리되는 Cassandra 노드에 대한 데이터를 포함하는 Prometheus 엔드포인트에 연결할 수 있는 호스트 이름 또는 IP 주소입니다. SeedNode
provisioningState 작업이 호출되었을 때 리소스의 상태. 'Canceled'
'만들기'
'삭제 중'
'실패'
'성공'
'업데이트 중'
repairEnabled 이 클러스터에서 자동 복구를 실행해야 하나요? 생략하면 true이며, 이미 자체 복구를 수행하고 있는 하이브리드 클러스터를 실행하지 않는 한 true로 유지되어야 합니다. bool
restoreFromBackupId 빈 클러스터를 만들려면 이 필드를 생략하거나 null로 설정합니다. 백업을 새 클러스터로 복원하려면 이 필드를 백업의 리소스 ID로 설정합니다. string

인증서

Name Description
Pem PEM 형식 공개 키입니다. 문자열

SeedNode

Name Description
ipAddress 이 시드 노드의 IP 주소입니다. string

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2021-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "authenticationMethod": "string",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "delegatedManagementSubnetId": "string",
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

속성 값

cassandraClusters

Name Description
형식 리소스 종류 'Microsoft.DocumentDB/cassandraClusters'
apiVersion 리소스 api 버전 '2021-07-01-preview'
name 리소스 이름 string(필수)
위치 리소스가 속한 리소스 그룹의 위치입니다. string
tags 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. 태그 이름 및 값의 사전입니다. 템플릿의 태그를 참조하세요.
identity 리소스의 ID입니다. ManagedServiceIdentity
properties 관리되는 Cassandra 클러스터의 속성입니다. ClusterResourceProperties

ManagedServiceIdentity

Name Description
형식 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': 리소스에 사용되는 ID 유형입니다. 'SystemAssigned,UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 ID를 제거합니다.
userAssignedIdentities 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description
{사용자 지정 속성} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.

ClusterResourceProperties

Name Description
authenticationMethod Cassandra가 클라이언트를 인증하는 데 사용해야 하는 인증 방법입니다. 'None'은 인증을 해제하므로 비상 시를 제외하고는 사용하지 않아야 합니다. 'Cassandra'는 기본 암호 기반 인증입니다. 기본값은 'Cassandra'입니다. '카산드라'
'None'
cassandraVersion 이 클러스터가 실행에 수렴해야 하는 Cassandra 버전(예: 3.11)입니다. 업데이트되면 클러스터가 새 버전으로 마이그레이션하는 데 다소 시간이 걸릴 수 있습니다. 문자열
clientCertificates 클러스터에 연결하는 클라이언트에 권한을 부여하는 데 사용되는 TLS 인증서 목록입니다. 모든 연결은 clientCertificates가 설정되었는지 여부에 관계없이 TLS 암호화되지만 clientCertificates가 설정된 경우 관리되는 Cassandra 클러스터는 이 속성의 하나 이상의 공용 인증서에서 유효성을 검사할 수 있는 TLS 클라이언트 인증서를 포함하지 않는 모든 연결을 거부합니다. Certificate[]
clusterNameOverride cassandra.yaml의 clusterName 속성을 클러스터의 리소스 이름 외에 다른 항목으로 설정해야 하는 경우 이 속성에 사용할 값을 설정합니다. string
delegatedManagementSubnetId 이 클러스터의 관리 서비스에 연결된 네트워크 인터페이스가 있어야 하는 서브넷의 리소스 ID입니다. 서브넷은 데이터 센터에 위임될 모든 서브넷으로 라우팅할 수 있어야 합니다. 리소스 ID는 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' 형식이어야 합니다. 문자열
externalGossipCertificates 관리되지 않는 데이터 센터에서 험담을 승인하는 데 사용되는 TLS 인증서 목록입니다. 관리되지 않는 데이터 센터에 있는 모든 노드의 TLS 인증서는 이 속성에 제공된 인증서 중 하나를 사용하여 확인할 수 있어야 합니다. Certificate[]
externalSeedNodes 관리되지 않는 데이터 센터에 있는 시드 노드의 IP 주소 목록입니다. 이러한 노드는 모든 관리되는 노드의 시드 노드 목록에 추가됩니다. SeedNode[]
hoursBetweenBackups 클러스터 백업을 수행하는 동안 대기할 시간 수입니다. 백업을 사용하지 않도록 설정하려면 이 속성을 0으로 설정합니다. int
initialCassandraAdminPassword 클러스터에 관리자로 연결하는 클라이언트의 초기 암호입니다. 클러스터를 만든 후에 변경해야 합니다. GET에서 null을 반환합니다. 이 필드는 authenticationMethod 필드가 'Cassandra'인 경우에만 적용됩니다. string

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
prometheusEndpoint 관리되는 Cassandra 노드에 대한 데이터를 포함하는 Prometheus 엔드포인트에 연결할 수 있는 호스트 이름 또는 IP 주소입니다. SeedNode
provisioningState 작업이 호출되었을 때 리소스의 상태. '취소됨'
'만들기'
'삭제 중'
'실패'
'성공'
'업데이트 중'
repairEnabled 이 클러스터에서 자동 복구를 실행해야 하나요? 생략된 경우 이는 true이며, 이미 자체 복구를 수행하고 있는 하이브리드 클러스터를 실행하지 않는 한 true로 유지되어야 합니다. bool
restoreFromBackupId 빈 클러스터를 만들려면 이 필드를 생략하거나 null로 설정합니다. 백업을 새 클러스터로 복원하려면 이 필드를 백업의 리소스 ID로 설정합니다. string

인증서

Name Description
Pem PEM 형식의 공개 키입니다. 문자열

SeedNode

Name Description
ipAddress 이 시드 노드의 IP 주소입니다. string

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

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

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      delegatedManagementSubnetId = "string"
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

속성 값

cassandraClusters

Name Description
형식 리소스 종류 "Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview"
name 리소스 이름 string(필수)
위치 리소스가 속한 리소스 그룹의 위치입니다. string
parent_id 리소스 그룹에 배포하려면 해당 리소스 그룹의 ID를 사용합니다. string(필수)
tags 태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 여러 리소스 그룹에서 이 리소스를 보고 그룹화할 때 이러한 태그를 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 128자 이하의 키와 256자 이하의 값이 포함되어야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다. 태그 이름 및 값의 사전입니다.
identity 리소스의 ID입니다. ManagedServiceIdentity
properties 관리되는 Cassandra 클러스터의 속성입니다. ClusterResourceProperties

ManagedServiceIdentity

Name Description
형식 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": 리소스에 사용되는 ID 유형입니다. "SystemAssigned,UserAssigned" 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. "None" 형식은 서비스에서 모든 ID를 제거합니다.
identity_ids 리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. 사용자 ID ID의 배열입니다.

ManagedServiceIdentityUserAssignedIdentities

Name Description
{사용자 지정 속성} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

이 개체에는 배포 중에 설정할 속성이 포함되어 있지 않습니다. 모든 속성은 ReadOnly입니다.

ClusterResourceProperties

Name Description
authenticationMethod Cassandra가 클라이언트를 인증하는 데 사용해야 하는 인증 방법입니다. 'None'은 인증을 해제하므로 비상 시를 제외하고는 사용하지 않아야 합니다. 'Cassandra'는 기본 암호 기반 인증입니다. 기본값은 'Cassandra'입니다. "Cassandra"
“None”
cassandraVersion 이 클러스터가 실행에 수렴해야 하는 Cassandra 버전(예: 3.11)입니다. 업데이트되면 클러스터가 새 버전으로 마이그레이션하는 데 다소 시간이 걸릴 수 있습니다. 문자열
clientCertificates 클러스터에 연결하는 클라이언트에 권한을 부여하는 데 사용되는 TLS 인증서 목록입니다. 모든 연결은 clientCertificates가 설정되었는지 여부에 관계없이 TLS 암호화되지만 clientCertificates가 설정된 경우 관리되는 Cassandra 클러스터는 이 속성의 하나 이상의 공용 인증서에서 유효성을 검사할 수 있는 TLS 클라이언트 인증서를 포함하지 않는 모든 연결을 거부합니다. Certificate[]
clusterNameOverride cassandra.yaml의 clusterName 속성을 클러스터의 리소스 이름 외에 다른 항목으로 설정해야 하는 경우 이 속성에 사용할 값을 설정합니다. string
delegatedManagementSubnetId 이 클러스터의 관리 서비스에 연결된 네트워크 인터페이스가 있어야 하는 서브넷의 리소스 ID입니다. 서브넷은 데이터 센터에 위임될 모든 서브넷으로 라우팅할 수 있어야 합니다. 리소스 ID는 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' 형식이어야 합니다. 문자열
externalGossipCertificates 관리되지 않는 데이터 센터에서 험담을 승인하는 데 사용되는 TLS 인증서 목록입니다. 관리되지 않는 데이터 센터에 있는 모든 노드의 TLS 인증서는 이 속성에 제공된 인증서 중 하나를 사용하여 확인할 수 있어야 합니다. Certificate[]
externalSeedNodes 관리되지 않는 데이터 센터에 있는 시드 노드의 IP 주소 목록입니다. 이러한 노드는 모든 관리되는 노드의 시드 노드 목록에 추가됩니다. SeedNode[]
hoursBetweenBackups 클러스터 백업을 수행하는 동안 대기할 시간 수입니다. 백업을 사용하지 않도록 설정하려면 이 속성을 0으로 설정합니다. int
initialCassandraAdminPassword 클러스터에 관리자로 연결하는 클라이언트의 초기 암호입니다. 클러스터를 만든 후에 변경해야 합니다. GET에서 null을 반환합니다. 이 필드는 authenticationMethod 필드가 'Cassandra'인 경우에만 적용됩니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.
prometheusEndpoint 관리되는 Cassandra 노드에 대한 데이터를 포함하는 Prometheus 엔드포인트에 연결할 수 있는 호스트 이름 또는 IP 주소입니다. SeedNode
provisioningState 작업이 호출되었을 때 리소스의 상태. "취소됨"
"만들기"
"삭제 중"
"실패"
"성공"
"업데이트 중"
repairEnabled 이 클러스터에서 자동 복구를 실행해야 하나요? 생략된 경우 이는 true이며, 이미 자체 복구를 수행하고 있는 하이브리드 클러스터를 실행하지 않는 한 true로 유지되어야 합니다. bool
restoreFromBackupId 빈 클러스터를 만들려면 이 필드를 생략하거나 null로 설정합니다. 백업을 새 클러스터로 복원하려면 이 필드를 백업의 리소스 ID로 설정합니다. string

인증서

Name Description
Pem PEM 형식의 공개 키입니다. 문자열

SeedNode

Name Description
ipAddress 이 시드 노드의 IP 주소입니다. string