Disable local authentication methods for Cosmos DB database accounts using Azure CLI

Question

I am trying to create a cosmos DB account using Azure CLI. One of required policies I have to comply with is "Cosmos DB database accounts should have local authentication methods disabled". In the following document I see how to set it using Azure Resource Manager templates . See below

"resources": [
    {
        "type": " Microsoft.DocumentDB/databaseAccounts",
        "properties": {
            "disableLocalAuth": true,
            // ...
        },
        // ...
    },
    // ...
 ]

Now my question is how to do the same using AZ CLI?

The command I am using is => az cosmosdb create ...

I don't see any flag that will allow the similar setting in AZ CLI.

Thomas · Accepted Answer · 2022-04-19 01:52:06Z

19

It's not supported through the az cosmosdb commands but you could use the az resource update command to update this property:

$cosmosdbname = "<cosmos-db-account-name>"
$resourcegroup = "<resource-group-name>"
$cosmosdb = az cosmosdb show --name $cosmosdbname --resource-group $resourcegroup | ConvertFrom-Json

az resource update --ids $cosmosdb.id --set properties.disableLocalAuth=true --latest-include-preview

answered Apr 19, 2022 at 1:52

Thomas

30.5k6 gold badges99 silver badges143 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

DmitrySandalov Over a year ago

Another way to get resource ID: az cosmosdb show --name $cosmosdbname --resource-group $resourcegroup --query id -o tsv

Mark Brown · Accepted Answer · 2022-01-25 17:08:37Z

2

As of January 2022 this is only supported via ARM Templates but support for PS and CLI is planned. No ETA to share at this time.

answered Jan 25, 2022 at 17:08

Mark Brown

8,8312 gold badges21 silver badges23 bronze badges

Comments

Antonio · Accepted Answer · 2022-02-09 13:55:21Z

2

You can always use Azure REST API invocation to apply any change in the CosmosDB account, see here

https://learn.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/2021-10-15/database-accounts/create-or-update

I've used Postman for that, btw I post a CURL example here by which I was able to modify a couple of properties (you need to get an oauth2 token before):

curl --location --request PUT 'https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<database-account-name>?api-version=2021-10-15' \
--header 'Authorization: Bearer <oauth2-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "location": "North Europe",
    "properties": {
        "databaseAccountOfferType": "Standard",
        "disableLocalAuth": true,
        "disableKeyBasedMetadataWriteAccess":true,
        "locations": [
            {
                "isVirtualNetworkFilterEnabled": false,
                "locationName": "North Europe",
                "failoverPriority": 0,
                "isZoneRedundant": false
            }
        ]
    }
}'

answered Feb 9, 2022 at 13:55

Antonio

313 bronze badges

1 Comment

Inako Over a year ago

thank you. I will try it out

Sajeetharan · Accepted Answer · 2022-01-25 17:07:29Z

0

No , this is not supported through the Azure CLI when you are creating Azure Cosmos DB account via az cosmosdb create

answered Jan 25, 2022 at 17:07

Sajeetharan

223k65 gold badges370 silver badges409 bronze badges

2 Comments

Inako Over a year ago

So it is only possible using ARM templates or setting it manually from portal?

Sajeetharan Over a year ago

ARM template as of now

Dravidian · Accepted Answer · 2024-07-30 14:45:23Z

0

FWIW, this can be done by below commands through Azure Cli.

// Get the cosmos db azure resource using your resourceGroupName and accountName
$resource = Get-AzResource -ResourceType Microsoft.DocumentDB/databaseAccounts -ResourceGroupName $resourceGroupName -ResourceName $accountName

// Update property
$resource.Properties.disableLocalAuth = "True"
$resource | Set-AzResource -Force

answered Jul 30, 2024 at 14:45

Dravidian

3392 gold badges9 silver badges19 bronze badges

Collectives™ on Stack Overflow

Disable local authentication methods for Cosmos DB database accounts using Azure CLI

5 Answers 5

1 Comment

Comments

1 Comment

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

1 Comment

Comments

1 Comment

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related