Хранилища Microsoft.KeyVault/accessPolicies 2024-04-01-preview

Определение ресурса Bicep

Тип ресурса vaults/accessPolicies можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Базовый пример развертывания политик доступа к Key Vault.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
  name: resourceName
  location: location
  properties: {
    sku: {
      family: 'A'
      name: 'standard'
    }
    accessPolicies: []
    enableSoftDelete: true
    tenantId: tenant().tenantId
  }
}

resource putAccesspolicy 'Microsoft.KeyVault/vaults/accessPolicies@2023-02-01' = {
  name: 'add'
  parent: vault
  properties: {
    accessPolicies: [
      {
        objectId: deployer().objectId
        permissions: {
          certificates: [
            'ManageContacts'
          ]
          keys: [
            'Create'
          ]
          secrets: [
            'Set'
          ]
          storage: []
        }
        tenantId: tenant().tenantId
      }
    ]
  }
}

Проверенные модули Azure

Следующие Azure Проверенные модули могут использоваться для развертывания этого типа ресурсов.

Модуль Описание
Key Vault - Политика доступа Дочерний модуль AVM для Key Vault — политика доступа

Примеры быстрого запуска Azure

Следующие шаблоны Azure Quickstart содержат Bicep образцов для развертывания этого типа ресурсов.

Файл Bicep Описание
Развернуть рабочее пространство Azure Databricks со всеми тремя формами CMK Этот шаблон позволяет создать рабочее пространство Azure Databricks с управляемыми сервисами и CMK с шифрованием DBFS.
Развернуть Azure Databricks рабочее пространство с Управляемые диски CMK Этот шаблон позволяет создать рабочее пространство Azure Databricks с CMK Управляемые диски.
Развернуть Azure Databricks WS с CMK для шифрования DBFS Этот шаблон позволяет создать рабочее пространство Azure Databricks с помощью CMK для корневого шифрования DBFS
Развернуть Azure Databricks рабочее пространство с управляемыми сервисами CMK Этот шаблон позволяет создать рабочее пространство Azure Databricks с помощью CMK управляемых служб.
Концентратор FinOps Этот шаблон создаёт новый экземпляр хаба FinOps, включая Data Explorer, хранилище Озеро данных и Data Factory.

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/vaults/accessPolicies, добавьте следующий Bicep в ваш шаблон.

resource symbolicname 'Microsoft.KeyVault/vaults/accessPolicies@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    accessPolicies: [
      {
        applicationId: 'string'
        objectId: 'string'
        permissions: {
          certificates: [
            'string'
          ]
          keys: [
            'string'
          ]
          secrets: [
            'string'
          ]
          storage: [
            'string'
          ]
        }
        tenantId: 'string'
      }
    ]
  }
}

Значения свойств

Microsoft.KeyVault/vaults/accessPolicies

