通过

使用 Azure PowerShell 为 Azure Cosmos DB for NoSQL 数据库和容器创建资源锁

  • 项目

适用范围： NoSQL

注意

建议使用 Azure Az PowerShell 模块与 Azure 交互。 请参阅安装 Azure PowerShell 以开始使用。 若要了解如何迁移到 Az PowerShell 模块，请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。

本示例需要 Azure PowerShell Az 5.4.0 或更高版本。 运行 Get-Module -ListAvailable Az，查看已安装哪些版本。 如果需要安装，请参阅安装 Azure PowerShell 模块。

运行 Connect-AzAccount -Environment AzureChinaCloud 以登录到 Azure。

重要

除非在启用了 disableKeyBasedMetadataWriteAccess 属性的情况下先锁定 Azure Cosmos DB 帐户，否则资源锁对使用任何 Azure Cosmos DB SDK、任何工具（通过帐户密钥连接）或 Azure 门户进行连接的用户所做的更改均无效。 要详细了解如何启用此属性，请参阅防止 SDK 更改。

示例脚本

# References:
# Az.CosmosDB | https://learn.microsoft.com/powershell/module/az.cosmosdb
# Az.Resources | https://learn.microsoft.com/powershell/module/az.resources
# --------------------------------------------------
# Purpose
# 
# --------------------------------------------------
# Variables
# ***** SUBSTITUTE YOUR VALUES *****
$resourceGroupName = "myResourceGroup"
$accountName = "myaccount"
$databaseName = "myDatabase"
$collectionName = "myContainer"
# *****
$apiVersion = "2020-04-01" # Cosmos DB RP API version
$lockLevel = "CanNotDelete" # CanNotDelete or ReadOnly

$resourceTypeAccount = "Microsoft.DocumentDB/databaseAccounts"
$resourceTypeDatabase = "$resourceTypeAccount/sqlDatabases"
$resourceTypeCollection = "$resourceTypeDatabase/containers"

$resourceNameDatabase = "$accountName/$databaseName"
$lockNameDatabase = "$accountName-$databaseName-Lock"

$resourceNameCollection = "$accountName/$databaseName/$collectionName"
$lockNameCollection = "$accountName-$databaseName-$collectionName-Lock"
# --------------------------------------------------

Write-Host "Create a $lockLevel lock on resource $resourceNameDatabase"
New-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeDatabase `
	-ResourceName $resourceNameDatabase `
	-LockName $lockNameDatabase `
	-LockLevel $lockLevel `
	-Force

Write-Host "Create a $lockLevel lock on resource $resourceNameCollection"
New-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeCollection `
	-ResourceName $resourceNameCollection `
	-LockName $lockNameCollection `
	-LockLevel $lockLevel `
	-Force

Write-Host "List all locks on  Cosmos DB account $accountName to confirm lock creation"
Get-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeAccount `
	-ResourceName $accountName

Write-Host "Delete lock on resource $resourceNameDatabase"
Remove-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeDatabase `
	-ResourceName $resourceNameDatabase `
	-LockName $lockNameDatabase `
	-Force

Write-Host "Delete lock on resource $resourceNameCollection"
Remove-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeCollection `
	-ResourceName $resourceNameCollection `
	-LockName $lockNameCollection `
	-Force

Write-Host "List all locks on Cosmos DB account $accountName to confirm lock removal"
Get-AzResourceLock `
	-ApiVersion $apiVersion `
	-ResourceGroupName $resourceGroupName `
	-ResourceType $resourceTypeAccount `
	-ResourceName $accountName

清理部署

运行脚本示例后，可以使用以下命令删除资源组以及与其关联的所有资源。

Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"

脚本说明

此脚本使用以下命令。 表中的每条命令均链接到特定于命令的文档。

命令 说明
Azure 资源
New-AzResourceLock 创建资源锁。
Get-AzResourceLock 获取资源锁，或列出资源锁。
Remove-AzResourceLock 删除资源锁。

后续步骤

有关 Azure PowerShell 的详细信息，请参阅 Azure PowerShell 文档。