Implantação da solução UIP

uip solution deploy pega um pacote de solução publicado (consulte uip solution publish) e o instala no Orchestrator: cria uma pasta, provisiona recursos (filas, ativos, processos, buckets, conexões) e ativa a implantação.

Esta página abrange cada subcomando sob deploy, além do nível superior uip solution delete que gerencia soluções do Studio Web (não implantações).

Subcomando	Finalidade
run	Implante um pacote publicado no Orchestrator.
status	Verificar o status de uma implantação de pipeline.
list	Listar implantações existentes.
activate	Ative uma implantação que foi instalada sem ativação automática.
uninstall	Remova uma implantação e seus recursos provisionados.
config get	Busque a configuração de implantação padrão para um pacote.
config set	Defina uma propriedade do recurso em um arquivo de configuração de implantação.
config link	Vincule um recurso da solução a um recurso do Orchestrator existente.
config unlink	Remova um link de recurso de um arquivo de configuração de implantação.

Também documentado nesta página:

• uip solution delete — um verbo de nível superior que exclui uma solução do Studio Web por ID. Não é um subcomando de implantação; ele é documentado ao lado desses comandos por motivos de agrupamento.

Cada subcomando é autenticado. Execute uip login primeiro ou passe --tenant para direcionar um tenant específico.

Fluxo de trabalho típico

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)

---

Execução de implantação da solução uip

Implante um pacote da solução publicado no Orchestrator. Cria uma nova pasta (em --folder-path ou --folder-key), provisiona cada recurso descrito no pacote (ou em --config-file) e faz pesquisas até que a implantação atinja um estado terminal.

Resumo

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Opções

• -n, --name <deployment-name> (necessário) — Nome para a implantação. Usado por deploy status, activate e uninstall para identificar esta instalação.
• --package-name <name> (necessário) — Nome do pacote da solução. Use packages list para encontrar nomes disponíveis.
• --package-version <version> (necessário) — Versão do pacote da solução. Use packages list para encontrar versões disponíveis.
• --folder-name <name> (necessário) — Nome da nova pasta do Orchestrator criada para esta implantação (em --folder-path).
• --folder-path <path> Caminho da pasta pai (por exemplo, Shared). A pasta de implantação é criada abaixo dela.
• --folder-key <key> Chave de pasta pai (GUID). Alternativa para --folder-path.
• --config-file <path> Arquivo de configuração JSON. Gere com deploy config get, edite com config set / config link e passe aqui.
• -t, --tenant <tenant-name> — Tenant no qual implantar.
• --timeout <seconds> — Tempo limite de pesquisa de implantação. O padrão é 360.
• — --poll-interval <ms> entre pesquisas de status. O padrão é 5000.
• --login-validity <minutes> Minutos mínimos antes da expiração do token para disparar uma atualização. O padrão é 10.

Exemplos

Comum

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"

Com uma configuração personalizada

uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json

Scripting — capture o ID de implantação para chamadas de acompanhamento

PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Formato dos dados (--output json)

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}

Status de implantação de terminais: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError. Os estados terminais sem sucesso saem com 1 e agregam os erros de validação/conflito/agendamento/fluxo de trabalho no campo Instructions .

Comportamento do tempo limite

Se a implantação não atingir um estado terminal antes transcorrer --timeout , o comando sairá diferente de zero com um ponteiro para deploy status <pipeline-deployment-id> para que você possa continuar o monitoramento.

---

status de implantação da solução uip

Verificar o status atual de uma implantação do pipeline. Retorna o estado da implantação e, se disponível, o nome/pacote/versão da implantação e um resumo dos erros concatenados.

Argumentos

• <pipeline-deployment-id> (necessário) — O PipelineDeploymentId retornado por deploy run.

Opções

• -t, --tenant <tenant-name> — Tenant a consultar.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

---

lista de implantação da solução uip

Listar implantações de solução. Mostra o nome da implantação, o status, a versão do pacote e o caminho da pasta.

Opções

• -t, --tenant <tenant-name> — Tenant a consultar.
• --folder-path <path> Filtrar pelo caminho da pasta pai. A filtragem é aplicada após a busca; aumente --take se os resultados parecerem incompletos ao usar esse filtro.
• --folder-key <key> Filtrar por chave de pasta pai (GUID). Alternativa para --folder-path.
• --take <number> — Máximo de implantações a serem buscadas. O padrão é 10.
• --order-by <column> — Coluna pela qual ordenar. O padrão é startTime.
• --order-direction <direction> — Ascending ou Descending. O padrão é Descending.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy list --take 20 --folder-path "Shared/Production"

Formato dos dados (--output json)

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}

---

implantação da solução uip ativar

Ative uma implantação que foi instalada sem ativação automática. A ativação provisiona todos os componentes da solução. activate imprime as etapas de pré-ativação relatadas pelo Orchestrator (para stderr, via --log-level info), em seguida, chama a ativação e pesquisa até um estado terminal (SuccessfulActivate ou FailedActivate).

Argumentos

• <deployment-name> (necessário) — Nome da implantação a ser ativada. Use deploy list para encontrar nomes de implantações.

Opções

