exports/Get-JcSdkActiveDirectory.ps1
|
<# .Synopsis This endpoint returns a specific Active Directory.\n\n#### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ``` .Description This endpoint returns a specific Active Directory.\n\n#### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ``` .Example To view examples, please use the -Online parameter with Get-Help or navigate to: https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v2/get-jcsdkactivedirectory .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .Outputs JumpCloud.SDK.V2.Models.IActiveDirectoryOutput .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 <IJumpCloudApIsIdentity>: Identity Parameter [AccountId <String>]: [ActivedirectoryId <String>]: ObjectID of the Active Directory instance. [ApplicationId <String>]: [CommandId <String>]: ObjectID of the Command. [GroupId <String>]: ObjectID of the User Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of the User Group. [JobId <String>]: [LdapserverId <String>]: ObjectID of the LDAP Server. [Office365Id <String>]: ObjectID of the Office 365 instance. [PolicyId <String>]: [ProviderId <String>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v2/get-jcsdkactivedirectory #> function Get-JcSdkActiveDirectory { [OutputType([JumpCloud.SDK.V2.Models.IActiveDirectoryOutput])] [CmdletBinding(DefaultParameterSetName='List', PositionalBinding=$false)] param( [Parameter(ParameterSetName='Get', Mandatory)] [JumpCloud.SDK.V2.Category('Path')] [System.String] # ObjectID of this Active Directory instance. ${Id}, [Parameter(ParameterSetName='GetViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Path')] [JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='List')] [JumpCloud.SDK.V2.Category('Query')] [System.String[]] # Supported operators are: eq, ne, gt, ge, lt, le, between, search, in ${Filter}, [Parameter(ParameterSetName='List')] [JumpCloud.SDK.V2.Category('Query')] [System.Int32] # The number of records to return at once. # Limited to 100. ${Limit}, [Parameter(ParameterSetName='List')] [JumpCloud.SDK.V2.Category('Query')] [System.Int32] # The offset into the records to return. ${Skip}, [Parameter(ParameterSetName='List')] [JumpCloud.SDK.V2.Category('Query')] [System.String[]] # The comma separated fields used to sort the collection. # Default sort is ascending, prefix with `-` to sort descending. ${Sort}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Get = 'JumpCloud.SDK.V2.private\Get-JcSdkActiveDirectory_Get'; GetViaIdentity = 'JumpCloud.SDK.V2.private\Get-JcSdkActiveDirectory_GetViaIdentity'; List = 'JumpCloud.SDK.V2.private\Get-JcSdkActiveDirectory_List'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |