Get-DSAzureADGroup

    2024-12-11

    Get-DSAzureADGroup

    SYNOPSIS

    Get groups from a Azure AD User PAM provider

    SYNTAX

    __AllParameterSets

    Get-DSAzureADGroup [-ProviderID] <guid> [-AsJITSettings] [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get groups from a Azure AD User PAM provider. The data returned is the name and sid of each groups. Those values can be added to the JIT settings' authorized groups of the provider.

    EXAMPLES

    EXAMPLE

    PS C:> $getResponse = Get-DSPamProvider $provider = $getResponse | Where Label -eq 'MyAzureADUserProvider' $groupsResponse = Get-DSAzureADGroup -ProviderID $provider.ID $desiredGroups = $groupsResponse | Where Name -like group* $provider.JitElevationSettings.AuthorizedGroups = $desiredGroups Update-DSPamProvider -InputObject $provider

    Add all groups whose name starts with 'group' in the JIT settings' authorized groups of the provider 'MyAzureADUserProvider' and save the modification

    PARAMETERS

    -AsJITSettings

    Return the object as the JIT settings value. Useful it is not initialized in the provider.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ProviderID

    PAM Provider to obtain the domains from

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    OUTPUTS

    NOTES

    For more information, type "Get-Help Get-DSAzureADGroup -detailed". For technical information, type "Get-Help Get-DSAzureADGroup -full".