• -t, --tenant <tenant-name> — Tenant para o destino.
• --timeout <seconds> — Tempo limite da pesquisa de ativação. O padrão é 360.
• — --poll-interval <ms> entre pesquisas de status. O padrão é 5000.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy activate my-deployment

Formato dos dados (--output json)

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Se o Orchestrator não relatar instanceId ( nada para pesquisar), Status é Activation completed (no instance to poll) e o comando retorna com sucesso.

---

desinstalação da implantação da solução uip

Desinstala uma solução implantada. Remove todos os recursos provisionados e a pasta da solução.

Argumentos

• <deployment-name> (necessário) — Nome da implantação a ser desinstalada.

Opções

• -t, --tenant <tenant-name> — Tenant para o destino.
• --timeout <seconds> — Desinstalar tempo limite de pesquisa. O padrão é 360.
• — --poll-interval <ms> entre pesquisas de status. O padrão é 5000.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy uninstall my-deployment

Formato dos dados (--output json)

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Duas respostas de curto-requisito são possíveis:

• Uninstall completed immediately quando o Orchestrator relata complete: true na primeira chamada; nenhuma pesquisa acontece.
• Uninstall scheduled quando o Orchestrator agenda o trabalho sem retornar um ID de instância; os dados incluem o campo Scheduled da API.

---

Obtenção de configuração de implantação da solução uip

Busque a configuração de implantação padrão para um pacote de solução publicado. A configuração lista cada recurso que a solução criará (filas, ativos, processos, buckets, conexões...) com suas configurações padrão. Salve-o em um arquivo (-d), personalize com config set / config link e passe para deploy run --config-file.

Argumentos

• <package-name> (necessário) — Nome do pacote da solução. Use packages list.

Opções

• --package-version <version> — Versão do pacote. Mais recente será usado se omitido.
• -d, --destination <path> Grave a configuração nesse arquivo em vez de stdout.
• -t, --tenant <tenant-name> — Tenant a consultar.
• --login-validity <minutes> — O padrão é 10.

Exemplo

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

Formato dos dados (--output json)

Quando -d é fornecido:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}

Quando -d é omitido, a configuração é incorporada na resposta:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}

---

conjunto de configurações de implantação da solução uip

Edite uma propriedade de recurso em um arquivo de configuração de implantação. O arquivo permanece local até que você o passe para deploy run --config-file.

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação (produzido por config get).
• <args...> (necessário) — Depende de --all:
  • Sem --all: <resource> <property> <value> — por exemplo MyQueue maxNumberOfRetries 5.
  • Com --all: <property> <value> — aplica-se a todos os recursos no arquivo. Válido apenas para a propriedade conflictFixingAction de nível superior.

Opções

• --all Aplique a propriedade a todos os recursos no arquivo. Permitido apenas com conflictFixingAction (por exemplo UseExisting).

Exemplos

Alterar novas tentativas em uma única fila

uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

Definir uma política de correção de conflitos para cada recurso

uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

Formato dos dados (--output json)

Atualização de recurso único:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

Atualização em massa (--all):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

---

link de configuração de implantação da solução uip

Vincule um recurso da solução a um recurso do Orchestrator existente para que a implantação o reutilize em vez de criar um novo. As alterações são locais — aplique-as passando o arquivo para deploy run --config-file.

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação.
• <resource> (necessário) — Nome do recurso ou resourceKey do arquivo de configuração.

Opções

• -n, --name <name> (necessário) — Nome do recurso do Orchestrator existente ao qual vincular.
• --folder-path <path> — Caminho da pasta do Orchestrator onde o recurso existente reside.

Exemplo

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

Formato dos dados (--output json)

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

---

desvinculação da configuração da implantação da solução uip

Remova um link definido anteriormente com config link. No próximo deploy run --config-file, o recurso será criado novamente em vez de reutilizado.

Argumentos

• <file> (necessário) — Caminho para o arquivo JSON de configuração de implantação.
• <resource> (necessário) — Nome do recurso ou resourceKey para desvincular.

Exemplo

uip solution deploy config unlink ./deploy-config.json MyQueue

Formato dos dados (--output json)

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

Modos de falha

• Recurso não vinculado no momento. O comando recusa a desvinculação e aponta para config link.

---

exclusão da solução uip

uip solution delete um verbo de nível superior (não um subcomando deploy ) que exclui uma solução do Studio Web por seu ID de solução. O ID é emitido por uip solution upload e por flow debug em sua saída.

Isso não desinstala uma solução implantada do Orchestrator — use deploy uninstall para isso.

Resumo

uip solution delete <solution-id>

Argumentos

• <solution-id> (necessário) — O ID da solução do Studio Web (UUID).

Exemplo

uip solution delete a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

---

Comandos relacionados

• uip solution publish — etapa obrigatória antes de deploy run.
• uip solution packages list — descubra nomes e versões de pacotes.
• uip resource — inspecione ou crie os recursos do Orchestrator a que deploy config link faz referência.

Veja também

• Seu primeiro guia passo a passo do pipeline — empacotar → publicar → implantar execução.
• Autenticação e Configuração — configuração de sessão e padrões por tenant.
• uip solution visão geral.