Citrix Virtual Apps and Desktops

SDKs e APIs

January 23, 2026

Contribuição de:

Vários SDKs e APIs estão disponíveis nesta versão. Para acessar os SDKs e APIs, acesse Crie qualquer coisa com Citrix. A partir daí, selecione Citrix Workspace para acessar informações de programação para o Citrix Virtual Apps and Desktops e seus componentes relacionados.

Observação:

O SDK do Citrix Virtual Apps and Desktops™ e o SDK da Política de Grupo do Citrix podem ser instalados como um módulo ou um snap-in. Vários SDKs de componentes (como Citrix Licensing, Citrix Provisioning e StoreFront) são instalados usando apenas um snap-in.

Este produto oferece suporte às versões 3 a 5 do PowerShell.

SDK do Citrix Virtual Apps and Desktops

Este SDK é instalado automaticamente como um módulo do PowerShell ao instalar um Delivery Controller™ ou o Studio. Isso permite que você use os cmdlets deste SDK sem precisar adicionar snap-ins. (As instruções são fornecidas abaixo, caso você opte por instalar este SDK como um snap-in.)

Permissões

Você deve executar o shell ou script usando uma identidade que tenha direitos de administração do Citrix. Embora os membros do grupo de administradores locais no Controller tenham automaticamente privilégios administrativos completos para permitir a instalação do Citrix Virtual Apps ou Citrix Virtual Desktops™, o Citrix recomenda que, para operação normal, você crie administradores do Citrix com os direitos apropriados, em vez de usar a conta de administradores locais.

Acessar e executar os cmdlets

Inicie um shell no PowerShell: Abra o Studio, selecione a guia PowerShell e clique em Iniciar PowerShell.
Para usar cmdlets do SDK em scripts, defina a política de execução no PowerShell. Para obter informações sobre a política de execução do PowerShell, consulte a documentação da Microsoft.
Se você quiser usar o snap-in (em vez do módulo), adicione o snap-in usando o cmdlet Add-PSSnapin (ou asnp).

V1 e V2 indicam a versão do snap-in. Os snap-ins do XenDesktop 5 são a versão 1. O Citrix Virtual Apps and Desktops e os snap-ins de versões anteriores do XenDesktop 7 são a versão 2. Por exemplo, para instalar o snap-in do Citrix Virtual Apps and Desktops, digite Add-PSSnapin Citrix.ADIdentity.Admin.V2. Para importar todos os cmdlets, digite: Add-PSSnapin Citrix.*.Admin.V*

Agora você pode usar os cmdlets e os arquivos de ajuda.

Para acessar os arquivos de ajuda para este SDK, selecione o produto ou componente na lista Categorias e, em seguida, selecione Citrix Virtual Apps and Desktops SDK.
Para obter orientação sobre o PowerShell, consulte Windows PowerShell Integrated Scripting Environment (ISE).

SDK da Política de Grupo

O SDK da Política de Grupo do Citrix permite exibir e configurar as configurações e filtros da Política de Grupo. Este SDK usa um provedor do PowerShell para criar uma unidade virtual que corresponde às configurações e filtros da máquina e do usuário. O provedor aparece como uma extensão para New-PSDrive.

Para usar o SDK da Política de Grupo, o Studio ou o SDK do Citrix Virtual Apps and Desktops deve estar instalado.

O provedor do PowerShell da Política de Grupo do Citrix está disponível como um módulo ou um snap-in.

Para usar o módulo, nenhum trabalho adicional é necessário.
Para adicionar o snap-in, digite Add-PSSnapin citrix.common.grouppolicy.

Para acessar a ajuda, digite: help New-PSDrive -path localgpo:/.

Para criar uma unidade virtual e carregá-la com configurações, digite New-PSDrive <Standard Parameters> [-PSProvider] CitrixGroupPolicy -Controller <string>, onde a string do Controller é o nome de domínio totalmente qualificado de um Controller no site ao qual você deseja se conectar e carregar as configurações.

APIs REST do Citrix Virtual Apps and Desktops

Com as APIs REST do Citrix Virtual Apps and Desktops, você pode automatizar o gerenciamento de recursos em uma implantação do Citrix Virtual Apps and Desktops.

As APIs REST do Citrix Virtual Apps and Desktops estão disponíveis em https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/docs/citrix-virtual-apps-and-desktops-apis. As APIs não aplicáveis ao Citrix Virtual Apps and Desktops são marcadas de acordo. Siga as orientações fornecidas para configurar o acesso ao serviço de API e usar as APIs para gerenciar e otimizar seus recursos.

OData do Serviço de Monitoramento

A API Monitor permite o acesso aos dados do Serviço de Monitoramento usando a Versão 3 ou 4 da API OData. Você pode criar painéis de monitoramento e relatórios personalizados com base nos dados consultados do Serviço de Monitoramento. O OData V.4 é baseado na ASP.NET Web API e oferece suporte a consultas de agregação.

Para obter mais informações, consulte a API OData do Serviço de Monitoramento.

A versão oficial deste conteúdo está em inglês. Parte do conteúdo da documentação da Cloud Software Group é traduzida automaticamente para sua conveniência. A Cloud Software Group não tem controle sobre o conteúdo traduzido automaticamente, que pode conter erros, imprecisões ou linguagem inadequada. Nenhuma garantia de qualquer tipo, expressa ou implícita, é fornecida quanto à precisão, confiabilidade, adequação ou correção de quaisquer traduções feitas do original em inglês para qualquer outro idioma, ou quanto à conformidade do seu produto ou serviço Cloud Software Group com qualquer conteúdo traduzido automaticamente, e nenhuma garantia fornecida sob o contrato de licença de usuário final aplicável ou os termos de serviço, ou qualquer outro contrato com a Cloud Software Group, de que o produto ou serviço esteja em conformidade com qualquer documentação será aplicável na medida em que essa documentação tenha sido traduzida automaticamente. A Cloud Software Group não se responsabiliza por quaisquer danos ou problemas que possam surgir em decorrência do uso de conteúdo traduzido automaticamente.

Isso foi útil?

SDKs e APIs

January 23, 2026

Contribuição de:

January 23, 2026

Contribuição de:

Neste artigo

SDK do Citrix Virtual Apps and Desktops
SDK da Política de Grupo
APIs REST do Citrix Virtual Apps and Desktops
OData do Serviço de Monitoramento

Isso foi útil?