Public/Groups/PolicyGroups/Remove-JCPolicyGroup.ps1
|
<# .Synopsis This endpoint allows you to delete a Policy Group. .Description This endpoint allows you to delete a Policy Group. .Example PS C:\> Remove-JCPolicyGroup -Id:(<string>) ---- ---------- Attributes JumpCloud.SDK.V2.Models.GraphAttributes Description String Email String Id String Name String Type String .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity .Outputs JumpCloud.SDK.V2.Models.IPolicyGroup .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <IJumpCloudApiIdentity>: Identity Parameter [AccountId <String>]: [ActivedirectoryId <String>]: [AdministratorId <String>]: [AgentId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [ApprovalFlowId <String>]: [CommandId <String>]: ObjectID of the Command. [CustomEmailType <String>]: [DeviceId <String>]: [GroupId <String>]: ObjectID of the Policy Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of this Active Directory instance. [JobId <String>]: [LdapserverId <String>]: ObjectID of the LDAP Server. [Office365Id <String>]: ObjectID of the Office 365 instance. [PolicyId <String>]: ObjectID of the Policy. [ProviderId <String>]: [PushEndpointId <String>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SoftwareAppId <String>]: ObjectID of the Software App. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Remove-JcSdkPolicyGroup.md #> Function Remove-JCPolicyGroup { [OutputType([JumpCloud.SDK.V2.Models.IPolicyGroup])] [CmdletBinding(DefaultParameterSetName='Delete', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(ParameterSetName='Delete', Mandatory)] [Alias('_id', 'PolicyGroupID')] [JumpCloud.SDK.V2.Category('Path')] [System.String] # ObjectID of the Policy Group. ${Id}, [Parameter(ParameterSetName='DeleteViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Path')] [JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity] # Identity Parameter ${InputObject}, [Parameter()] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru} ) Begin { Connect-JCOnline -force | Out-Null $Results = @() } Process { $Results = JumpCloud.SDK.V2\Remove-JcSdkPolicyGroup @PSBoundParameters } End { Return $Results } } |