Microsoft.DocumentDB cassandraClusters/dataCenters 2024-05-15
- senaste
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Bicep-resursdefinition
Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15' = {
parent: resourceSymbolicName
name: 'string'
properties: {
authenticationMethodLdapProperties: {
connectionTimeoutInMs: int
searchBaseDistinguishedName: 'string'
searchFilterTemplate: 'string'
serverCertificates: [
{
pem: 'string'
}
]
serverHostname: 'string'
serverPort: int
serviceUserDistinguishedName: 'string'
serviceUserPassword: 'string'
}
availabilityZone: bool
backupStorageCustomerKeyUri: 'string'
base64EncodedCassandraYamlFragment: 'string'
dataCenterLocation: 'string'
deallocated: bool
delegatedSubnetId: 'string'
diskCapacity: int
diskSku: 'string'
managedDiskCustomerKeyUri: 'string'
nodeCount: int
privateEndpointIpAddress: 'string'
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
sku: 'string'
}
}
Egenskapsvärden
AuthenticationMethodLdapProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| connectionTimeoutInMs | Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. | Int |
| searchBaseDistinguishedName | Unikt namn på objektet för att starta rekursiv sökning av användare från. | sträng |
| searchFilterTemplate | Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. | sträng |
| serverCertificates | Certifikat[] | |
| serverHostname | Värdnamn för LDAP-servern. | sträng |
| serverPort | Port för LDAP-servern. | Int |
| serviceUserDistinguishedName | Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. | sträng |
| serviceUserPassword | Lösenord för uppslagsanvändaren. | sträng |
CassandraError
| Namn | Beskrivning | Värde |
|---|---|---|
| additionalErrorInfo | Ytterligare information om felet. | sträng |
| kod | Felkoden som inträffade. | sträng |
| meddelande | Meddelandet om felet. | sträng |
| mål | Målresursen för felet. | sträng |
Intyg
| Namn | Beskrivning | Värde |
|---|---|---|
| Pem | PEM-formaterad offentlig nyckel. | sträng |
DataCenterResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| authenticationMethodLdapProperties | Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är i förhandsversion. | AuthenticationMethodLdapProperties |
| availabilityZone | Om datacentret har stöd för tillgänglighetszoner tillämpar du det på den vm-skalningsuppsättning som är värd för virtuella datorer i cassandra-datacentret. | Bool |
| backupStorageCustomerKeyUri | Anger nyckel-Uri för kundnyckeln som ska användas för kryptering av lagringskontot för säkerhetskopior. | sträng |
| base64EncodedCassandraYamlFragment | Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. | sträng |
| dataCenterLocation | Den region som det här datacentret ska skapas i. | sträng |
| frigjord | Om datacentret har frigjorts. | Bool |
| delegatedSubnetId | Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att vara av formatet "/subscriptions/<prenumerations-ID>/resourceGroups/<resursgrupp>/providers/Microsoft.Network/virtualNetworks/<virtuella nätverk>/undernät/<undernät>". | sträng |
| diskCapacity | Antal diskar som är anslutna till varje nod. Standardvärdet är 4. | Int |
| diskSku | Disk-SKU som används för datacenter. Standardvärdet är P30. | sträng |
| managedDiskCustomerKeyUri | Nyckel-URI som ska användas för kryptering av hanterade diskar. Se till att den systemtilldelade identiteten för klustret har tilldelats lämpliga behörigheter (nyckel hämta/omsluta/packa upp behörigheter) på nyckeln. | sträng |
| nodeCount | Antalet noder som datacentret ska ha. Det här är det önskade talet. När det har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. | Int |
| privateEndpointIpAddress | IP för VPN-slutpunkten för det här datacentret. | sträng |
| provisionError | Fel som rör resursetablering. | CassandraError |
| provisioningState | Status för resursen vid den tidpunkt då åtgärden anropades. | "Avbröts" "Skapar" "Ta bort" "Misslyckades" "Lyckades" "Uppdaterar" |
| Sku | SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 | sträng |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: cassandraClusters |
| Egenskaper | Egenskaper för ett hanterat Cassandra-datacenter. | DataCenterResourceProperties |
Resursdefinition för ARM-mall
Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2024-05-15",
"name": "string",
"properties": {
"authenticationMethodLdapProperties": {
"connectionTimeoutInMs": "int",
"searchBaseDistinguishedName": "string",
"searchFilterTemplate": "string",
"serverCertificates": [
{
"pem": "string"
}
],
"serverHostname": "string",
"serverPort": "int",
"serviceUserDistinguishedName": "string",
"serviceUserPassword": "string"
},
"availabilityZone": "bool",
"backupStorageCustomerKeyUri": "string",
"base64EncodedCassandraYamlFragment": "string",
"dataCenterLocation": "string",
"deallocated": "bool",
"delegatedSubnetId": "string",
"diskCapacity": "int",
"diskSku": "string",
"managedDiskCustomerKeyUri": "string",
"nodeCount": "int",
"privateEndpointIpAddress": "string",
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"sku": "string"
}
}
Egenskapsvärden
AuthenticationMethodLdapProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| connectionTimeoutInMs | Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. | Int |
| searchBaseDistinguishedName | Unikt namn på objektet för att starta rekursiv sökning av användare från. | sträng |
| searchFilterTemplate | Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. | sträng |
| serverCertificates | Certifikat[] | |
| serverHostname | Värdnamn för LDAP-servern. | sträng |
| serverPort | Port för LDAP-servern. | Int |
| serviceUserDistinguishedName | Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. | sträng |
| serviceUserPassword | Lösenord för uppslagsanvändaren. | sträng |
CassandraError
| Namn | Beskrivning | Värde |
|---|---|---|
| additionalErrorInfo | Ytterligare information om felet. | sträng |
| kod | Felkoden som inträffade. | sträng |
| meddelande | Meddelandet om felet. | sträng |
| mål | Målresursen för felet. | sträng |
Intyg
| Namn | Beskrivning | Värde |
|---|---|---|
| Pem | PEM-formaterad offentlig nyckel. | sträng |
DataCenterResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| authenticationMethodLdapProperties | Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är i förhandsversion. | AuthenticationMethodLdapProperties |
| availabilityZone | Om datacentret har stöd för tillgänglighetszoner tillämpar du det på den vm-skalningsuppsättning som är värd för virtuella datorer i cassandra-datacentret. | Bool |
| backupStorageCustomerKeyUri | Anger nyckel-Uri för kundnyckeln som ska användas för kryptering av lagringskontot för säkerhetskopior. | sträng |
| base64EncodedCassandraYamlFragment | Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. | sträng |
| dataCenterLocation | Den region som det här datacentret ska skapas i. | sträng |
| frigjord | Om datacentret har frigjorts. | Bool |
| delegatedSubnetId | Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att vara av formatet "/subscriptions/<prenumerations-ID>/resourceGroups/<resursgrupp>/providers/Microsoft.Network/virtualNetworks/<virtuella nätverk>/undernät/<undernät>". | sträng |
| diskCapacity | Antal diskar som är anslutna till varje nod. Standardvärdet är 4. | Int |
| diskSku | Disk-SKU som används för datacenter. Standardvärdet är P30. | sträng |
| managedDiskCustomerKeyUri | Nyckel-URI som ska användas för kryptering av hanterade diskar. Se till att den systemtilldelade identiteten för klustret har tilldelats lämpliga behörigheter (nyckel hämta/omsluta/packa upp behörigheter) på nyckeln. | sträng |
| nodeCount | Antalet noder som datacentret ska ha. Det här är det önskade talet. När det har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. | Int |
| privateEndpointIpAddress | IP för VPN-slutpunkten för det här datacentret. | sträng |
| provisionError | Fel som rör resursetablering. | CassandraError |
| provisioningState | Status för resursen vid den tidpunkt då åtgärden anropades. | "Avbröts" "Skapar" "Ta bort" "Misslyckades" "Lyckades" "Uppdaterar" |
| Sku | SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 | sträng |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | '2024-05-15' |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (krävs) |
| Egenskaper | Egenskaper för ett hanterat Cassandra-datacenter. | DataCenterResourceProperties |
| typ | Resurstypen | "Microsoft.DocumentDB/cassandraClusters/dataCenters" |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15"
name = "string"
body = jsonencode({
properties = {
authenticationMethodLdapProperties = {
connectionTimeoutInMs = int
searchBaseDistinguishedName = "string"
searchFilterTemplate = "string"
serverCertificates = [
{
pem = "string"
}
]
serverHostname = "string"
serverPort = int
serviceUserDistinguishedName = "string"
serviceUserPassword = "string"
}
availabilityZone = bool
backupStorageCustomerKeyUri = "string"
base64EncodedCassandraYamlFragment = "string"
dataCenterLocation = "string"
deallocated = bool
delegatedSubnetId = "string"
diskCapacity = int
diskSku = "string"
managedDiskCustomerKeyUri = "string"
nodeCount = int
privateEndpointIpAddress = "string"
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
sku = "string"
}
})
}
Egenskapsvärden
AuthenticationMethodLdapProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| connectionTimeoutInMs | Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. | Int |
| searchBaseDistinguishedName | Unikt namn på objektet för att starta rekursiv sökning av användare från. | sträng |
| searchFilterTemplate | Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. | sträng |
| serverCertificates | Certifikat[] | |
| serverHostname | Värdnamn för LDAP-servern. | sträng |
| serverPort | Port för LDAP-servern. | Int |
| serviceUserDistinguishedName | Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. | sträng |
| serviceUserPassword | Lösenord för uppslagsanvändaren. | sträng |
CassandraError
| Namn | Beskrivning | Värde |
|---|---|---|
| additionalErrorInfo | Ytterligare information om felet. | sträng |
| kod | Felkoden som inträffade. | sträng |
| meddelande | Meddelandet om felet. | sträng |
| mål | Målresursen för felet. | sträng |
Intyg
| Namn | Beskrivning | Värde |
|---|---|---|
| Pem | PEM-formaterad offentlig nyckel. | sträng |
DataCenterResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| authenticationMethodLdapProperties | Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är i förhandsversion. | AuthenticationMethodLdapProperties |
| availabilityZone | Om datacentret har stöd för tillgänglighetszoner tillämpar du det på den vm-skalningsuppsättning som är värd för virtuella datorer i cassandra-datacentret. | Bool |
| backupStorageCustomerKeyUri | Anger nyckel-Uri för kundnyckeln som ska användas för kryptering av lagringskontot för säkerhetskopior. | sträng |
| base64EncodedCassandraYamlFragment | Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. | sträng |
| dataCenterLocation | Den region som det här datacentret ska skapas i. | sträng |
| frigjord | Om datacentret har frigjorts. | Bool |
| delegatedSubnetId | Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att vara av formatet "/subscriptions/<prenumerations-ID>/resourceGroups/<resursgrupp>/providers/Microsoft.Network/virtualNetworks/<virtuella nätverk>/undernät/<undernät>". | sträng |
| diskCapacity | Antal diskar som är anslutna till varje nod. Standardvärdet är 4. | Int |
| diskSku | Disk-SKU som används för datacenter. Standardvärdet är P30. | sträng |
| managedDiskCustomerKeyUri | Nyckel-URI som ska användas för kryptering av hanterade diskar. Se till att den systemtilldelade identiteten för klustret har tilldelats lämpliga behörigheter (nyckel hämta/omsluta/packa upp behörigheter) på nyckeln. | sträng |
| nodeCount | Antalet noder som datacentret ska ha. Det här är det önskade talet. När det har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. | Int |
| privateEndpointIpAddress | IP för VPN-slutpunkten för det här datacentret. | sträng |
| provisionError | Fel som rör resursetablering. | CassandraError |
| provisioningState | Status för resursen vid den tidpunkt då åtgärden anropades. | "Avbröts" "Skapar" "Ta bort" "Misslyckades" "Lyckades" "Uppdaterar" |
| Sku | SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 | sträng |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: cassandraClusters |
| Egenskaper | Egenskaper för ett hanterat Cassandra-datacenter. | DataCenterResourceProperties |
| typ | Resurstypen | "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15" |