citrixorchestration

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for citrixorchestration

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: devportal-onprem-ga
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import citrixorchestration "github.com/citrix/citrix-daas-rest-go/citrixorchestration"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), citrixorchestration.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), citrixorchestration.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), citrixorchestration.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), citrixorchestration.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AboutAPIsDAAS AboutGetAbout Get /About Get About info of this Orchestration instance.
ActionsAPIsDAAS ActionsCancelAction Post /machineCatalogs/{catalogNameOrId}/actions/{actionId}/$Cancel Cancel the specified machine catalog and specified action.
ActionsAPIsDAAS ActionsDeleteAction Delete /machineCatalogs/{catalogNameOrId}/actions Delete specified catalog actions.
ActionsAPIsDAAS ActionsDeleteActions Delete /machineCatalogActions Delete all completed machine catalog actions.
ActionsAPIsDAAS ActionsGetAction Get /machineCatalogs/{catalogNameOrId}/actions Get machine catalog actions by specified catalog name or id and action Id.
ActionsAPIsDAAS ActionsGetActionById Get /machineCatalogs/{catalogNameOrId}/actions/{actionId} Get specified machine catalog specified action.
ActionsAPIsDAAS ActionsGetActions Get /machineCatalogActions Get all machine catalog actions.
AdminAPIsDAAS AdminCheckRoleNameExists Head /Admin/Roles/{name} Check for the existence of role by name.
AdminAPIsDAAS AdminCheckScopeNameExists Head /Admin/Scopes/{name} Check for the existence of scope by name.
AdminAPIsDAAS AdminCreateAdminAdministrator Post /Admin/Administrators Create a new administrator.
AdminAPIsDAAS AdminCreateAdminRole Post /Admin/Roles Create a new admin role.
AdminAPIsDAAS AdminCreateAdminScope Post /Admin/Scopes Create a new admin scope.
AdminAPIsDAAS AdminDeleteAdminAdministrator Delete /Admin/Administrators/{nameOrId} Delete an administrator.
AdminAPIsDAAS AdminDeleteAdminRole Delete /Admin/Roles/{nameOrId} Delete an admin role.
AdminAPIsDAAS AdminDeleteAdminScope Delete /Admin/Scopes/{nameOrId} Delete an admin scope.
AdminAPIsDAAS AdminGetAdminAdministrator Get /Admin/Administrators/{nameOrId} Get a single administrator
AdminAPIsDAAS AdminGetAdminAdministrators Get /Admin/Administrators Get administrators.
AdminAPIsDAAS AdminGetAdminEffectiveRights Get /Admin/EffectiveRights Get the effective rights of the current user. This is the union of all rights of the enabled administrators that the current user matches, taking into account group membership.
AdminAPIsDAAS AdminGetAdminRole Get /Admin/Roles/{nameOrId} Get details about a single admin role.
AdminAPIsDAAS AdminGetAdminRoles Get /Admin/Roles Get admin roles.
AdminAPIsDAAS AdminGetAdminScope Get /Admin/Scopes/{nameOrId} Get details about a single admin scope.
AdminAPIsDAAS AdminGetAdminScopedObjects Get /Admin/Scopes/{nameOrId}/ScopedObjects Get the objects in an admin scope.
AdminAPIsDAAS AdminGetAdminScopes Get /Admin/Scopes Get admin scopes.
AdminAPIsDAAS AdminGetAdministratorNamePreview Get /Admin/Administrators/{name}/NamePreview Get preview report of the administrator user name.
AdminAPIsDAAS AdminGetAdministratorReport Get /Admin/Administrators/{nameOrId}/Report Get report of the administrator.
AdminAPIsDAAS AdminGetDeleteAdministratorConsequence Get /Admin/Administrators/{nameOrId}/PreviewDeleteConsequence Preview the consequence of deleting an administrator.
AdminAPIsDAAS AdminGetPredefinedPermissionGroups Get /Admin/PermissionGroups Get all permission groups.
AdminAPIsDAAS AdminGetPredefinedPermissions Get /Admin/Permissions Get all predefined permissions.
AdminAPIsDAAS AdminGetPredefinedPermissionsForGroups Get /Admin/PermissionGroups/{id}/Permissions Get all permissions for a permission group.
AdminAPIsDAAS AdminPreviewAdministratorReport Post /Admin/Administrators/$PreviewReport Get preview report of the administrator.
AdminAPIsDAAS AdminUpdateAdminAdministrator Patch /Admin/Administrators/{nameOrId} Update an administrator.
AdminAPIsDAAS AdminUpdateAdminRole Patch /Admin/Roles/{nameOrId} Update an admin role.
AdminAPIsDAAS AdminUpdateAdminScope Patch /Admin/Scopes/{nameOrId} Update an admin scope.
AdminFoldersAPIsDAAS AdminFoldersCreateAdminFolder Post /AdminFolders Create an admin folder
AdminFoldersAPIsDAAS AdminFoldersDeleteAdminFolder Delete /AdminFolders/{pathOrId} Delete an admin folder.
AdminFoldersAPIsDAAS AdminFoldersGetAdminFolder Get /AdminFolders/{pathOrId} Get details about a single admin folder.
AdminFoldersAPIsDAAS AdminFoldersGetAdminFolderApplications Get /AdminFolders/{pathOrId}/Applications Get the applications in an admin folder.
AdminFoldersAPIsDAAS AdminFoldersGetAdminFolderMachineCatalogs Get /AdminFolders/{pathOrId}/MachineCatalogs Get the machineCatalogs in an admin folder.
AdminFoldersAPIsDAAS AdminFoldersGetAdminFolders Get /AdminFolders Get admin folders.
AdminFoldersAPIsDAAS AdminFoldersUpdateAdminFolder Patch /AdminFolders/{pathOrId} Update an admin folder.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryCreateAppLibPackageDiscovery Post /AppLibPackageDiscovery/Sessions Create AppLib Package Discovery session
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryCreateAppLibPackageDiscoveryProfile Post /AppLibPackageDiscovery/Profiles Create an AppLib Package Discovery profile.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryGetAppLibPackageDiscovery Get /AppLibPackageDiscovery/Sessions/{id} Get details of an AppLib Package Discovery session.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryGetAppLibPackageDiscoveryLatestSessionByProfileId Get /AppLibPackageDiscovery/Profiles/{uid}/LatestSession Get the latest AppLib Package Discovery session for the specified profile id.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryGetAppLibPackageDiscoveryProfile Get /AppLibPackageDiscovery/Profiles/{uid} Get details of an AppLib Package Discovery profile.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryGetAppLibPackageDiscoveryProfiles Get /AppLibPackageDiscovery/Profiles Get a list of AppLib Package Discovery profiles.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryGetAppLibPackageDiscoverySessions Get /AppLibPackageDiscovery/Sessions Get a list of AppLib Package Discovery sessions.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryRemoveAppLibPackageDiscoveryProfile Delete /AppLibPackageDiscovery/Profiles/{uid} Remove an AppLib Package Discovery profile.
AppLibPackageDiscoveryAPIsDAAS AppLibPackageDiscoveryUpdateAppLibPackageDiscoveryProfile Patch /AppLibPackageDiscovery/Profiles/{uid} Update the specified AppLib Package Discovery profile.
AppVIsolationGroupsAPIsDAAS AppVIsolationGroupsCreateAppVIsolationGroup Post /AppVIsolationGroups Create an App-V IsolationGroup in the site
AppVIsolationGroupsAPIsDAAS AppVIsolationGroupsDeleteAppVIsolationGroup Delete /AppVIsolationGroups/{nameOrId} Delete an App-V IsolationGroup configured in the site.
AppVIsolationGroupsAPIsDAAS AppVIsolationGroupsGetAppVIsolationGroup Get /AppVIsolationGroups/{nameOrId} Get the specified App-V IsolationGroups configured in the site
AppVIsolationGroupsAPIsDAAS AppVIsolationGroupsGetAppVIsolationGroups Get /AppVIsolationGroups Get the App-V IsolationGroups configured in the site
AppVIsolationGroupsAPIsDAAS AppVIsolationGroupsUpdateAppVIsolationGroup Patch /AppVIsolationGroups/{nameOrId} Update the App-V IsolationGroup configured in the site.
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackage Get /AppVPackages/{id} Get the details for a single App-V package within the site
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageApplication Get /AppVPackages/{id}/Applications/{appId} Get details for a single App-V application within an App-V package
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageApplicationIcon Get /AppVPackages/{id}/Applications/{appId}/Icon Get the icon for a single App-V application within an App-V package within the site.
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageApplications Get /AppVPackages/{id}/Applications Get App-V applications within an App-V package
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageBrokerApplications Get /AppVPackages/{id}/BrokerApplications Get Broker applications delivered from the App-V package
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageDeliveryGroups Get /AppVPackages/{id}/DeliveryGroups Get delivery groups which contain applications in the App-V package
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackageIcon Get /AppVPackages/{id}/Icon Get the icon for a single App-V package within the site
AppVPackagesAPIsDAAS AppVPackagesGetAppVPackages Get /AppVPackages Get the App-V packages configured in the site
AppVPackagesAPIsDAAS AppVPackagesImportAppVPackages Post /AppVPackages Import App-V packages to the site
AppVPackagesAPIsDAAS AppVPackagesRemoveAppVPackage Delete /AppVPackages/{id} Remove a single App-V package within the site
AppVServersAPIsDAAS AppVServersGetAppVServerPackage Get /AppVServers/{server}/Packages/{id} Get the details for a single App-V package on a server.
AppVServersAPIsDAAS AppVServersGetAppVServerPackageApplication Get /AppVServers/{server}/Packages/{id}/Applications/{appId} Get details for a single App-V application on a server.
AppVServersAPIsDAAS AppVServersGetAppVServerPackageApplicationIcon Get /AppVServers/{server}/Packages/{id}/Applications/{appId}/Icon Get the icon for a App-V application
AppVServersAPIsDAAS AppVServersGetAppVServerPackageApplications Get /AppVServers/{server}/Packages/{id}/Applications Get App-V applications within an App-V package on a server.
AppVServersAPIsDAAS AppVServersGetAppVServerPackageIcon Get /AppVServers/{server}/Packages/{id}/Icon Get the icon for a single App-V package on a server.
AppVServersAPIsDAAS AppVServersGetAppVServerPackages Get /AppVServers/{server}/Packages Get the packages from a single App-V server
AppVServersAPIsDAAS AppVServersGetAppVServers Get /AppVServers Get all App-V servers configured in the site
ApplicationFoldersAPIsDAAS ApplicationFoldersCheckApplicationFolderPathExists Head /ApplicationFolders/{path} Check for the existence of an application folder by path.
ApplicationFoldersAPIsDAAS ApplicationFoldersCreateApplicationFolder Post /ApplicationFolders Create an application folder
ApplicationFoldersAPIsDAAS ApplicationFoldersDeleteApplicationFolder Delete /ApplicationFolders/{pathOrId} Delete an application folder.
ApplicationFoldersAPIsDAAS ApplicationFoldersGetApplicationFolder Get /ApplicationFolders/{pathOrId} Get details about a single application folder.
ApplicationFoldersAPIsDAAS ApplicationFoldersGetApplicationFolderApplications Get /ApplicationFolders/{pathOrId}/Applications Get the applications in an application folder.
ApplicationFoldersAPIsDAAS ApplicationFoldersGetApplicationFolders Get /ApplicationFolders Get application folders.
ApplicationFoldersAPIsDAAS ApplicationFoldersUpdateApplicationFolder Patch /ApplicationFolders/{pathOrId} Update an application folder.
ApplicationGroupsAPIsDAAS ApplicationGroupsAddApplicationGroupTag Post /ApplicationGroups/{nameOrId}/Tags/{tagNameOrId} Add a tag to an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsAddApplications Post /ApplicationGroups/{nameOrId}/Applications Add applications to the application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsCheckApplicationGroupExists Head /ApplicationGroups/{name} Check for the existence of an application group by name.
ApplicationGroupsAPIsDAAS ApplicationGroupsCreateApplicationGroup Post /ApplicationGroups Create an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsDeleteApplicationGroup Delete /ApplicationGroups/{nameOrId} Delete an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsDoApplicationGroupSearch Post /ApplicationGroups/$search Perform an advanced search for application groups.
ApplicationGroupsAPIsDAAS ApplicationGroupsGetApplicationGroup Get /ApplicationGroups/{nameOrId} Get details of a single application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsGetApplicationGroupApplications Get /ApplicationGroups/{nameOrId}/Applications Get applications in an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsGetApplicationGroupDeliveryGroups Get /ApplicationGroups/{nameOrId}/DeliveryGroups Get delivery groups for an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsGetApplicationGroupTags Get /ApplicationGroups/{nameOrId}/Tags Get the tags for an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsGetApplicationGroups Get /ApplicationGroups Get application groups.
ApplicationGroupsAPIsDAAS ApplicationGroupsRemoveApplication Delete /ApplicationGroups/{nameOrId}/Applications/{appNameOrId} Remove an application from the application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsRemoveApplicationGroupTag Delete /ApplicationGroups/{nameOrId}/Tags/{tagNameOrId} Remove a tag from an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsSetApplicationGroupTags Put /ApplicationGroups/{nameOrId}/Tags Set the tags for an application group.
ApplicationGroupsAPIsDAAS ApplicationGroupsTestApplicationGroupExists Post /ApplicationGroups/$checkNameExists Test the existence of an application group by name.
ApplicationGroupsAPIsDAAS ApplicationGroupsUpdateApplicationGroup Patch /ApplicationGroups/{nameOrId} Update an application group.
ApplicationsAPIsDAAS ApplicationsAddApplicationTags Post /Applications/{nameOrId}/Tags/{tagNameOrId} Add a tag to an application.
ApplicationsAPIsDAAS ApplicationsAddApplications Post /Applications Add applications to the site.
ApplicationsAPIsDAAS ApplicationsCheckApplicationExists Head /Applications/{name} Check for the existence of an application by name
ApplicationsAPIsDAAS ApplicationsDeleteApplication Delete /Applications/{nameOrId} Delete an application!
ApplicationsAPIsDAAS ApplicationsDisableApplicationFta Delete /Applications/{nameOrId}/FileTypes/{extensionName} Disable a file-type association for an application.
ApplicationsAPIsDAAS ApplicationsDoApplicationSearch Post /Applications/$search Perform an advanced search for applications.
ApplicationsAPIsDAAS ApplicationsDuplicateApplication Post /Applications/{nameOrId}/$duplicate Duplicate an application.
ApplicationsAPIsDAAS ApplicationsEnableApplicationFta Post /Applications/{nameOrId}/FileTypes Enable a file-type association for an application.
ApplicationsAPIsDAAS ApplicationsGetApplication Get /Applications/{nameOrId} Get details of a single application.
ApplicationsAPIsDAAS ApplicationsGetApplicationAdministrators Get /Applications/{nameOrId}/Administrators Get administrators authorized to administer an application.
ApplicationsAPIsDAAS ApplicationsGetApplicationApplicationGroups Get /Applications/{nameOrId}/ApplicationGroups Get application groups associated with an application.
ApplicationsAPIsDAAS ApplicationsGetApplicationDeliveryGroups Get /Applications/{nameOrId}/DeliveryGroups Get delivery groups associated with an application.
ApplicationsAPIsDAAS ApplicationsGetApplicationFta Get /Applications/{nameOrId}/FileTypes/{extensionName} Get a single file-type for an application.
ApplicationsAPIsDAAS ApplicationsGetApplicationFtas Get /Applications/{nameOrId}/FileTypes Get all file-types for an application.
ApplicationsAPIsDAAS ApplicationsGetApplicationRecommendName Get /Applications/{nameOrId}/RecommendName Get an application's recommend name.
ApplicationsAPIsDAAS ApplicationsGetApplicationSessions Get /Applications/{nameOrId}/Sessions Get sessions in which the application is currently running.
ApplicationsAPIsDAAS ApplicationsGetApplicationTags Get /Applications/{nameOrId}/Tags Get tags associated with an application.
ApplicationsAPIsDAAS ApplicationsGetApplications Get /Applications Get all applications.
ApplicationsAPIsDAAS ApplicationsImportFileTypes Post /Applications/{nameOrId}/FileTypes/$import Import file types for the application.
ApplicationsAPIsDAAS ApplicationsPatchApplication Patch /Applications/{nameOrId} Modify an application.
ApplicationsAPIsDAAS ApplicationsRefreshAppVApplications Get /Applications/RefreshAppVApplications Refresh the AppV Applications.
ApplicationsAPIsDAAS ApplicationsRemoveApplicationTags Delete /Applications/{nameOrId}/Tags/{tagNameOrId} Remove a tag from an application.
ApplicationsAPIsDAAS ApplicationsSearchStartMenuApplications Post /Applications/StartMenuApplications Search Start Menu Applications.
ApplicationsAPIsDAAS ApplicationsSetApplicationTags Put /Applications/{nameOrId}/Tags Set tags associated with an application.
BatchAPIsDAAS BatchDoBatchRequest Post /$batch Perform a batch request.
ConfigLogAPIsDAAS ConfigLogDeleteLogs Delete /ConfigLog/Logs Delete logging event logs. This on-prem only API.
ConfigLogAPIsDAAS ConfigLogDoConfigLogSearch Post /ConfigLog/Operations/$search Perform an advanced search for configuration log entries.
ConfigLogAPIsDAAS ConfigLogExportReportData Post /ConfigLog/ExportReport Export logging report data in the format of csv/html/both.
ConfigLogAPIsDAAS ConfigLogFetchExistingOperationLabels Post /ConfigLog/Operations/$fetchExistingLabels Fetch existing high level log operation labels.
ConfigLogAPIsDAAS ConfigLogGetFirstLogDate Get /ConfigLog/GetFirstLogDate Get first log date
ConfigLogAPIsDAAS ConfigLogGetLogSite Get /ConfigLog/LoggingSite Get logging site details. This on-prem only API.
ConfigLogAPIsDAAS ConfigLogGetLowLevelOperations Get /ConfigLog/Operations/{id}/LowLevelOperations Get the detailed low level operations of a high level operation.
ConfigLogAPIsDAAS ConfigLogGetOperation Get /ConfigLog/Operations/{id} Get a high level log operation.
ConfigLogAPIsDAAS ConfigLogGetOperations Get /ConfigLog/Operations Get configuration log operations.
ConfigLogAPIsDAAS ConfigLogPatchOperation Patch /ConfigLog/Operations/{id} Update a high level log operation.
ConfigLogAPIsDAAS ConfigLogSetLogSite Patch /ConfigLog/LoggingSite Update logging site info. This on-prem only API.
DeliveryGroupsAPIsDAAS DeliveryGroupsAddDeliveryGroupMachineCatalog Post /DeliveryGroups/{nameOrId}/MachineCatalogs Associate a machine catalog with a RemotePC delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsAddDeliveryGroupTags Post /DeliveryGroups/{nameOrId}/Tags/{tagNameOrId} Add a tag to a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsCheckDeliveryGroupExists Head /DeliveryGroups/{name} Check for the existence of a delivery group by name.
DeliveryGroupsAPIsDAAS DeliveryGroupsCheckRebootScheduleNameExists Head /DeliveryGroups/{nameOrId}/RebootSchedules/{name} Check for the existence of a reboot schedule by name.
DeliveryGroupsAPIsDAAS DeliveryGroupsCreateDeliveryGroup Post /DeliveryGroups Create a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsCreateDeliveryGroupAdvancedAccessPolicy Post /DeliveryGroups/{nameOrId}/AdvancedAccessPolicies Create an advanced access policy associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsCreateDeliveryGroupPowerTimeScheme Post /DeliveryGroups/{nameOrId}/PowerTimeSchemes Create a power time scheme for a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsCreateDeliveryGroupRebootSchedule Post /DeliveryGroups/{nameOrId}/RebootSchedules Create a reboot schedule for a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDeleteDeliveryGroup Delete /DeliveryGroups/{nameOrId} Delete a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDeleteDeliveryGroupAdvancedAccessPolicy Delete /DeliveryGroups/{nameOrId}/AdvancedAccessPolicies/{policyId} Delete an advanced access policy associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDeleteDeliveryGroupPowerTimeScheme Delete /DeliveryGroups/{nameOrId}/PowerTimeSchemes/{schemeNameOrId} Delete a power time scheme from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDeleteDeliveryGroupRebootSchedule Delete /DeliveryGroups/{nameOrId}/RebootSchedules/{scheduleNameOrId} Delete a reboot schedule from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoAddApplications Post /DeliveryGroups/{nameOrId}/Applications Add applications and/or application groups to a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoAddMachines Post /DeliveryGroups/{nameOrId}/Machines Add machines to a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoDeliveryGroupSearch Post /DeliveryGroups/$search Perform an advanced search for deliveryGroups.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoRemoveApplicationGroups Delete /DeliveryGroups/{nameOrId}/ApplicationGroups/{appGroupNameOrId} Remove an application group from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoRemoveApplications Delete /DeliveryGroups/{nameOrId}/Applications/{appNameOrId} Remove an application from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsDoRemoveMachines Delete /DeliveryGroups/{nameOrId}/Machines/{machineNameOrId} Remove a machine from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeiliveryGroupProjectedAutoscaleMachines Get /DeliveryGroups/{nameOrId}/ProjectedAutoscaleMachines Gets the projected number of machines that Autoscale will keep powered on over the specified period
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroup Get /DeliveryGroups/{nameOrId} Get details of a single delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupAdvancedAccessPolicies Get /DeliveryGroups/{nameOrId}/AdvancedAccessPolicies Get the advanced access policies associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupAdvancedAccessPolicy Get /DeliveryGroups/{nameOrId}/AdvancedAccessPolicies/{policyId} Get the details of a single advanced access policy associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupApplications Get /DeliveryGroups/{nameOrId}/Applications Get the applications associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupMachines Get /DeliveryGroups/{nameOrId}/Machines Get the machines associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupPowerTimeScheme Get /DeliveryGroups/{nameOrId}/PowerTimeSchemes/{schemeNameOrId} Get the details about a single power time scheme associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupPowerTimeSchemes Get /DeliveryGroups/{nameOrId}/PowerTimeSchemes Get the power time schemes associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupRebootSchedule Get /DeliveryGroups/{nameOrId}/RebootSchedules/{scheduleNameOrId} Get the details about a single reboot schedule associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupRebootSchedules Get /DeliveryGroups/{nameOrId}/RebootSchedules Get the reboot schedules associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupStartMenuApplications Get /DeliveryGroups/{nameOrId}/StartMenuApplications Get the start menu applications from a machine in the delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupTags Get /DeliveryGroups/{nameOrId}/Tags Get tags associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupTestReport Get /DeliveryGroups/{nameOrId}/TestReport Get the most recent test report of a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroups Get /DeliveryGroups Get all delivery groups.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsAdministrators Get /DeliveryGroups/{nameOrId}/Administrators Get administrators who can administer a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsApplicationGroups Get /DeliveryGroups/{nameOrId}/ApplicationGroups Get the application groups associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsDesktops Get /DeliveryGroups/{nameOrId}/Desktops Get the published desktops associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsMachineCatalogDetails Get /DeliveryGroups/{nameOrId}/MachineCatalogs/{id} Get the details of machine catalog associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsMachineCatalogs Get /DeliveryGroups/{nameOrId}/MachineCatalogs Get machine catalogs associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsGetDeliveryGroupsUsage Get /DeliveryGroups/{nameOrId}/Usage Get usage data about a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsPatchDeliveryGroup Patch /DeliveryGroups/{nameOrId} Modify a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsPatchDeliveryGroupAdvancedAccessPolicy Patch /DeliveryGroups/{nameOrId}/AdvancedAccessPolicies/{policyId} Update an advanced access policy associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsPatchDeliveryGroupPowerTimeScheme Patch /DeliveryGroups/{nameOrId}/PowerTimeSchemes/{schemeNameOrId} Update a power time scheme for a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsPatchDeliveryGroupRebootSchedule Patch /DeliveryGroups/{nameOrId}/RebootSchedules/{scheduleNameOrId} Update a reboot schedule for a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsRemoveDeliveryGroupMachineCatalog Delete /DeliveryGroups/{nameOrId}/MachineCatalogs/{catalogNameOrId} Disassociate a machine catalog from a RemotePC delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsRemoveDeliveryGroupTags Delete /DeliveryGroups/{nameOrId}/Tags/{tagNameOrId} Remove a tag from a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsSetDeliveryGroupTags Put /DeliveryGroups/{nameOrId}/Tags Set tags associated with a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsStartDeliveryGroupRebootCycle Post /DeliveryGroups/{nameOrId}/$StartRebootCycle Start a reboot cycle for machines in a delivery group.
DeliveryGroupsAPIsDAAS DeliveryGroupsTestDeliveryGroup Post /DeliveryGroups/{nameOrId}/$test Run tests on a delivery group and create a test report.
DeliveryGroupsAPIsDAAS DeliveryGroupsTestDeliveryGroupExists Post /DeliveryGroups/$checkName Test the existence of a delivery group by name.
GpoDAAS GpoComparePolicies Post /gpo/comparePolicies Compare policies. The policies can be from different policy sets.
GpoDAAS GpoCopyGpoPolicies Post /gpo/policies/$copy Copy some policies of a policy set to other policy sets.
GpoDAAS GpoCopyGpoPolicySet Post /gpo/policySets/{policySetGuid} Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies.
GpoDAAS GpoCreateGpoFilter Post /gpo/filters Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates.
GpoDAAS GpoCreateGpoPolicy Post /gpo/policies Create a new policy. Policies cannot be created in the policy set of type SiteTemplates.
GpoDAAS GpoCreateGpoPolicySet Post /gpo/policySets Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created.
GpoDAAS GpoCreateGpoSetting Post /gpo/settings Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates.
GpoDAAS GpoDeleteGpoFilter Delete /gpo/filters/{filterGuid} Delete an existing filter.
GpoDAAS GpoDeleteGpoPolicy Delete /gpo/policies/{policyGuid} Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted.
GpoDAAS GpoDeleteGpoPolicySet Delete /gpo/policySets/{policySetGuid} Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted.
GpoDAAS GpoDeleteGpoSetting Delete /gpo/settings/{settingGuid} Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted.
GpoDAAS GpoDisableGpoPolicies Post /gpo/policies/$disable Disable some policies of a policy set.
GpoDAAS GpoEnableGpoPolicies Post /gpo/policies/$enable Enable some policies of a policy set.
GpoDAAS GpoGetFilterDefinitions Get /gpo/filterDefinitions Get all filter definitions.
GpoDAAS GpoGetSettingDefinitions Get /gpo/settingDefinitions Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved.
GpoDAAS GpoGetSettingFullDetail Get /gpo/settingFullDetail Get full detail of a setting definition.
GpoDAAS GpoMoveGpoPolicies Post /gpo/policies/$move Move some policies of a policy set to another policy set.
GpoDAAS GpoRankGpoPolicies Post /gpo/policyPriorities Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed.
GpoDAAS GpoReadGpoFilter Get /gpo/filters/{filterGuid} Read a specific filter.
GpoDAAS GpoReadGpoFilters Get /gpo/filters Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters.
GpoDAAS GpoReadGpoPolicies Get /gpo/policies Read all policies defined in a policy set. Policy templates don't have filters.
GpoDAAS GpoReadGpoPolicy Get /gpo/policies/{policyGuid} Read a policy. A policy template doesn't have filters.
GpoDAAS GpoReadGpoPolicySet Get /gpo/policySets/{policySetGuid} Read a GPO policy set.
GpoDAAS GpoReadGpoPolicySets Get /gpo/policySets Get all GPO policy sets in the site.
GpoDAAS GpoReadGpoSetting Get /gpo/settings/{settingGuid} Read a specific setting.
GpoDAAS GpoReadGpoSettings Get /gpo/settings Read settings defined in a policy.
GpoDAAS GpoRemoveGpoPolicies Post /gpo/policies/$remove Remove some policies of a policy set.
GpoDAAS GpoRunSimulation Post /gpo/simulation Simulate policy application.
GpoDAAS GpoSearchFilters Post /gpo/filters/$search Perform an advanced search for GPO filters.
GpoDAAS GpoSearchPolicies Post /gpo/policies/$search Perform an advanced search for GPO policies.
GpoDAAS GpoSearchPolicySets Post /gpo/policySets/$search Perform an advanced search for GPO policy sets.
GpoDAAS GpoSearchSettings Post /gpo/settings/$search Perform an advanced search for GPO settings.
GpoDAAS GpoUpdateGpoFilter Patch /gpo/filters/{filterGuid} Update an existing filter.
GpoDAAS GpoUpdateGpoPolicy Patch /gpo/policies/{policyGuid} Update a policy. Only the policy body is updated.
GpoDAAS GpoUpdateGpoPolicySet Patch /gpo/policySets/{policySetGuid} Update an existing GPO policy set.
GpoDAAS GpoUpdateGpoSetting Patch /gpo/settings/{settingGuid} Update a setting. Settings in the policy set of type SiteTemplates cannot be updated.
GpoDAAS GpoUpdatePolicySetBlob Put /gpo/policySets/{policySetGuid} Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized.
HealthCheckAPIsDAAS HealthCheckHealthCheck Get /HealthCheck The health check endpoint.
HypervisorsAPIsDAAS HypervisorsCheckHypervisorExists Head /hypervisors/{name} Check for the existence of a hypervisor by name.
HypervisorsAPIsDAAS HypervisorsCheckHypervisorResourcePoolExists Head /hypervisors/{nameOrId}/resourcePools/{name} Check for the existence of a resource pool by name.
HypervisorsAPIsDAAS HypervisorsCreateHypervisor Post /hypervisors Create a hypervisor, and optionally a resource pool on the hypervisor.
HypervisorsAPIsDAAS HypervisorsCreateResourcePool Post /hypervisors/{nameOrId}/resourcePools Create a new resource pool on an existing hypervisor.
HypervisorsAPIsDAAS HypervisorsDeleteHypervisor Delete /hypervisors/{nameOrId} Delete a hypervisor and related resource pools.
HypervisorsAPIsDAAS HypervisorsDeleteHypervisorResourcePool Delete /hypervisors/{nameOrId}/resourcePools/{poolId} Delete a hypervisor resource pool.
HypervisorsAPIsDAAS HypervisorsDoHypervisorResourceSearch Post /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search Search the resources within a hypervisor resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisor Get /hypervisors/{nameOrId} Get the details for a single hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorAdministrators Get /hypervisors/{nameOrId}/administrators Get administrators who can administer a hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorAllResources Get /hypervisors/{nameOrId}/allResources Get all resources within a hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorAllResourcesWithoutConnection Post /hypervisors/$GetResources Get all resources within a hypervisor, without creating a persistent connection to the hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorDeletePreview Get /hypervisors/{nameOrId}/deletePreview Get the hypervisor delete preview.
HypervisorsAPIsDAAS HypervisorsGetHypervisorJobs Get /hypervisors/{nameOrId}/jobs Get the currently active jobs that are using a hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorMachineCatalogs Get /hypervisors/{nameOrId}/machineCatalogs Get the machine catalogs that are using a hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorOrphanedResources Get /Hypervisors/{nameOrId}/OrphanedResources Run detect on a hypervisor and retrieve orphaned resources.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePool Get /hypervisors/{nameOrId}/resourcePools/{poolId} Get details about a hypervisor resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolAdministrators Get /hypervisors/{nameOrId}/resourcePools/{poolId}/administrators Get administrators who can administer a resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolDeletePreview Get /hypervisors/{nameOrId}/resourcePools/{poolId}/deletePreview Get the hypervisor resource pool delete preview.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolJobs Get /hypervisors/{nameOrId}/resourcePools/{poolId}/jobs Get the currently active jobs that are using a resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolMachineCatalogs Get /hypervisors/{nameOrId}/resourcePools/{poolId}/machineCatalogs Get the machine catalogs that are using a resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolPatchPreview Post /hypervisors/{nameOrId}/resourcePools/{poolId}/$getPatchPreview Get the hypervisor resource pool patch preview.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolResources Get /hypervisors/{nameOrId}/resourcePools/{poolId}/resources Get the resources within a hypervisor resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePoolTestReport Get /Hypervisors/{nameOrId}/ResourcePools/{poolId}/TestReport Get the most recent test report for a resource pool.
HypervisorsAPIsDAAS HypervisorsGetHypervisorResourcePools Get /hypervisors/{nameOrId}/resourcePools Get the list of hypervisor resource pools.
HypervisorsAPIsDAAS HypervisorsGetHypervisorServerHAAddresses Get /hypervisors/{nameOrId}/serverHAAddresses Get hypervisor server HA addresses. Currently, it only valid for Citrix hypervisors.
HypervisorsAPIsDAAS HypervisorsGetHypervisorTestReport Get /Hypervisors/{nameOrId}/TestReport Get the most recent test report for a hypervisor.
HypervisorsAPIsDAAS HypervisorsGetHypervisorWithoutConnection Post /$GetHypervisor Get a hypervisor details without creating persistent connection.
HypervisorsAPIsDAAS HypervisorsGetHypervisors Get /hypervisors Get the hypervisors.
HypervisorsAPIsDAAS HypervisorsGetHypervisorsAndResourcePools Get /hypervisorsAndResourcePools Get hypervisors and resource pools. This API is used for the hosting main view.
HypervisorsAPIsDAAS HypervisorsGetSupportHypervisors Get /hypervisors/supportedPlugins Get current server support hypervisors.
HypervisorsAPIsDAAS HypervisorsPatchHypervisor Patch /hypervisors/{nameOrId} Update a hypervisor.
HypervisorsAPIsDAAS HypervisorsPatchHypervisorResourcePool Patch /hypervisors/{nameOrId}/resourcePools/{poolId} Update a hypervisor resource pool.
HypervisorsAPIsDAAS HypervisorsPutBrokerHypervisorConnection Put /hypervisors/{nameOrId}/connection Set the properties on a broker hypervisor connection.
HypervisorsAPIsDAAS HypervisorsResetBrokerHypervisorConnection Post /hypervisors/{nameOrId}/$resetConnection Requests the broker hypervisor connection to be reset. The connection is dropped, details including credentials refreshed and the connection reestablished. The reset request is asynchronous and may take a moment to occur.
HypervisorsAPIsDAAS HypervisorsTestHypervisor Post /Hypervisors/{nameOrId}/$test Run tests on a hypervisor and create a test report.
HypervisorsAPIsDAAS HypervisorsTestHypervisorResourcePool Post /Hypervisors/{nameOrId}/ResourcePools/{poolId}/$test Run tests on a resource pool and create a test report.
HypervisorsAPIsDAAS HypervisorsValidateHypervisorResourcePoolResource Post /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$validate Validate a resource for certain usages, currently default and only usage is for Machine Profile.
HypervisorsAPIsDAAS HypervisorsValidateVmPath Post /hypervisors/$ValidateVm Validate a list of hypervisor Vm Path.
IconsAPIsDAAS IconsAddIcon Post /Icons add a customized icon.
IconsAPIsDAAS IconsGetAppVServerPackageApplicationIcon Post /Icons/AppVServerPackageApplication Get the icon for a single App-V application within an App-V package on a server.
IconsAPIsDAAS IconsGetIcon Get /Icons/{id} Get a single icon from the site.
IconsAPIsDAAS IconsGetIcons Get /Icons Get all icons in the site.
IconsAPIsDAAS IconsRemoveIcon Delete /Icons/{id} Remove a customized icon.
JobsAPIsDAAS JobsCancelJob Post /Jobs/{id}/$cancel Cancel a job.
JobsAPIsDAAS JobsDeleteJob Delete /Jobs/{id} Removes the job record.
JobsAPIsDAAS JobsGetJob Get /Jobs/{id} Get the details of a single job.
JobsAPIsDAAS JobsGetJobResults Get /Jobs/{id}/Results Get the results of a job which has completed execution.
JobsAPIsDAAS JobsGetJobs Get /Jobs Get the list of jobs that are currently active, or have recently completed, and were initiated by the caller.
JobsAPIsDAAS JobsSkipRemainingSubtasks Post /Jobs/{id}/$SkipRemaining Skips any remaining / unstarted subtasks of the job.
MachineCatalogsAPIsDAAS MachineCatalogsAddMachineCatalogMachine Post /MachineCatalogs/{nameOrId}/Machines Add machine to the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsAddMachineCatalogMachineAccount Post /MachineCatalogs/{nameOrId}/MachineAccounts Add a machine account to the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsAddMachineCatalogTags Post /MachineCatalogs/{nameOrId}/Tags/{tagNameOrId} Add a tag to a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsCheckMachineCatalogExists Head /MachineCatalogs/{name} Check for the existence of a machine catalog by name.
MachineCatalogsAPIsDAAS MachineCatalogsCheckRemotePCEnrollmentScopeExists Head /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/{name} Check for the existence of a RemotePC enrollment scope by name.
MachineCatalogsAPIsDAAS MachineCatalogsCreateMachineCatalog Post /MachineCatalogs Create a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsCreateMachineCatalogUpgradeSchedule Post /MachineCatalogs/{nameOrId}/UpgradeSchedule Setup a new VDA upgrade schedule for a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsDeleteMachineCatalog Delete /MachineCatalogs/{nameOrId} Delete a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsDoMachineCatalogSearch Post /Machinecatalogs/$search Perform an advanced search for machinecatalogs.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalog Get /MachineCatalogs/{nameOrId} Get details about a single machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogDeliveryGroupAssociations Get /MachineCatalogs/{nameOrId}/DeliveryGroupAssociations Get delivery group associations of a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogEnrollments Get /MachineCatalogs/{nameOrId}/Enrollments Get the list of enrollments in the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogLastMasterImage Get /MachineCatalogs/{nameOrId}/LastMasterImage Get the last master VM images used by the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogMachineAccounts Get /MachineCatalogs/{nameOrId}/MachineAccounts Get all machine accounts associated with a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogMachines Get /MachineCatalogs/{nameOrId}/Machines GET the machines of a catalog
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogMasterImageHistory Get /MachineCatalogs/{nameOrId}/MasterImageHistory Get the history of master VM images used by the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogStartMenuApplications Get /MachineCatalogs/{nameOrId}/StartMenuApplications Get the start menu applications from a machine in the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogTags Get /MachineCatalogs/{nameOrId}/Tags Get tags associated with a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogTestReport Get /MachineCatalogs/{nameOrId}/TestReport Get the most recent test report of a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogVDAComponentsAndFeatures Get /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures Get the components and features of VDAs associated with a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogs Get /MachineCatalogs Get all machine catalogs.
MachineCatalogsAPIsDAAS MachineCatalogsGetMachineCatalogsAdministrators Get /MachineCatalogs/{nameOrId}/Administrators Get administrators who can administer a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsImportProvisionedVirtualMachines Post /MachineCatalogs/{nameOrId}/$importProvisionedVirtualMachines Import existing provisioned virtual machines.
MachineCatalogsAPIsDAAS MachineCatalogsRebootMachineCatalogMachines Post /MachineCatalogs/{nameOrId}/$RebootMachines Reboot all machines in a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRemoveMachineCatalogMachine Delete /MachineCatalogs/{nameOrId}/Machines/{machine} Remove a machine from the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRemoveMachineCatalogMachineAccount Delete /MachineCatalogs/{nameOrId}/MachineAccounts/{machine} Remove a machine account from the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRemoveMachineCatalogTags Delete /MachineCatalogs/{nameOrId}/Tags/{tagNameOrId} Remove a tag from a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRemoveMachineCatalogUpgradeSchedule Delete /MachineCatalogs/{nameOrId}/UpgradeSchedule Remove a pending VDA upgrade schedule for a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRepairMachineCatalogMachineAccounts Post /MachineCatalogs/{nameOrId}/$repairMachineAccounts Repair all machine accounts in a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsRollbackMachineCatalogProvisioningScheme Post /MachineCatalogs/{nameOrId}/$RollbackProvisioningScheme Rollback the machine catalog's provisioning scheme.
MachineCatalogsAPIsDAAS MachineCatalogsSetMachineCatalogTags Put /MachineCatalogs/{nameOrId}/Tags Set tags associated with a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsTestMachineCatalog Post /MachineCatalogs/{nameOrId}/$test Run tests on a machine catalog and create a test report.
MachineCatalogsAPIsDAAS MachineCatalogsTestMachineCatalogExists Post /MachineCatalogs/$checkCatalogName Test the existence of a machine catalog by name.
MachineCatalogsAPIsDAAS MachineCatalogsTestRemotePCEnrollmentScopeExists Post /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/$checkScopeName Check for the existence of a RemotePC enrollment scope by name in the request body. Use HttpPost and take name in body as this name may be very long, and cause url too long exception.
MachineCatalogsAPIsDAAS MachineCatalogsUpdateMachineCatalog Patch /MachineCatalogs/{nameOrId} Update a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsUpdateMachineCatalogMachineAccount Patch /MachineCatalogs/{nameOrId}/MachineAccounts/{machine} Update a machine account within the machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsUpdateMachineCatalogProvisioningScheme Post /MachineCatalogs/{nameOrId}/$UpdateProvisioningScheme Update the machine catalog's provisioning scheme.
MachineCatalogsAPIsDAAS MachineCatalogsUpdateMachineCatalogUpgradeSchedule Patch /MachineCatalogs/{nameOrId}/UpgradeSchedule Reschedule a pending VDA upgrade schedule for a machine catalog.
MachineCatalogsAPIsDAAS MachineCatalogsValidateMachineCatalogVDAComponentsAndFeaturesSelection Post /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures/$validate Validate the VDA component selection at catalog level that can be Included/Excluded and features that need enable during an VDA upgrade using VDA Upgrade Service.
MachinesAPIsDAAS MachinesAddMachineTags Post /Machines/{nameOrId}/Tags/{tagNameOrId} Add a tag to a machine.
MachinesAPIsDAAS MachinesCheckMachineExists Head /Machines/{name} Check for the existence of a machine by name.
MachinesAPIsDAAS MachinesCreateMachineUpgradeSchedule Post /Machines/{nameOrId}/UpgradeSchedule Setup a new VDA upgrade schedule for a machine.
MachinesAPIsDAAS MachinesDisconnectSessions Post /Machines/{nameOrId}/$disconnect Disconnect all sessions on a machine.
MachinesAPIsDAAS MachinesDoMachineSearch Post /Machines/$search Perform an advanced search for machines.
MachinesAPIsDAAS MachinesGetMachine Get /Machines/{nameOrId} Get details of a single machine.
MachinesAPIsDAAS MachinesGetMachineApplications Get /Machines/{nameOrId}/Applications Get the list of applications on a machine.
MachinesAPIsDAAS MachinesGetMachineDeliveryGroup Get /Machines/{nameOrId}/DeliveryGroup Get the delivery group for a machine.
MachinesAPIsDAAS MachinesGetMachineDesktop Get /Machines/{nameOrId}/Desktop Get the desktop associated with the machine, if any.
MachinesAPIsDAAS MachinesGetMachineMachineCatalog Get /Machines/{nameOrId}/MachineCatalog Get the machine catalog for a machine.
MachinesAPIsDAAS MachinesGetMachinePowerActionSchedules Get /Machines/{nameOrId}/PowerActionSchedules Get the power action schedules associated with a machine.
MachinesAPIsDAAS MachinesGetMachineSessions Get /Machines/{nameOrId}/Sessions Get the list of sessions running on a machine.
MachinesAPIsDAAS MachinesGetMachineStartMenuShortcutIcon Get /Machines/{nameOrId}/StartMenuShortcutIcon Get a start menu shortcut icon from the machine.
MachinesAPIsDAAS MachinesGetMachineStartMenuShortcuts Get /Machines/{nameOrId}/StartMenuShortcuts Get start menu shortcuts from the machine.
MachinesAPIsDAAS MachinesGetMachineTags Get /Machines/{nameOrId}/Tags Get tags associated with a machine.
MachinesAPIsDAAS MachinesGetMachines Get /Machines Get all machines in the site.
MachinesAPIsDAAS MachinesGetMachinesAdministrators Get /Machines/{nameOrId}/Administrators Get administrators who can administer a machine
MachinesAPIsDAAS MachinesGetTestMachineReport Get /Machines/{nameOrId}/TestReports/{reportId} Get Cloud Health Check Report on a VDA machine.
MachinesAPIsDAAS MachinesImportFileTypes Post /Machines/{nameOrId}/FileTypes/$import Import file type associations from the machine.
MachinesAPIsDAAS MachinesLogoffMachineSessions Post /Machines/{nameOrId}/$logoff Logoff all sessions on a machine.
MachinesAPIsDAAS MachinesRebootMachine Post /Machines/{nameOrId}/$reboot Reboot a machine.
MachinesAPIsDAAS MachinesRemoveMachine Delete /Machines/{nameOrId} Delete a machine from the site.
MachinesAPIsDAAS MachinesRemoveMachineTags Delete /Machines/{nameOrId}/Tags/{tagNameOrId} Remove a tag from a machine.
MachinesAPIsDAAS MachinesRemoveMachineUpgradeSchedule Delete /Machines/{nameOrId}/UpgradeSchedule Remove a pending VDA upgrade schedule for a machine.
MachinesAPIsDAAS MachinesRemovePowerActionSchedule Delete /Machines/{nameOrId}/PowerActionSchedules Remove pending power action schedules for a machine.
MachinesAPIsDAAS MachinesResetProvVMDisk Post /Machines/{nameOrId}/$ResetProvVMDisk Resets the OS disk of persistent VMs to the current master image.
MachinesAPIsDAAS MachinesResumeMachine Post /Machines/{nameOrId}/$resume Resume a machine.
MachinesAPIsDAAS MachinesSetMachineTags Put /Machines/{nameOrId}/Tags Set tags associated with a machine.
MachinesAPIsDAAS MachinesShutdownMachine Post /Machines/{nameOrId}/$shutdown Shut down a machine.
MachinesAPIsDAAS MachinesStartMachine Post /Machines/{nameOrId}/$start Start a machine.
MachinesAPIsDAAS MachinesSuspendMachine Post /Machines/{nameOrId}/$suspend Suspend a machine.
MachinesAPIsDAAS MachinesTestMachine Post /Machines/{nameOrId}/$test Run Cloud Health Check on a VDA machine.
MachinesAPIsDAAS MachinesUpdateMachineCatalogMachine Patch /Machines/{nameOrId} Update a machine.
MachinesAPIsDAAS MachinesUpdateMachineUpgradeSchedule Patch /Machines/{nameOrId}/UpgradeSchedule Reschedule a pending VDA upgrade schedule for a machine.
MeAPIsDAAS MeDeleteMyPreference Delete /me/Preferences/{name} Delete one of admin preferences by name.
MeAPIsDAAS MeGetMe Get /me Get my details.
MeAPIsDAAS MeGetMyPreference Get /me/Preferences/{name} Get one of my preferences by name.
MeAPIsDAAS MeGetMyPreferences Get /me/Preferences Get my preferences.
MeAPIsDAAS MeSetMyPreference Put /me/Preferences Set a preference value.
RebootSchedulesAPIsDAAS RebootSchedulesGetRebootSchedules Get /RebootSchedules Get all reboot schedules in the site.
SessionsAPIsDAAS SessionsDisconnectSession Post /Sessions/{id}/$disconnect Disconnect a session.
SessionsAPIsDAAS SessionsDoSessionSearch Post /Sessions/$search Perform an advanced search for sessions.
SessionsAPIsDAAS SessionsGetSession Get /Sessions/{id} Get details of a single session.
SessionsAPIsDAAS SessionsGetSessionApplications Get /Sessions/{id}/Applications Get the list of applications running within a session.
SessionsAPIsDAAS SessionsGetSessionMachine Get /Sessions/{id}/Machine Get the details of the machine on which a session is running.
SessionsAPIsDAAS SessionsGetSessionRecordingStatus Get /Sessions/RecordingStatus get session recording status of a session.
SessionsAPIsDAAS SessionsGetSessions Get /Sessions Get all sessions in the site.
SessionsAPIsDAAS SessionsHideSession Post /Sessions/{id}/$hide Hide a session
SessionsAPIsDAAS SessionsLogoffSession Post /Sessions/{id}/$logoff Logoff a session.
SessionsAPIsDAAS SessionsSendSessionMessage Post /Sessions/{id}/$sendMessage Send a message to a session.
SessionsAPIsDAAS SessionsStartSessionRecording Post /Sessions/{id}/$startRecording start recording for a session.
SessionsAPIsDAAS SessionsStopSessionRecording Post /Sessions/{id}/$stopRecording stop recording for a session.
SessionsAPIsDAAS SessionsUnhideSession Post /Sessions/{id}/$unhide Unhide a session
SitesAPIsDAAS SitesGetMultipleRemotePCAssignments Get /Sites/{nameOrId}/MultipleRemotePCAssignments Get multi-user auto-assignment for Remote PC Access.
SitesAPIsDAAS SitesGetSessionsTrend Get /Sites/{nameOrId}/SessionsTrend Get the sessions trend
SitesAPIsDAAS SitesGetSite Get /Sites/{nameOrId} Get the details about a single site.
SitesAPIsDAAS SitesGetSiteSettings Get /Sites/{nameOrId}/Settings Get the settings for the site.
SitesAPIsDAAS SitesGetSiteStatus Get /Sites/{nameOrId}/Status Get the status of a site.
SitesAPIsDAAS SitesGetSiteTestReport Get /Sites/{nameOrId}/TestReport Get the most recent test report.
SitesAPIsDAAS SitesGetSites Get /Sites Get the list of sites that are available to the customer and visible to the admin.
SitesAPIsDAAS SitesGetUpgradePackageVersions Get /Sites/{nameOrId}/UpgradePackageVersions Get the latest released VDA upgrade package versions in the site.
SitesAPIsDAAS SitesPatchMultipleRemotePCAssignments Patch /Sites/{nameOrId}/MultipleRemotePCAssignments Update multi-user auto-assignment for Remote PC Access.
SitesAPIsDAAS SitesPatchSiteSettings Patch /Sites/{nameOrId}/Settings Update the broker site settings.
SitesAPIsDAAS SitesTestSite Post /Sites/{nameOrId}/$test Run tests on a site and create a test report.
StoreFrontServersAPIsDAAS StoreFrontServersCreateStoreFrontServer Post /StoreFrontServers Create a StoreFront server.
StoreFrontServersAPIsDAAS StoreFrontServersDeleteStoreFrontServer Delete /StoreFrontServers/{nameOrId} Delete a StoreFront server from the site.
StoreFrontServersAPIsDAAS StoreFrontServersGetStoreFrontDeliveryGroups Get /StoreFrontServers/{nameOrId}/DeliveryGroups GET delivery groups details for a Storefront
StoreFrontServersAPIsDAAS StoreFrontServersGetStoreFrontServer Get /StoreFrontServers/{nameOrId} Get the details for a single StoreFront server.
StoreFrontServersAPIsDAAS StoreFrontServersGetStoreFrontServers Get /StoreFrontServers Get all StoreFront servers.
StoreFrontServersAPIsDAAS StoreFrontServersUpdateStoreFrontServer Patch /StoreFrontServers/{nameOrId} Update a StoreFront server.
TagsAPIsDAAS TagsCheckTagExists Head /Tags/{name} Check for the existence of a tag by name.
TagsAPIsDAAS TagsCreateTag Post /Tags Create a tag.
TagsAPIsDAAS TagsDeleteTag Delete /Tags/{nameOrId} Delete a tag.
TagsAPIsDAAS TagsGetTag Get /Tags/{nameOrId} Get a single tag from the site.
TagsAPIsDAAS TagsGetTagApplicationGroups Get /Tags/{nameOrId}/ApplicationGroups Get the application groups associated with a tag.
TagsAPIsDAAS TagsGetTagApplications Get /Tags/{nameOrId}/Applications Get the applications associated with a tag.
TagsAPIsDAAS TagsGetTagDeliveryGroups Get /Tags/{nameOrId}/DeliveryGroups Get the delivery groups associated with a tag.
TagsAPIsDAAS TagsGetTagMachineCatalogs Get /Tags/{nameOrId}/MachineCatalogs Get the machine catalogs associated with a tag.
TagsAPIsDAAS TagsGetTagMachines Get /Tags/{nameOrId}/Machines Get the machines associated with a tag.
TagsAPIsDAAS TagsGetTags Get /Tags Get the list of all tags in the site.
TagsAPIsDAAS TagsPatchTag Patch /Tags/{nameOrId} Update a tag.
TagsAPIsDAAS TagsSetTagApplications Put /Tags/{nameOrId}/Applications Associate a tag with applications.
TagsAPIsDAAS TagsSetTagDeliveryGroups Put /Tags/{nameOrId}/DeliveryGroups Associate a tag with delivery groups.
TimeZonesAPIsDAAS TimeZonesGetTimeZones Get /TimeZones/All Get a list of time zones supported by the site.
TrustAPIsDAAS TrustExchangeToken Post /tokens Exchange the FMA token by using the domain credential. Basic authentication required for current Web Api.
TrustAPIsDAAS TrustGetBearerTokenWithWindowsAuthentication Get /tokens Exchange the FMA token via Windows Authentication. Kerberos or NTLM authentication required for current Web Api.
TrustAPIsDAAS TrustRefreshToken Post /tokens/$refresh Refresh the auth token.
ZonesAPIsDAAS ZonesAddItemsIntoZone Post /Zones/{nameOrId}/$addItems Add items into a zone.
ZonesAPIsDAAS ZonesCreateUserZonePreference Post /UserZonePreferences [DEPRECATED] Create a zone preference for a user or group account in this site.
ZonesAPIsDAAS ZonesCreateZone Post /Zones Create a zone.
ZonesAPIsDAAS ZonesDeleteUserZonePreference Delete /UserZonePreferences/{name} [DEPRECATED] Delete a zone preference for a user or group account in this site.
ZonesAPIsDAAS ZonesDeleteZone Delete /Zones/{nameOrId} Delete a zone.
ZonesAPIsDAAS ZonesDoZoneSearch Post /Zones/$search Perform a basic search for zoned items.
ZonesAPIsDAAS ZonesEditZone Patch /Zones/{nameOrId} Edit a zone.
ZonesAPIsDAAS ZonesGetUserZonePreference Get /UserZonePreferences/{name} [DEPRECATED] Get a zone preference for a user or group account in this site.
ZonesAPIsDAAS ZonesGetUserZonePreferenceList Get /UserZonePreferences [DEPRECATED] Get zone preference list in this site.
ZonesAPIsDAAS ZonesGetUserZonePreferencesByZone Get /Zones/{nameOrId}/UserZonePreferences [DEPRECATED] Get zone preference list of a specific zone.
ZonesAPIsDAAS ZonesGetZone Get /Zones/{nameOrId} Get a single zone from the site.
ZonesAPIsDAAS ZonesGetZones Get /Zones Get the list of all zones in the site.
ZonesAPIsDAAS ZonesMoveItemsIntoZone Post /Zones/{nameOrId}/$moveItems Move items into a zone.
ZonesAPIsDAAS ZonesRemoveItemsFromZone Post /Zones/$removeItems Remove items from a zone.
ZonesAPIsDAAS ZonesUpdateUserZonePreference Put /UserZonePreferences/{name} [DEPRECATED] Update a zone preference for a user or group account in this site.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth
  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Documentation is too large to display.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.