Имя Описание Ценность
имя Имя ресурса «Добавить»
"Удалить"
"replace" (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: хранилища
свойства Свойства политики доступа VaultAccessPolicyProperties (обязательно)

AccessPolicyEntry (Доступ к политике)

Имя Описание Ценность
applicationId Идентификатор приложения клиента, выполняющего запрос от имени субъекта струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
objectId Идентификатор объекта пользователя, принципала сервиса или группы безопасности в tenant Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. строка (обязательно)
Разрешения Разрешения удостоверения имеются для ключей, секретов и сертификатов. разрешения (обязательно)
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который следует использовать для аутентификации запросов в хранилище ключей. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

Разрешения

Имя Описание Ценность
Сертификаты Разрешения на сертификаты Массив строк, содержащий любой из:
"все"
"Backup"
Create
"Delete"
"deleteissuers"
«Получить»
'getissuers'
"Import"
"list"
"listissuers"
"managecontacts"
"manageissuers"
"Очистка"
"восстановление"
"restore"
'setIssuers'
"update"
Ключи Разрешения на ключи Массив строк, содержащий любой из:
"все"
"Backup"
Create
Расшифровка
"Delete"
"encrypt"
«Получить»
«GetRotationPolicy»
"Import"
"list"
"Очистка"
"восстановление"
"выпуск"
"restore"
"поворот"
«Установитьполитику ротации»
Знак
UnwrapKey
"update"
"проверка"
"wrapKey"
Секреты Разрешения на секреты Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
«Получить»
"list"
"Очистка"
"восстановление"
"restore"
«Набор»
хранение Разрешения для учетных записей хранения Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
Deletesas
«Получить»
"getsas"
"list"
"listsas"
"Очистка"
"восстановление"
"регенерировать ключ"
"restore"
«Набор»
"setsas"
"update"

Свойства политики VaultAccessPolicyProperties

Имя Описание Ценность
Политики доступа Массив от 0 до 16 удостоверений, имеющих доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей. AccessPolicyEntry[] (обязательно)

Определение ресурса шаблона ARM

Тип ресурса vaults/accessPolicies можно развернуть с помощью операций, предназначенных для следующих целей:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие Azure шаблоны быстрого запуска развёртают этот тип ресурса.

Шаблон Описание
Добавить политику доступа к KeyVault

Развернуться на Azure
Добавьте политику доступа в существующую keyVault без удаления существующих политик.
AzureDatabricks Template with default storage firewall

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks Private Endpoint, всеми тремя формами CMK и User-Assigned Access Connector.
Создать Azure SQL Server с защитой шифрования данных

Развернуться на Azure
Этот шаблон создаёт Azure SQL-сервер, активирует защиту шифрования данных с помощью заданного ключа, хранящегося в данном Key Vault
Развернуть рабочее пространство Azure Databricks со всеми тремя формами CMK

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks с управляемыми сервисами и CMK с шифрованием DBFS.
Развернуть Azure Databricks рабочее пространство с Управляемые диски CMK

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks с CMK Управляемые диски.
Развернуть Azure Databricks Workspace с PE, CMK всеми формами

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks с PrivateEndpoint и управляемыми сервисами, а также CMK с шифрованием DBFS.
Развернуть Azure Databricks WS с CMK для шифрования DBFS

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks с помощью CMK для корневого шифрования DBFS
Развернуть Azure Databricks рабочее пространство с управляемыми сервисами CMK

Развернуться на Azure
Этот шаблон позволяет создать рабочее пространство Azure Databricks с помощью CMK управляемых служб.
Развернуть аккаунт Озеро данных Store с encryption(Key Vault)

Развернуться на Azure
Этот шаблон позволяет развернуть аккаунт Azure Data Lake Store с включённым шифрованием данных. Этот аккаунт использует Azure Key Vault для управления ключом шифрования.
Концентратор FinOps

Развернуться на Azure
Этот шаблон создаёт новый экземпляр хаба FinOps, включая Data Explorer, хранилище Озеро данных и Data Factory.
шаблон присвоения роли идентификатора

Развернуться на Azure
Шаблон, который создаёт назначение ролей пользовательской идентичности на ресурсах, от которых зависит рабочая среда Машинное обучение Azure

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/vaults/accessPolicies, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "properties": {
    "accessPolicies": [
      {
        "applicationId": "string",
        "objectId": "string",
        "permissions": {
          "certificates": [ "string" ],
          "keys": [ "string" ],
          "secrets": [ "string" ],
          "storage": [ "string" ]
        },
        "tenantId": "string"
      }
    ]
  }
}

Значения свойств

Microsoft.KeyVault/vaults/accessPolicies

Имя Описание Ценность
apiVersion Версия API «2024-04-01-превью»
имя Имя ресурса «Добавить»
"Удалить"
"replace" (обязательно)
свойства Свойства политики доступа VaultAccessPolicyProperties (обязательно)
тип Тип ресурса "Microsoft.KeyVault/vaults/accessPolicies"

AccessPolicyEntry (Доступ к политике)

Имя Описание Ценность
applicationId Идентификатор приложения клиента, выполняющего запрос от имени субъекта струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
objectId Идентификатор объекта пользователя, принципала сервиса или группы безопасности в tenant Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. строка (обязательно)
Разрешения Разрешения удостоверения имеются для ключей, секретов и сертификатов. разрешения (обязательно)
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который следует использовать для аутентификации запросов в хранилище ключей. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

Разрешения

Имя Описание Ценность
Сертификаты Разрешения на сертификаты Массив строк, содержащий любой из:
"все"
"Backup"
Create
"Delete"
"deleteissuers"
«Получить»
'getissuers'
"Import"
"list"
"listissuers"
"managecontacts"
"manageissuers"
"Очистка"
"восстановление"
"restore"
'setIssuers'
"update"
Ключи Разрешения на ключи Массив строк, содержащий любой из:
"все"
"Backup"
Create
Расшифровка
"Delete"
"encrypt"
«Получить»
«GetRotationPolicy»
"Import"
"list"
"Очистка"
"восстановление"
"выпуск"
"restore"
"поворот"
«Установитьполитику ротации»
Знак
UnwrapKey
"update"
"проверка"
"wrapKey"
Секреты Разрешения на секреты Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
«Получить»
"list"
"Очистка"
"восстановление"
"restore"
«Набор»
хранение Разрешения для учетных записей хранения Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
Deletesas
«Получить»
"getsas"
"list"
"listsas"
"Очистка"
"восстановление"
"регенерировать ключ"
"restore"
«Набор»
"setsas"
"update"

