Implantação da solução UIP

Sintaxe e opções para "uip solution implant", que instala, atualiza, ativa e desinstala implantações de solução no Orchestrator.

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 em deploy.

Subcomando	Finalidade
run	Instale uma nova implantação a partir de um pacote publicado.
upgrade	Atualize uma implantação existente para uma versão de pacote mais recente, no local.
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:

Cada subcomando é autenticado. Execute uip login primeiro.

Fluxo de trabalho típico

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       ├─→ deploy upgrade    (new package version, same deployment)
                                                       └─→ deploy uninstall  (tear down)

deploy run cria uma nova implantação em uma nova pasta — ele nunca atualiza uma existente. Se um pacote já estiver implantado sob um determinado --name, use deploy upgrade para mover essa implantação para uma nova versão no local ou passe -y, --yes em deploy run para instalar uma segunda cópia independente.

---

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

Instale uma nova implantação de solução no Orchestrator a partir de um pacote publicado. Cria uma nova pasta (em --parent-folder-path ou --parent-folder-key, ou o Espaço de Trabalho Pessoal do usuário atual), provisiona cada recurso descrito no pacote (ou em --config-file) e — a menos que --skip-activate esteja definido — o ativa.

Como isso sempre cria uma nova implantação, o comando primeiro verifica se o pacote já possui uma sob a mesma --name; se estiver, ele para e aponta para deploy upgrade em vez de reinstalar silenciosamente. Essa verificação é o melhor esforço, não uma garantia: ela lê a pesquisa de Soluções, que precisa de uma sessão de usuário, portanto, um login de aplicativo (credenciais do cliente) a ignora e uma falha de pesquisa apenas adverte.

Resumo

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
  [--feed <name-or-key>] \
  [--config-file <path>] \
  [--skip-activate] \
  [--wait] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Opções

Long	Valor	Padrão	Description
-n, --name <deployment-name>	text	—	Obrigatório. Nome para a implantação. Usado por deploy status, deploy upgrade, deploy activate e deploy uninstall para identificar esta instalação.
--package-name <name>	text	—	Obrigatório. Nome do pacote da solução. Use packages list para encontrar nomes disponíveis.
--package-version <version>	text	—	Obrigatório. Versão do pacote da solução.
--folder-name <name>	text	—	Obrigatório. Nome da nova pasta do Orchestrator criada para esta implantação.
--parent-folder-path <path>	Path	—	Caminho Shared da pasta pai (por exemplo,). A pasta de implantação é criada abaixo dela. mutuamente exclusivo com --parent-folder-key e --personal-workspace.
--parent-folder-key <key>	GUID	—	Chave da pasta pai. Alternativa --parent-folder-path para.
--personal-workspace	Bandeira	desativada	Implante no Espaço de trabalho pessoal do usuário atual. O nome do espaço de trabalho é resolvido a partir do Orchestrator automaticamente. mutuamente exclusivo com --parent-folder-path, --parent-folder-key e --feed.
--feed <name-or-key>	text	Feed do tenant	Implante um pacote publicado neste feed (nome ou chave de pasta, de solution feeds list) em vez do feed do tenant. Esses escopos dos quais o pacote vem — os sinalizadores --parent-folder-path/--parent-folder-key/--personal-workspace ainda controlam onde a pasta do Orchestrator é criada. Mutualmente exclusivo com --personal-workspace.
--config-file <path>	Path	—	Arquivo de configuração JSON ou YAML. Gere com deploy config get, edite com config set / config link e, em seguida, passe aqui.
--skip-activate	Bandeira	desativada	Ignorar ativação automática; deixe a implantação no estado Inactive (Ready to activate). Ative mais tarde com deploy activate.
--wait	Bandeira	desativada	Para uma implantação --personal-workspace ou --feed, espere ela finalizar em vez de retornar assim que começar (limitada por --timeout). O caminho do feed do tenant sempre espera, então este sinalizador não muda nada lá.
-y, --yes	Bandeira	desativada	Implante mesmo quando esse pacote já tiver uma implantação --name em, instalando uma segunda cópia independente com sua própria pasta.
--timeout <seconds>	segundos	360	Tempo limite de pesquisa aplicado por fase — implantar e (quando não ignorado) ativar.
--poll-interval <ms>	ms	5000	Milissegundos entre pesquisas de status durante as fases de implantação e ativação.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

Comum

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

Pular ativação automática

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

No Espaço de Trabalho Pessoal, aguardando a conclusão

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace --wait

Uma segunda cópia independente de um pacote já implantado

uip solution deploy run \
  --name my-deployment-2 \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolutionCopy --parent-folder-path "Shared" --yes

De um feed de pasta

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --feed Finance

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 --parent-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 --parent-folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Formato dos dados (--output json)

Implantação de feed do tenant (Sempre aguarda):

{
  "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",
    "ActivationStatus": "SuccessfulActivate"
  }
}

Espaço de trabalho pessoal / implantação de feed de pasta sem --wait:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentStarted",
    "DeploymentName": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "FolderName": "MySolution",
    "FolderPath": "[e-mail]/MySolution",
    "ActivationStatus": "Auto",
    "NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
  }
}

RequestedFolderName e FolderNote aparecem apenas quando o --folder-name solicitado já foi executado: o Orchestrator renomeia a pasta em vez de reutilizá-la, então o FolderName/FolderPath real difere do que foi solicitado e FolderNote explica a renomeação com um ponteiro para usar a pasta renomeada ou executar novamente com um nome livre.

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.

Modos de falha

• A implantação já existe em --name. Recusado, a menos que -y, --yes seja aprovado (instala uma segunda cópia independente) — use deploy upgrade em vez disso se a intenção for mover a implantação existente para uma nova versão.
• --name existe, vinculado a um --package-name diferente. Falha imediatamente — um nome de implantação não pode alternar pacotes por meio de deploy run.
• Uma implantação de --name já está em progresso. Falha — a operação anterior deve ser concluída primeiro.

