Partilhar via

Role Definitions - Create Or Update

  • Referência
Serviço:
Key Vault
Versão da API:
7.4

Cria ou atualiza uma definição de função personalizada.

PUT {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}?api-version=7.4

Parâmetros do URI

Name Em Necessário Tipo Description
roleDefinitionName
 path True

string

O nome da definição de função a criar ou atualizar. Pode ser qualquer GUID válido.
scope
 path True

string

O âmbito da definição de função a criar ou atualizar. O HSM gerido só suporta "/".
vaultBaseUrl
 path True

string

O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version
 query True

string

Versão da API de Cliente.

Corpo do Pedido

Name Necessário Tipo Description
properties True

RoleDefinitionProperties

Propriedades de definição de função.

Respostas

Name Tipo Description
201 Created

RoleDefinition

Criado – devolve informações sobre a definição de função.
Other Status Codes

KeyVaultError

Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

PutRoleDefinition

Pedido de amostra

PUT https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000?api-version=7.4

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

Resposta da amostra

Código de estado:
201 
{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "assignableScopes": [
      "/"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  },
  "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Authorization/roleDefinitions",
  "name": "00000000-0000-0000-0000-000000000000"
}

Definições

Name Description
DataAction

Permissões suportadas para ações de dados.
Error

O erro do servidor do cofre de chaves.
KeyVaultError

A exceção de erro do cofre de chaves.
Permission

Permissões de definição de função.
RoleDefinition

Definição de função.
RoleDefinitionCreateParameters

A definição de função cria parâmetros.
RoleDefinitionProperties

Propriedades de definição de função.
RoleDefinitionType

O tipo de definição de função.
RoleScope

O âmbito da função.
RoleType

O tipo de função.

DataAction

Permissões suportadas para ações de dados.

Name Tipo Description
Microsoft.KeyVault/managedHsm/backup/start/action

string

Inicie uma cópia de segurança do HSM.
Microsoft.KeyVault/managedHsm/backup/status/action

string

Leia um estado de cópia de segurança do HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action

string

Cópia de segurança de chaves HSM.
Microsoft.KeyVault/managedHsm/keys/create

string

Crie uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action

string

Desencriptar com uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/delete

string

Eliminar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete

string

Remova uma chave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action

string

Ler a chave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action

string

Recuperar a chave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/encrypt/action

string

Encriptar com uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action

string

Exportar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/import/action

string

Importar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/read/action

string

Leia os metadados da chave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action

string

Liberte uma chave HSM com a Versão de Chave Segura.
Microsoft.KeyVault/managedHsm/keys/restore/action

string

Restaurar chaves HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action

string

Inicie sessão com uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action

string

Desembrulhar com uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action

string

Verifique a utilização de uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action

string

Moldar com uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action

string

Atualize uma chave HSM.
Microsoft.KeyVault/managedHsm/restore/start/action

string

Inicie um restauro HSM.
Microsoft.KeyVault/managedHsm/restore/status/action

string

Leia o estado de restauro do HSM.
Microsoft.KeyVault/managedHsm/rng/action

string

Gerar números aleatórios.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action

string

Eliminar atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action

string

Obter atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action

string

Criar ou atualizar atribuição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action

string

Eliminar definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action

string

Obter definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action

string

Criar ou atualizar a definição de função.
Microsoft.KeyVault/managedHsm/securitydomain/download/action

string

Transfira um domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read

string

Verifique o estado da transferência do domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read

string

Transfira uma chave de transferência de domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action

string

Carregar um domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read

string

Verifique o estado do ficheiro de troca de domínios de segurança do HSM.

Error

O erro do servidor do cofre de chaves.

Name Tipo Description
code

string

O código de erro.
innererror

Error

O erro do servidor do cofre de chaves.
message

string

A mensagem de erro.

KeyVaultError

A exceção de erro do cofre de chaves.

Name Tipo Description
error

Error

O erro do servidor do cofre de chaves.

Permission

Permissões de definição de função.

Name Tipo Description
actions

string[]

Permissões de ação concedidas.
dataActions

DataAction[]

Permissões de ação de dados concedidas.
notActions

string[]

Permissões de ação excluídas mas não negadas. Podem ser concedidas por outras definições de função atribuídas a um principal.
notDataActions

DataAction[]

Permissões de ação de dados que são excluídas mas não negadas. Podem ser concedidas por outras definições de função atribuídas a um principal.

RoleDefinition

Definição de função.

Name Tipo Description
id

string

O ID da definição de função.
name

string

O nome da definição de função.
properties.assignableScopes

RoleScope[]

Âmbitos atribuíveis da definição de função.
properties.description

string

A descrição da definição de função.
properties.permissions

Permission[]

Permissões de definição de função.
properties.roleName

string

O nome da função.
properties.type

RoleType

O tipo de função.
type

RoleDefinitionType

O tipo de definição de função.

RoleDefinitionCreateParameters

A definição de função cria parâmetros.

Name Tipo Description
properties

RoleDefinitionProperties

Propriedades de definição de função.

RoleDefinitionProperties

Propriedades de definição de função.

Name Tipo Description
assignableScopes

RoleScope[]

Âmbitos atribuíveis da definição de função.
description

string

A descrição da definição de função.
permissions

Permission[]

Permissões de definição de função.
roleName

string

O nome da função.
type

RoleType

O tipo de função.

RoleDefinitionType

O tipo de definição de função.

Name Tipo Description
Microsoft.Authorization/roleDefinitions

string

RoleScope

O âmbito da função.

Name Tipo Description
/

string

Âmbito global
/keys

string

Âmbito das chaves

RoleType

O tipo de função.

Name Tipo Description
AKVBuiltInRole

string

Função incorporada.
CustomRole

string

Função personalizada.