Свойства политики VaultAccessPolicyProperties

Имя Описание Ценность
Политики доступа Массив от 0 до 16 удостоверений, имеющих доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей. AccessPolicyEntry[] (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса vaults/accessPolicies можно развернуть с помощью операций, предназначенных для следующих целей:

Примеры использования

Примеры Terraform

Базовый пример развертывания политик доступа к Key Vault.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "vault" {
  type      = "Microsoft.KeyVault/vaults@2023-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        family = "A"
        name   = "standard"
      }
      accessPolicies   = []
      enableSoftDelete = true
      tenantId         = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.accessPolicies]
  }
}

resource "azapi_resource_action" "put_accessPolicy" {
  type        = "Microsoft.KeyVault/vaults/accessPolicies@2023-02-01"
  resource_id = "${azapi_resource.vault.id}/accessPolicies/add"
  method      = "PUT"
  body = {
    properties = {
      accessPolicies = [
        {
          objectId = data.azurerm_client_config.current.object_id
          permissions = {
            certificates = [
              "ManageContacts",
            ]
            keys = [
              "Create",
            ]
            secrets = [
              "Set",
            ]
            storage = [
            ]
          }
          tenantId = data.azurerm_client_config.current.tenant_id
        },
      ]
    }
  }
  response_export_values = ["*"]
}

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/vaults/accessPolicies, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/accessPolicies@2024-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      accessPolicies = [
        {
          applicationId = "string"
          objectId = "string"
          permissions = {
            certificates = [
              "string"
            ]
            keys = [
              "string"
            ]
            secrets = [
              "string"
            ]
            storage = [
              "string"
            ]
          }
          tenantId = "string"
        }
      ]
    }
  }
}

Значения свойств

Microsoft.KeyVault/vaults/accessPolicies

Имя Описание Ценность
имя Имя ресурса «Добавить»
"Удалить"
"replace" (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: хранилища
свойства Свойства политики доступа VaultAccessPolicyProperties (обязательно)
тип Тип ресурса "Microsoft.KeyVault/vaults/accessPolicies@2024-04-01-preview"

AccessPolicyEntry (Доступ к политике)

Имя Описание Ценность
applicationId Идентификатор приложения клиента, выполняющего запрос от имени субъекта струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
objectId Идентификатор объекта пользователя, принципала сервиса или группы безопасности в tenant Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. строка (обязательно)
Разрешения Разрешения удостоверения имеются для ключей, секретов и сертификатов. разрешения (обязательно)
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который следует использовать для аутентификации запросов в хранилище ключей. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

Разрешения

Имя Описание Ценность
Сертификаты Разрешения на сертификаты Массив строк, содержащий любой из:
"все"
"Backup"
Create
"Delete"
"deleteissuers"
«Получить»
'getissuers'
"Import"
"list"
"listissuers"
"managecontacts"
"manageissuers"
"Очистка"
"восстановление"
"restore"
'setIssuers'
"update"
Ключи Разрешения на ключи Массив строк, содержащий любой из:
"все"
"Backup"
Create
Расшифровка
"Delete"
"encrypt"
«Получить»
«GetRotationPolicy»
"Import"
"list"
"Очистка"
"восстановление"
"выпуск"
"restore"
"поворот"
«Установитьполитику ротации»
Знак
UnwrapKey
"update"
"проверка"
"wrapKey"
Секреты Разрешения на секреты Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
«Получить»
"list"
"Очистка"
"восстановление"
"restore"
«Набор»
хранение Разрешения для учетных записей хранения Массив строк, содержащий любой из:
"все"
"Backup"
"Delete"
Deletesas
«Получить»
"getsas"
"list"
"listsas"
"Очистка"
"восстановление"
"регенерировать ключ"
"restore"
«Набор»
"setsas"
"update"

Свойства политики VaultAccessPolicyProperties

Имя Описание Ценность
Политики доступа Массив от 0 до 16 удостоверений, имеющих доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей. AccessPolicyEntry[] (обязательно)