> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-permissions.md).

# Permissões de runbook

Como conceder/negar acesso a determinados runbooks.

{% embed url="<https://www.youtube.com/watch?v=bLi_k_Yzhyw>" %}

## Âmbito

Isto aborda como conceder/negar acesso a determinados runbooks num Tenant Azure. Se está à procura de respostas sobre quais permissões da API MS Graph são necessárias para executar uma determinada ação como runbook, consulte o nosso [requisitos](https://docs.realmjoin.com/pt/automatizacao/connecting-azure-automation/azure-ad-roles-and-permissions.md).

## Visão geral

"Runbook Permissions" definem a visibilidade dos runbooks para determinados utilizadores. Alguns runbooks também podem ser bloqueados/ocultados globalmente.

Tal como o [Personalizações do Runbook](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-customization.md), definir estas permissões é feito fornecendo uma configuração em formato JSON como administrador do RealmJoin no portal web do RealmJoin em <https://portal.realmjoin.com/settings/runbooks-permissions> .

### Sobre este guia

Daremos uma breve descrição da sintaxe e depois construiremos um exemplo completo passo a passo. Sinta-se à vontade para ir diretamente para o exemplo completo e começar a partir de [lá](#targetentitygroups).

## Sintaxe de configuração

### Nomes dos runbooks

Os runbooks são referenciados pelos seus nomes, tal como vistos na Conta de Automação do Azure, por exemplo, `rjgit-group_general_remove-group`.

Podem ser usados curingas ('\*') para corresponder a vários runbooks. Podem ser usados vários curingas na mesma string, por exemplo, `rjgit-*_security_*`. Isto corresponderia a todos os exemplos seguintes:

* `rjgit-org_security_list-inactive-users`
* `rjgit-device_security_enable-or-disable-device`

O prefixo `rjgit-` indica runbooks importados do nosso repositório público do GitHub. Os runbooks específicos do cliente não têm prefixo, por exemplo, `user_userinfo_custom-runbook`

### Entra ID Groups

Os grupos Entra ID serão referenciados usando o respetivo ID de objeto, como `91688d11-9a34-42cd-8d1e-ce617d6c1234`. Atualmente, só podem ser usados grupos de segurança.

## Estrutura e exemplo de JSON

Vamos construir um exemplo completo de configuração passo a passo.

Uma configuração JSON consiste em várias secções, mas todas são opcionais e podem ser omitidas.

É permitido adicionar comentários usando o prefixo "//".

### EnabledRunbookPatterns

Esta secção contém uma lista de runbooks permitidos para utilização. Se esta secção for omitida, todos os runbooks ficam ativados/permitidos por predefinição.

Se definir esta secção, então apenas os runbooks mencionados nesta secção poderão ser usados por qualquer função / suporte e administrador.

#### Exemplo

* Permita apenas determinados runbooks individuais fornecendo o respetivo nome completo

  `rjgit-group_general_remove-group`
* Permita todos os runbooks relacionados com dispositivos do nosso repositório partilhado

  `rjgit-device_*`
* Permita todos os runbooks de utilizador partilhados

  `rjgit-user_*`
* Permita todos os runbooks relacionados com utilizadores, específicos do cliente (locais)

  `user_*`

Isto exclui implicitamente muitos runbooks baseados em grupos e todos os runbooks baseados em org. Tenha atenção.

```
{
  "EnabledRunbookPatterns": [
    "rjgit-group_general_remove-group",
    "rjgit-device_*",
    "rjgit-user_*",
    "user_*"
  ]
}
```

### DisabledRunbookPatterns

Uma lista de runbooks que estão globalmente desativados / proibidos. Se esta secção for omitida ou estiver vazia, todos os runbooks ativados (dados através de [EnabledRunbookPatterns](#enabledrunbookpatterns)) podem ser usados.

As entradas desta secção têm prioridade sobre as entradas em [EnabledRunbookPatterns ](#enabledrunbookpatterns)- os runbooks ficarão ocultos/não poderão ser usados por ninguém neste Tenant.

#### Exemplo

Vamos reutilizar a `EnabledRunbookPatterns` secção anterior.

* Desative todos os runbooks partilhados (`rjgit-`) runbooks na `segurança` categoria.

```
{
  "EnabledRunbookPatterns": [
    "rjgit-group_general_remove-group",
    "rjgit-device_*",
    "rjgit-user_*",
    "user_*"
  ],
  "DisabledRunbookPatterns": [
    "rjgit-*_security_*"
  ]
}
```

### Funções

Nesta secção, pode atribuir uma lista de runbooks a um grupo Entra ID. Isto permite definir várias funções de suporte/operador no seu Tenant.

Se esta secção for omitida, todo o suporte do RealmJoin e os administradores terão acesso a todos os runbooks indicados nas secções anteriores.

{% hint style="warning" %}
Se estiver ativado, todos os utilizadores que não pertençam a uma função não verão quaisquer runbooks.
{% endhint %}

#### Exemplo

Continuando com o que temos, vamos criar uma função de suporte a dispositivos `DeviceAdmin` e uma função de suporte de utilizadores `UserAdmin`.

Aplicaremos essas funções a vários grupos Entra ID e, para cada função, daremos uma lista de runbooks permitidos. Tenha atenção — isto restringirá a função de suporte de utilizadores a apenas um pequeno conjunto de runbooks.

Vamos adicionar comentários ("//") ao lado do ID de objeto do grupo que ajudem o leitor fornecendo os nomes dos grupos Entra ID.

```json
{
  "EnabledRunbookPatterns": [
    "rjgit-group_general_remove-group",
    "rjgit-device_*",
    "rjgit-user_*",
    "user_*"
  ],
  "DisabledRunbookPatterns": [
    "rjgit-*_security_*"
  ],
  "Roles": {
    "DeviceAdmin": {
      "Grupos": [
        "9cbfc0af-c217-41e9-b790-3043788f1234", // 1.º grupo AAD de suporte a dispositivos
        "5555c0af-c217-41e9-b790-3043788f1234"  // 2.º grupo AAD de suporte a dispositivos - outra equipa
      ],
      "AllowedRunbookPatterns": [
        "rjgit-device_*"
      ]
    },
    "UserAdmin": {
      "Grupos": [
        "1234c0af-c217-41e9-b790-3043788f1234" // Grupo AAD de suporte de utilizadores
      ],
      "AllowedRunbookPatterns": [
        "rjgit-user_general_assign-or-unassign-license",
        "rjgit-user_mail_*",
        "user_*"
      ]
    }
  }
}
```

Agora a `UserAdmin` função pode:

* atribuir licenças a todos os utilizadores no seu Tenant
* modificar os endereços de e-mail de todos os utilizadores no seu Tenant

O `DeviceAdmin` a função pode

* apagar qualquer dispositivo no seu Tenant

### TargetEntityGroups

Talvez tenha alguns utilizadores VIP cruciais. Não deve ser possível que qualquer membro do suporte apague o dispositivo de um VIP ou modifique o endereço de e-mail de um VIP. Podemos usar "targeting" para restringir funções em utilizadores críticos a equipas dedicadas.

"Devices" serão alvo com base no utilizador principal/atribuído, mas não no objeto do dispositivo no Entra ID. Isto permite manter um modelo de grupos puramente baseado em utilizadores.

Assumimos que existem grupos Entra ID que contêm utilizadores VIP críticos. Usando esta secção, podemos delimitar cuidadosamente algumas funções e runbooks mais críticos para estes grupos Entra ID específicos (alvos).

Obviamente, se omitir esta secção, todos os utilizadores/grupos/dispositivos no seu Tenant são tratados de forma igual.

Se definir TargetEntityGroups, isso não deverá ter qualquer impacto em qualquer outro grupo não mencionado na secção.

#### Exemplo completo

Assuma o grupo `0000c0af-c217-41e9-b790-3043788f0000` é o nosso grupo de utilizadores VIP.

Introduzimos um novo grupo Entra ID `4444c0af-c217-41e9-b790-3043788f4444` que contém pessoal de suporte que foi aprovado para administrar utilizadores VIP. Este pessoal de suporte também deve ter todas as outras permissões básicas de suporte, por isso iremos adicioná-lo às funções existentes.

"Restringir" uma função não concederá novas funções a um colaborador de suporte.

```json
{
  "EnabledRunbookPatterns": [
    "rjgit-group_general_remove-group",
    "rjgit-device_*",
    "rjgit-user_*",
    "user_*"
  ],
  "DisabledRunbookPatterns": [
    "rjgit-*_security_*"
  ],
  "Roles": {
    "DeviceAdmin": {
      "Grupos": [
        "9cbfc0af-c217-41e9-b790-3043788f1234", // 1.º grupo AAD de suporte a dispositivos
        "5555c0af-c217-41e9-b790-3043788f1234", // 2.º grupo AAD de suporte a dispositivos - outra equipa
        "4444c0af-c217-41e9-b790-3043788f4444"  // Equipa de suporte VIP
      ],
      "AllowedRunbookPatterns": [
        "rjgit-device_*"
      ]
    },
    "UserAdmin": {
      "Grupos": [
        "1234c0af-c217-41e9-b790-3043788f1234", // Grupo AAD de suporte de utilizadores
        "4444c0af-c217-41e9-b790-3043788f4444"  // Equipa de suporte VIP
      ],
      "AllowedRunbookPatterns": [
        "rjgit-user_general_assign-or-unassign-license",
        "rjgit-user_mail_*",
        "user_*"
      ]
    }
  },
  "TargetEntityGroups": {
    "0000c0af-c217-41e9-b790-3043788f0000": {  // Utilizadores VIP - tratar com cuidado!
      "RestrictRoles": {
        "UserAdmin": [
          "4444c0af-c217-41e9-b790-3043788f4444" // Suporte VIP
        ],
        "DeviceAdmin": [
          "4444c0af-c217-41e9-b790-3043788f4444" // Suporte VIP
        ]
      }
    }
  }
}
```

#### **Exemplo: restringir o pessoal de suporte dos EUA a gerir apenas utilizadores dos EUA**

Neste cenário, temos pessoal de suporte sediado nos EUA que deve gerir apenas utilizadores localizados nos EUA. Para aplicar esta restrição:

* Crie uma regra de permissão que explicitamente **nega** aos colaboradores de suporte dos EUA a capacidade de executar Runbooks em **todos os utilizadores**.
* Adicione uma regra de exceção que especificamente **permite** a execução de Runbooks apenas para **utilizadores dos EUA**.

Isto garante que os colaboradores de suporte dos EUA têm permissões estritamente limitadas ao público-alvo pretendido (utilizadores dos EUA) e impede interações acidentais com utilizadores fora deste âmbito.

**Implementação**

1. Tem de ser atribuído um grupo Entra de Runbook Runners no Portal RealmJoin
   1. Settings > Permissions > Runbook Runner Permissions
   2. O grupo Entra dos colaboradores de suporte dos EUA tem de ser membro do grupo Runbook Runners para permitir a operação geral de Runbook no Portal RealmJoin.
2. Adicionar uma nova função em Settings > Runbook Permissions
   1. Na secção Roles, adicione a função USSupporters com o respetivo grupo Entra (ID de objeto do grupo)
   2. Adicione AllowedRunbookPatterns para os USSupporters
3. Modifique o TargetEntityGroups
   1. O grupo All-Users deve restringir a função USSupporters com um valor vazio (não é adicionado aqui nenhum ID de objeto de grupo Entra). Isto é uma negação implícita!
   2. O grupo US Users deve restringir a função USSupporters ao ID de objeto do grupo Entra dos colaboradores de suporte dos EUA

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FZ56Ipx6VuZDjIeZO2MTC%2Fimage.png?alt=media&amp;token=e3f5fe54-0d17-46f0-a106-f51d548bde64" alt=""><figcaption><p>Restringir o pessoal de suporte dos EUA a gerir apenas utilizadores dos EUA</p></figcaption></figure>

Segue-se o exemplo completo para este cenário:

```json
{
  // Permissão do portal:
  // Função Runbook Runner: US Supporters

  // Filiações em grupos:
  // 3e1e7540-7f0c-483c-b9bf-500342e2467c: All-Users
  // c603278c-cc36-4661-bb7a-eecb7ab079f9: US Supporters
  // 0f76d01e-cc6b-4553-bf1d-e4ccedd9c824: US Users

  "EnabledRunbookPatterns": [ // Ativação geral de Runbooks de e-mail e segurança
    "rjgit-*_mail_*",
    "rjgit-*security*"
  ],
  "DisabledRunbookPatterns": [
    "*password*"
  ],

  "Roles": {
    "USSupporters": {
      "Grupos": [
        "c603278c-cc36-4661-bb7a-eecb7ab079f9" // colaboradores de suporte dos EUA
      ],
      "AllowedRunbookPatterns": [ // Runbooks permitidos para esta função - US Supporters
        "rjgit-user_*",
        "rjgit-device_*",
        "rjgit-group_*"
      ]
    }
  },
  
  "TargetEntityGroups": {
    "3e1e7540-7f0c-483c-b9bf-500342e2467c": { // All-Users
      "RestrictRoles": {
        "USSupporters": [
          // em geral, não permita Runbooks para quaisquer US Supporters
        ]
      }
    },
    "0f76d01e-cc6b-4553-bf1d-e4ccedd9c824": { // US Users
      "RestrictRoles": {
        "USSupporters": [
          "c603278c-cc36-4661-bb7a-eecb7ab079f9" // colaboradores de suporte dos EUA
        ]
      }
    }
  }
}
```

### SchedulingEnabledRunbookPatterns

Esta secção contém uma lista de runbooks que serão assinalados como "agendáveis". O RealmJoin Port permitirá atribuir / gerir agendamentos para estes runbooks. Veja [Agendamento de runbooks](https://docs.realmjoin.com/pt/automatizacao/runbooks/scheduling.md).

O exemplo seguinte descreve o comportamento predefinido se SchedulingEnabledRunbookPatterns não estiver definido:

```json
{
  "SchedulingEnabledRunbookPatterns": [
    "*_scheduled"
  ]
}
```

### SchedulingDisabledRunbookPatterns

Esta secção contém uma lista de runbooks que serão colocados na lista negra para não serem assinalados como "agendáveis". O RealmJoin Port não permitirá atribuir / gerir agendamentos para estes runbooks. Veja [Agendamento de runbooks](https://docs.realmjoin.com/pt/automatizacao/runbooks/scheduling.md).

Um runbook presente tanto em SchedulingEnabledRunbookPatterns como em SchedulingDisabledRunbookPatterns **não** poderá ser agendável.

Por predefinição, nenhum runbook está na lista negra. O exemplo seguinte apenas demonstra a sintaxe:

```json
{
  "SchedulingDisabledRunbookPatterns": [
    "rjgit-user_*"
  ]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-permissions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
