Win32_TSGatewayResourceAuthorizationPolicy class

Article
12/11/2020

Describes a Remote Desktop resource authorization policy (RD RAP). An RD RAP is used to decide whether a user is authorized to connect to a specified resource through Remote Desktop Gateway (RD Gateway).

Syntax

[dynamic, provider("AAGProvider"), AMENDMENT]
class Win32_TSGatewayResourceAuthorizationPolicy
{
  string  Name;
  string  Description;
  boolean Enabled;
  string  ResourceGroupType;
  string  ResourceGroupName;
  string  UserGroupNames;
  string  ProtocolNames;
  string  PortNumbers;
};

Members

The Win32_TSGatewayResourceAuthorizationPolicy class has these types of members:

Methods
Properties

Methods

The Win32_TSGatewayResourceAuthorizationPolicy class has these methods.

Method	Description
AddUserGroupNames	Adds the specified user group names to the existing user groups in the UserGroupNames property.
Create	Creates an RD RAP.
Delete	Deletes the current RD RAP.
RemoveUserGroupNames	Removes the specified user group names from the existing user groups in the UserGroupNames property.
SetDescription	Sets the Description property for the RD RAP.
SetEnabled	Enables or disables the RD RAP by setting the Enabled property.
SetName	Sets the Name property for the RD RAP.
SetPortNumbers	Sets the PortNumbers property for the RD RAP.
SetResourceGroup	Sets the ResourceGroupType and ResourceGroupName properties.
SetUserGroupNames	Sets the UserGroupNames property for the RD RAP.
Update	Updates the current RD RAP.

Properties

The Win32_TSGatewayResourceAuthorizationPolicy class has these properties.

Description

Data type: string
Access type: Read-only

Description of the RD RAP. This property is changed with the SetDescription method.

Enabled

Data type: boolean
Access type: Read-only

Indicates whether this RD RAP is enabled. This property is changed with the SetEnabled method.

Name

Data type: string
Access type: Read-only
Qualifiers: key

Name of the RD RAP. This property is changed with the SetName method.

PortNumbers

Data type: string
Access type: Read-only

List of semicolon-separated port numbers that are allowed for this policy. To allow any port number, set "*".

ProtocolNames

Data type: string
Access type: Read-only

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

ResourceGroupName

Data type: string
Access type: Read-only

Resource group name. This property is changed with the SetResourceGroup method.

ResourceGroupType

Data type: string
Access type: Read-only

Identifies the type of the resource group. This property is changed with the SetResourceGroup method.

"RG"

Resource group.

"CG"

Computer group, as stored in Active Directory Domain Services.

"ALL"

All resources.

UserGroupNames

Data type: string
Access type: Read-only

Semicolon-separated list of user group names. If the user belongs to any of these user groups, access will be permitted. This property is changed with the SetUserGroupNames, AddUserGroupNames, and RemoveUserGroupNames methods.

Remarks

You must be a member of the Administrators group to use this class.

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