---

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

Atualize uma implantação existente para uma versão de pacote mais recente no local — o equivalente em CLI do botão "Atualizar" da interface gráfica do Orchestrator. Use isso quando deploy run estiver bloqueado porque uma implantação já existe no nome do destino. A configuração existente da implantação é preservada, portanto, os valores já definidos nela (por exemplo, o segredo de um ativo de credencial) não são redefinidos para os padrões do pacote. Aguarda a atualização ser concluída, a menos que --no-wait seja aprovado.

Argumentos

• <deployment-key> (necessário) — Chave da implantação a ser atualizada. Use deploy list para encontrá-lo (o campo Key ).

Opções

Long	Valor	Padrão	Description
--version <version>	text	mais recente disponível	Versão do pacote de destino. Apenas a versão mais recente publicada é compatível hoje.
--personal-workspace	Bandeira	desativada	Atualize uma implantação no feed do seu Espaço de trabalho pessoal em vez do tenant.
--no-wait	Bandeira	desativada	Retorne assim que a atualização for aceita, em vez de esperar que ela seja finalizada.
--timeout <seconds>	segundos	300	Segundos para esperar até que a atualização seja concluída.
--poll-interval <ms>	ms	5000	Milissegundos entre pesquisas de status.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001

# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait

Formato dos dados (--output json)

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Successful",
    "DeploymentName": "billing-solution",
    "FromVersion": "1.0.0",
    "ToVersion": "2.0.0",
    "VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

Com --no-wait, Status é "Draft" e a atualização só foi aceita, não concluída — pesquise deploy list (os campos Actions/TargetPackageVersion ) para rastreá-la.

---

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

• --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, versão do pacote atual/de destino, operação pendente, status de ativação e caminho da pasta.

Opções

Long	Valor	Padrão	Description
--folder-path <path>	Path	—	Filtra por caminho da pasta pai. A filtragem é aplicada após a busca; --limit se os resultados parecerem incompletos ao usar esse filtro.
--folder-key <key>	GUID	—	Filtra por chave de pasta pai. Alternativa --folder-path para.
-l, --limit <number>	Número	50	Máx. de implantações a ser buscada.
--offset <number>	Número	0	Número de implantações a ignorar (aplicado antes da filtragem --folder-path/--folder-key).
--sort-by <column>	text	startTime	Coluna usada para classificar.
--sort-order <direction>	Ascending | Descending	Descending	Classificar direção.
--operation-status <statuses>	separados por vírgula	—	Filtra no lado do servidor por status de operação (por exemplo, Successful, InProgress, Failed).
--activation-status <statuses>	separados por vírgula	—	Filtra o lado do servidor por status de ativação (por exemplo, Active, Inactive).
--personal-workspace	Bandeira	desativada	Lista apenas implantações do feed do Espaço de Trabalho Pessoal do usuário atual. mutuamente exclusivo com --feed.
--feed <name-or-key>	text	—	Lista apenas implantações deste feed. mutuamente exclusivo com --personal-workspace.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Ambos --operation-status e --activation-status rejeitam valores fora das listas de status conhecidos do SDK — a mensagem de erro enumera os valores válidos.

Exemplos

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

# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress

Formato dos dados (--output json)

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000002",
      "InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
      "Name": "billing-solution",
      "PackageName": "billing-solution",
      "PackageVersion": "1.0.0",
      "CurrentPackageVersion": "1.0.0",
      "TargetPackageVersion": "2.0.0",
      "NewPackageVersionAvailable": "2.0.0",
      "Operation": "VersionChange",
      "OperationStatus": "InProgress",
      "ActivationStatus": "Active",
      "FolderPath": "Shared/Billing",
      "FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
      "CreatedAt": "2026-04-15T10:30:00Z",
      "Actions": ["Upgrade"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}

Key é o valor que deploy upgrade espera como <deployment-key>. NewPackageVersionAvailable não é nulo quando existe uma versão publicada mais recente do que a implantada atualmente. Actions lista as operações atualmente disponíveis na implantação (por exemplo, ["Upgrade"]).

---

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

• --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), InstanceId será omitido e o comando retornará 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. Esta é uma operação permanente — não há desfazer.

Argumentos

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

Opções

• -y, --yes — Obrigatório. Confirma esta operação irreversível — a CLI nunca solicita.
• --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 --yes

Formato dos dados (--output json)

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

Três formas de sucesso são possíveis, distintas pela qual os campos aparecem:

• Imediato — o Orchestrator relata complete: true na primeira chamada; nenhuma pesquisa acontece. Apenas Status/DeploymentName é exibido.
• Agendado — o Orchestrator agenda o trabalho sem retornar um ID de instância; um campo Scheduled é adicionado.
• Pesquisado — um InstanceId é retornado e o comando o pesquisa até a conclusão, conforme mostrado acima.

Modos de falha

• Não há -y, --yes. O comando recusa sem confirmar.

---

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

Long	Valor	Padrão	Description
--package-version <version>	text	Mais recente	Versão do pacote.
-d, --destination <path>	Path	Saída std	Grave a configuração nesse arquivo em vez do stdout.
--format <format>	json | yaml	json	Formato da configuração.
--login-validity <minutes>	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplo

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

# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml

Formato dos dados (--output json)

Quando -d é fornecido:

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

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

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "State": "Ready",
    "Format": "json",
    "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.

---

Comandos relacionados

• uip solution publish — etapa obrigatória antes de deploy run.
• uip solution packages list — descubra nomes e versões de pacotes.
• uip or — 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.