exports/Update-JcSdkOffice365.ps1
|
<# .Synopsis This endpoint allows updating some attributes of an Office 365 instance.\n\n#####\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{O365_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"maintain\",\n \"userPasswordExpirationAction\": \"suspend\"\n }'\n\n``` .Description This endpoint allows updating some attributes of an Office 365 instance.\n\n#####\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{O365_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"maintain\",\n \"userPasswordExpirationAction\": \"suspend\"\n }'\n\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/update-jcsdkoffice365 .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .Inputs JumpCloud.SDK.V2.Models.IOffice365PatchInput .Outputs JumpCloud.SDK.V2.Models.IOffice365Output .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. BODY <IOffice365PatchInput>: Office 365 Patch Input [UserLockoutAction <String>]: [UserPasswordExpirationAction <String>]: 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/update-jcsdkoffice365 #> function Update-JcSdkOffice365 { [OutputType([JumpCloud.SDK.V2.Models.IOffice365Output])] [CmdletBinding(DefaultParameterSetName='PatchExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Patch', Mandatory)] [Parameter(ParameterSetName='PatchExpanded', Mandatory)] [JumpCloud.SDK.V2.Category('Path')] [System.String] # ObjectID of the Office 365 instance. ${Office365Id}, [Parameter(ParameterSetName='PatchViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='PatchViaIdentityExpanded', 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='Patch', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='PatchViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IOffice365PatchInput] # Office 365 Patch Input # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='PatchExpanded')] [Parameter(ParameterSetName='PatchViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # HELP MESSAGE MISSING ${UserLockoutAction}, [Parameter(ParameterSetName='PatchExpanded')] [Parameter(ParameterSetName='PatchViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # HELP MESSAGE MISSING ${UserPasswordExpirationAction}, [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 = @{ Patch = 'JumpCloud.SDK.V2.private\Update-JcSdkOffice365_Patch'; PatchExpanded = 'JumpCloud.SDK.V2.private\Update-JcSdkOffice365_PatchExpanded'; PatchViaIdentity = 'JumpCloud.SDK.V2.private\Update-JcSdkOffice365_PatchViaIdentity'; PatchViaIdentityExpanded = 'JumpCloud.SDK.V2.private\Update-JcSdkOffice365_PatchViaIdentityExpanded'; } $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 } } } |