Azure / Azure/azure-rest-api-specs
[BUG] Microsoft.DocumentDB/databaseAccounts - GET DatabaseAccount : sqlEndpoint, configurationOverrides -- additional properties
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 424
Description
### API Spec link
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json
### API Spec version
2024-02-15-preview, 2023-11-15
### Describe the bug
Operation `DatabaseAccounts_Get` in [cosmos-db.json](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json), so simple GET DatabaseAccount
As example [CosmosDBDatabaseAccountGet.json](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2024-02-15-preview/examples/CosmosDBDatabaseAccountGet.json), response describing a resource, it should be without:
`properties.sqlEndpoint`
`properties.configurationOverrides: {...}`
`properties.defaultPriorityLevel`
`properties.enablePerRegionPerPartitionAutoscale`
`properties.enablePriorityBasedExecution`
`minMaxThresholdsForPriorityBasedExecution: {...}`
There are also examples in Azure REST API for [Database Accounts - Get](https://learn.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/database-accounts/get). Found with [Microsoft.DocumentDB](https://learn.microsoft.com/en-us/azure/templates/microsoft.documentdb/databaseaccounts) ARM template/Bicep description.
Using it with Azure Cosmos DB for MongoDB account (RU).
### Expected behavior
```json
{
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb",
"identity": {
"type": "None"
},
"kind": "MongoDB",
"location": "Europe",
"name": "my-cosmosdb",
"properties": {
"EnabledApiTypes": "MongoDB",
"analyticalStorageConfiguration": {
"schemaType": "FullFidelity"
},
"apiProperties": {
"serverVersion": "4.2"
},
"backupPolicy": {
"periodicModeProperties": {
"backupIntervalInMinutes": 240,
"backupRetentionIntervalInHours": 8,
"backupStorageRedundancy": "Geo"
},
"type": "Periodic"
},
"capabilities": [
{
"name": "EnableMongo"
}
],
"configurationOverrides": {
"EnableBsonSchema": "True",
"EnablePerRegionPerPartitionAutoscaleOptIn": "True"
},
"consistencyPolicy": {
"defaultConsistencyLevel": "Eventual",
"maxIntervalInSeconds": 5,
"maxStalenessPrefix": 100
},
"cors": [],
"databaseAccountOfferType": "Standard",
"defaultIdentity": "FirstPartyIdentity",
"diagnosticLogSettings": {
"enableFullTextQuery": "None"
},
"disableKeyBasedMetadataWriteAccess": true,
"disableLocalAuth": false,
"documentEndpoint": "https://my-cosmosdb.documents.azure.com:443/",
"enableAnalyticalStorage": true,
"enableAutomaticFailover": false,
"enableBurstCapacity": false,
"enableFreeTier": false,
"enableMultipleWriteLocations": false,
"enablePartitionKeyMonitor": false,
"enablePartitionMerge": false,
"failoverPolicies": [
{
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"locationName": "Europe"
}
],
"instanceId": "1111bb22-22aa-1a1a-11a1-1111aaa1a111",
"ipRules": [
{
"ipAddressOrRange": "104.1.1.1"
}
],
"isVirtualNetworkFilterEnabled": true,
"keysMetadata": {
"primaryMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"primaryReadonlyMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"secondaryMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"secondaryReadonlyMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
}
},
"locations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
],
"minimalTlsVersion": "Tls12",
"mongoEndpoint": "https://my-cosmosdb.mongo.cosmos.azure.com:443/",
"networkAclBypass": "None",
"networkAclBypassResourceIds": [],
"privateEndpointConnections": [
{
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb/privateEndpointConnections/my-cosmosdb-MongoDB-pe",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.Network/privateEndpoints/my-cosmosdb-MongoDB-pe"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "None",
"status": "Approved"
}
}
}
],
"provisioningState": "Succeeded",
"publicNetworkAccess": "Disabled",
"readLocations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
],
"virtualNetworkRules": [],
"writeLocations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
]
},
"systemData": {
"createdAt": "2023-12-01T11:59:35.4483112+00:00"
},
"tags": {},
"type": "Microsoft.DocumentDB/databaseAccounts"
}
```
### Actual behavior
```json
{
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb",
"identity": {
"type": "None"
},
"kind": "MongoDB",
"location": "Europe",
"name": "my-cosmosdb",
"properties": {
"EnabledApiTypes": "MongoDB",
"analyticalStorageConfiguration": {
"schemaType": "FullFidelity"
},
"apiProperties": {
"serverVersion": "4.2"
},
"backupPolicy": {
"periodicModeProperties": {
"backupIntervalInMinutes": 240,
"backupRetentionIntervalInHours": 8,
"backupStorageRedundancy": "Geo"
},
"type": "Periodic"
},
"capabilities": [
{
"name": "EnableMongo"
}
],
"consistencyPolicy": {
"defaultConsistencyLevel": "Eventual",
"maxIntervalInSeconds": 5,
"maxStalenessPrefix": 100
},
"cors": [],
"databaseAccountOfferType": "Standard",
"defaultIdentity": "FirstPartyIdentity",
"defaultPriorityLevel": "High",
"diagnosticLogSettings": {
"enableFullTextQuery": "None"
},
"disableKeyBasedMetadataWriteAccess": true,
"disableLocalAuth": false,
"documentEndpoint": "https://my-cosmosdb.documents.azure.com:443/",
"enableAnalyticalStorage": true,
"enableAutomaticFailover": false,
"enableBurstCapacity": false,
"enableFreeTier": false,
"enableMultipleWriteLocations": false,
"enablePartitionKeyMonitor": false,
"enablePartitionMerge": false,
"enablePerRegionPerPartitionAutoscale": false,
"enablePriorityBasedExecution": false,
"failoverPolicies": [
{
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"locationName": "Europe"
}
],
"instanceId": "1111bb22-22aa-1a1a-11a1-1111aaa1a111",
"ipRules": [
{
"ipAddressOrRange": "104.1.1.1"
}
],
"isVirtualNetworkFilterEnabled": true,
"keysMetadata": {
"primaryMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"primaryReadonlyMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"secondaryMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
},
"secondaryReadonlyMasterKey": {
"generationTime": "2023-12-01T11:59:35.4483112+00:00"
}
},
"locations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
],
"minMaxThresholdsForPriorityBasedExecution": {
"maxPercentForHighPriorityRequests": 100,
"maxPercentForLowPriorityRequests": 100,
"minPercentForHighPriorityRequests": 0,
"minPercentForLowPriorityRequests": 0
},
"minimalTlsVersion": "Tls12",
"mongoEndpoint": "https://my-cosmosdb.mongo.cosmos.azure.com:443/",
"networkAclBypass": "None",
"networkAclBypassResourceIds": [],
"privateEndpointConnections": [
{
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb/privateEndpointConnections/my-cosmosdb-MongoDB-pe",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.Network/privateEndpoints/my-cosmosdb-MongoDB-pe"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "None",
"status": "Approved"
}
}
}
],
"provisioningState": "Succeeded",
"publicNetworkAccess": "Disabled",
"readLocations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
],
"sqlEndpoint": "https://my-cosmosdb.documents.azure.com:443/",
"virtualNetworkRules": [],
"writeLocations": [
{
"documentEndpoint": "https://my-cosmosdb-europe.documents.azure.com:443/",
"failoverPriority": 0,
"id": "my-cosmosdb-europe",
"isZoneRedundant": false,
"locationName": "Europe",
"provisioningState": "Succeeded"
}
]
},
"systemData": {
"createdAt": "2023-12-01T11:59:35.4483112+00:00"
},
"tags": {},
"type": "Microsoft.DocumentDB/databaseAccounts"
}
```
### Reproduction Steps
`az rest --method get --header "Accept=application/json" --url 'https://management.azure.com/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb?api-version=2024-02-15-preview'`
||
GET `https://management.azure.com/subscriptions/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/resourceGroups/my-rg/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb?api-version=2024-02-15-preview`
also with `api-version=2023-11-15`
### Environment
_No response_
Contributor guide
Assessment
This issue has not been assessed yet.