política- aoops do uip gov

Sintaxe e opções para a política CRUD do "uip gov aoops-policy", catálogo de produtos, catálogo de tipos de licença e comandos de modelo do Form.io.

uip gov aops-policy gerencia as políticas de governança do UiPath AOps — regras de configuração do produto (por exemplo, uma política do StudioX restringindo quais configurações do projeto são permitidas) criadas como um formulário Form.io preenchido e atribuídas entre tenants/usuários/grupos. Esta página abrange o lado da criação: o próprio registro da política (list/get/create/update/delete), além dos catálogos de referência somente leitura (product, license-type) e os comandos template que geram o modelo de dados do formulário preenchível da qual a carga data da política é criada. Para atribuir uma política a um assunto e resolver o que realmente se aplica no runtime, consulte aops-policy deployment e deployed-policy. Para a visão geral da ferramenta pai e Políticas de acesso, consulte uip gov.

Observação:

Fluxo típico: template get <product> → edite o form-data.json emitido → policy create --product-name <product> --name <name> --input form-data.json → deployment tenant configure (ou usuário/grupo) para implementá-lo.

Resumo

uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>

uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>

uip gov aops-policy license-type list

uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>

Cada verbo também aceita --login-validity <minutes> para substituir a vida útil do token de login interativo para essa chamada (raramente necessária).

lista de políticas aoops de uip gov

Listar políticas de governança, com filtragem e paginação opcionais. Retorna metadados da política (identificador, nome, produto, prioridade, disponibilidade) — não o data blob da política.

Opções

Long	Valor	Description
--product-name <product-name>	String	Restringir a um produto (por exemplo StudioX). Corresponde a product.name — consulte product list.
--product-label <productLabel>	String	Restringir a um produto por rótulo de exibição (por exemplo 'Studio X'). Prefira --product-name para scripts.
--search <searchTerm>	String	Correspondência de substring que não diferencia maiúsculas de minúsculas com o nome/descrição da política.
--sort-by <field>	String	Campo pelo qual classificar (por exemplo name, createdOn, priority). Transmitido para a API de governança.
--sort-order <direction>	asc | desc	Direção de classificação para --sort-by. Sem diferenciação entre maiúsculas e minúsculas; qualquer outro valor falhará no lado do cliente.
--limit <n>	Número inteiro	Tamanho da página 20Padrão.
--offset <n>	Número inteiro	Índice de página baseado zero.

Exemplo

uip gov aops-policy list --product-name StudioX --limit 2

Formato dos dados (--output json)

{
  "Code": "AopsPolicyList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
  ]
}

uip gov aoops-policy obter

Busca uma política por identificador, incluindo sua data carga completa (o diagrama de dados do formulário preenchido). Use para inspecionar valores enviados ou para gerar um update de acompanhamento.

Argumentos

Name	Required	Finalidade
<policyIdentifier>	sim	GUID da política, de list.

Exemplo

uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "AopsPolicyGet",
  "Data": {
    "identifier": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "Baseline StudioX Policy",
    "productName": "StudioX",
    "priority": 10,
    "availability": 1,
    "data": { "allowAnalytics": true, "maxProjects": 5 }
  }
}

As chaves de data são mantidas exatamente como aparecem no formulário Form.io (camlCase/kebab-case), não PascalCased — essa carga é projetada para fazer viagem de ida e volta para update --input não modificada.

criação de política do uip gov aops

Criar uma nova política de governança para um produto.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome da política legível por humanos (exclusivo dentro do produto).
--product-name <product-name>	String	sim	Produto de destino (por exemplo StudioX, AITrustLayer) — deve corresponder a um nome de product list.
--description <description>	String	não	Descrição em texto livre exibida na interface gráfica de governança.
--priority <n>	Número inteiro	não	Quando várias políticas se aplicam ao mesmo assunto, os números mais altos vencem.
--availability <n>	Número inteiro	não	Sinalizador de disponibilidade (enum específico do produto) — verifique a interface gráfica da governança ou os documentos de serviço para obter valores válidos.
--input <path>	Path	não	Arquivo JSON com o objeto de dados do formulário preenchido (de template get --output-form-data). Omitir para uma política sem carga útil de dados.

Exemplo

uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Formato dos dados (--output json)

{
  "Code": "AopsPolicyCreate",
  "Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}

A resposta reflete o blob de dados brutos ( duplamente envolvidos), não a forma mesclada get retorna — use get para produzir dados do formulário para um update --input de acompanhamento.

atualização da política do uip gov aops

Substitui os campos de uma política existente. Atualização completa, não um patch — todos os campos que você deseja manter devem ser aprovados novamente; omitir --description/--priority/--availability/--input limpa esse campo no servidor.

Opções

Long	Valor	Required	Description
--identifier <identifier>	GUID	sim	Política a ser atualizada. De list/get.
--name <name>	String	sim	Nome da política. Passar o nome existente o preserva.
--product-name <product-name>	String	sim	Deve corresponder ao produto existente da política. Não é possível alterar o produto na atualização.
--description <description>	String	não	Substituição completa: passe novamente o valor existente de get para preservá-lo.
--priority <n>	Número inteiro	não	Substituição completa: passe novamente o valor existente para preservá-lo.
--availability <n>	Número inteiro	não	Substituição completa: passe novamente o valor existente para preservá-lo.
--input <path>	Path	não	Substituição completa: passe novamente o data existente (salvo de get) para preservá-lo.

A falha ocorre com uma atualização do modelo "em andamento" se o modelo Form.io subjacente estiver sendo migrado — tente novamente após a conclusão.

Exemplo

uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Formato dos dados (--output json)

Mesmo formato que create, com Code: "AopsPolicyUpdate".

exclusão da política de aops uiip gov

Excluir permanentemente uma política de governança.

Observação:

Falha se a política ainda estiver atribuída a qualquer tenant/usuário/grupo. Execute deployment tenant\|user\|group remove em cada assunto primeiro e, em seguida, tente novamente.

Argumentos

Name	Required	Finalidade
<policyIdentifier>	sim	GUID da política, de list.

Exemplo

uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }

