Update method of the Win32_TSGatewayResourceAuthorizationPolicy class

Article
12/11/2020

Updates the current Remote Desktop resource authorization policy (RD RAP).

Syntax

uint32 Update(
  [in] string  Name,
  [in] string  Description,
  [in] boolean Enabled,
  [in] string  ResourceGroupName,
  [in] string  ResourceGroupType,
  [in] string  UserGroupNames,
  [in] string  ProtocolNames,
  [in] string  PortNumbers
);

Parameters

Name [in]: Name of the RD RAP.
Description [in]: Description of the RD RAP.
Enabled [in]: Indicates whether the RD RAP should be enabled.
ResourceGroupName [in]: Resource group name associated with this RD RAP.
ResourceGroupType [in]: Resource group type.
"RG": Resource group.
"CG": Computer group, as stored in Active Directory Domain Services.
"ALL": All resources.

UserGroupNames [in]

Semicolon-separated list of user group names. The names are of the format Domain\UserGroupName. If the user belongs to any of these user groups, access will be permitted.

ProtocolNames [in]

Semicolon-separated list of protocol names that are enabled for this policy. Names must match the return of the GetProtocolName method of the Win32_TSGatewayServerSettings class.

PortNumbers [in]

Semicolon-separated list of port numbers that are enabled for this policy. To allow any port number, set "*".

Return value

If the method succeeds, it returns zero. If the method is unsuccessful, it returns a nonzero value. For a list of error codes, see Remote Desktop Services WMI Provider Error Codes.

Remarks

You must be a member of the Administrators group to call this method.

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008
Namespace	Root\CIMv2\TerminalServices
MOF	TSGateway.mof
DLL	AagWmi.dll