Citrix Virtual Apps and Desktops

SDKs e APIs

January 3, 2024

Contribuição de:

Vários SDKs e APIs estão disponíveis nesta versão. Para acessar os SDKs e as APIs, acesse Build anything with Citrix. Selecione Citrix Workspace para acessar as informações de programação do Citrix Virtual Apps and Desktops e seus componentes relacionados.

Nota:

O Citrix Virtual Apps and Desktops SDK e o Citrix Group Policy SDK podem ser instalados como um módulo ou um snap-in. Vários componentes SDK (como Citrix Licensing, Citrix Provisioning e StoreFront) são instalados usando apenas um snap-in.

Este produto oferece suporte ao PowerShell versões 3 a 5.

Citrix Virtual Apps and Desktops SDK

Esse SDK é instalado automaticamente como um módulo do PowerShell quando você instala um Delivery Controller ou Studio. Isso permite que você use os cmdlets desse SDK sem precisar adicionar snap-ins. (As instruções são fornecidas abaixo se você optar por instalar este SDK como um snap-in.)

Permissions

Você deve executar o shell ou script usando uma identidade que tenha direitos de administração 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, a Citrix recomenda que, para a operação normal, você crie administradores 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 Launch 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 da versão 1. O Citrix Virtual Apps and Desktops e snap-ins anteriores à versão XenDesktop 7 são da 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 desse SDK, selecione o produto ou componente na lista Categories e selecione Citrix Virtual Apps and Desktops SDK.
Para obter orientação sobre o PowerShell, consulte Windows PowerShell Integrated Scripting Environment (ISE).

Group Policy SDK

O Citrix Group Policy SDK permite exibir e configurar os filtros e as configurações da política de grupo. Esse SDK usa um provedor do PowerShell para criar uma unidade virtual que corresponde a configurações e filtros de máquina e usuário. O provedor aparece como uma extensão a New-PSDrive.

Para usar o Group Policy SDK, o Studio ou o Citrix Virtual Apps and Desktops SDK devem estar instalados.

O provedor do Citrix Group Policy PowerShell está disponível como um módulo ou um snap-in.

Para usar o módulo, não é necessário nenhum trabalho adicional.
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 cadeia de caracteres Controller é o nome de domínio totalmente qualificado de um Controller no site ao qual você deseja se conectar e do qual deseja carregar 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 estã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.

Monitor Service OData

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

Para obter mais informações, consulte Monitor Service OData API.

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.

SDKs e APIs

January 3, 2024

Contribuição de:

January 3, 2024

Contribuição de:

Neste artigo

Citrix Virtual Apps and Desktops SDK
Group Policy SDK
APIs REST do Citrix Virtual Apps and Desktops
Monitor Service OData