produto uip gov aops-policy

Catálogo somente leitura de produtos que publicam modelos de governança. Use para descobrir valores --product-name válidos.

lista de produtos da aops-policy de uip gov

Exemplo

uip gov aops-policy product list

Formato dos dados (--output json)

{
  "Code": "AopsProductList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
  ]
}

name é o que as entradas policy create --product-name, template get <productIdentifier> e deployment ... configure esperam; label é o nome de exibição.

produto uip gov aops-policy obter

Argumentos

Name	Required	Finalidade
<productIdentifier>	sim	Nome do produto (por exemplo StudioX) ou GUID — seja name ou identifier de product list.

Exemplo

uip gov aops-policy product get StudioX

Formato dos dados (--output json)

{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }

uip gov aoops-policy tipo de licença

O catálogo somente leitura de tipos de licença (por exemplo Attended, Unattended) — usado para delimitar entradas deployment tenant configure e como o argumento <license-type> para deployed-policy get/list.

lista de tipos de licenças-policy de uip gov

Exemplo

uip gov aops-policy license-type list

Formato dos dados (--output json)

{
  "Code": "AopsLicenseTypeList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
  ]
}

As entradas de deployment tenant configure feeds identifier; a exibição name é o que deployed-policy get/list aceita como <license-type>.

modelo de aops-policy de uip gov

Gera o modelo de dados do formulário preenchível (e uma referência legível por humanos) a partir do modelo de política Form.io de um produto — a origem da data carga útil de uma política.

modelo de aoops-policy de uip gov

Buscar o modelo Form.io ativo para um produto e emitir artefatos de política.

Argumentos

Name	Required	Finalidade
<productIdentifier>	sim	Nome ou identificador do produto (por exemplo StudioX).

Opções

Long	Valor	Description
--output-form-data <path>	Path	Escreva o JSON do modelo de dados do formulário preenchível — o objeto que você edita e envia de volta em create/update. Os componentes somente de exibição (oculto, botão, enviar, HTML, conteúdo) são ignorados; folhas ausentes obtenha padrões apropriados ao tipo (false para caixa de seleção, [] para editgrid, {} para caixas de seleção, null para text/select).
--output-template-locale-resource <path>	Path	Escreva uma referência legível por humanos resolvida por local: cada chave de local com escopo de produto é substituída por sua string em inglês (com um irmãos <prop>-key preservando o original), e defaultData.data se torna um mapa plano anotado ({ value, type, label, description?, tooltip? }). Prefixos entre produtos (por exemplo AutomationOps.submit) são deixados sem resolução.

Se nenhum sinalizador --output-* for passado, tanto o modelo quanto os dados do formulário serão retornados na carga stdout Data em vez disso.

Exemplo

uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json

Formato dos dados (--output json)

{
  "Code": "AopsPolicyTemplateGet",
  "Data": {
    "formDataFile": "/Users/alice/aops/form-data.json",
    "templateLocaleResourceFile": "/Users/alice/aops/reference.json"
  }
}

Quando nenhum sinalizador --output-* é passado, Data em vez disso contém template (o DTO bruto do Form.io) e formData (o Blueprint) diretamente — ambos preservam sua caixa de chave nativa do Form.io em vez de serem PascalCased, então formData viagens de ida e volta para create/update --input textual.

Um UnsupportedTemplateComponentError (o modelo de produto usa um tipo de componente que a CLI não pode converter) falha com ErrorCode: "configuration_error" e Retry: "RetryWillNotFix" — crie a política data manualmente nesse caso.

lista de modelos de aoops-policy de uip gov

Busque o modelo de cada produto e descarte um conjunto de artefatos completo por produto — use em vez de fazer o loop de template get.

Opções

Long	Valor	Required	Description
--output-dir <path>	Path	sim	Diretório sob o qual uma pasta <ProductName>/ por produto (contendo form-template.json, form-data.json, form-template-locale-resource.json) é criada.

As falhas por produto são coletadas e não anulam a execução — o comando só sai de diferente de zero se todos os produtos falharem.

Exemplo

uip gov aops-policy template list --output-dir ./aops-templates

Formato dos dados (--output json)

{
  "Code": "AopsPolicyTemplateList",
  "Data": {
    "outputDir": "/Users/alice/aops-templates",
    "results": [
      {
        "productName": "StudioX",
        "status": "Success",
        "templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
        "formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
        "templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
      }
    ]
  }
}

A entrada de um produto com falha tem status: "Failure" e um campo message em vez dos três caminhos do arquivo.

Relacionado

• uip gov — visão geral da ferramenta e Políticas de acesso.
• aops-policy deployment e deployed-policy — atribuem políticas a tenants/usuários/grupos, resolvem a política efetiva.
• compliance-packs — agrupe políticas em uma estrutura nomeada.

Veja também

• Ferramentas ( plugins )
• Opções globais
• Códigos de saída