custom/generated/Set-JcSdkSoftwareApp.ps1
|
<# .Synopsis This endpoint updates a specific Software Application configuration for the organization. Only displayName can be changed. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"displayName\": \"Adobe Reader\" }' ``` .Description This endpoint updates a specific Software Application configuration for the organization. Only displayName can be changed. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"displayName\": \"Adobe Reader\" }' ``` .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .Inputs JumpCloud.SDK.V2.Models.ISoftwareApp .Outputs JumpCloud.SDK.V2.Models.ISoftwareApp .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 <ISoftwareApp>: [DisplayName <String>]: [Id <String>]: [Settings <ISoftwareAppSettings[]>]: [AllowUpdateDelay <Boolean?>]: [AppleVppAssignedLicenses <Int32?>]: [AppleVppAvailableLicenses <Int32?>]: [AppleVppDetails <ISoftwareAppAppleVppDetails>]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. [(Any) <Object>]: This indicates any property can be added to this object. [AppleVppTotalLicenses <Int32?>]: [AutoUpdate <Boolean?>]: [Location <String>]: Repository where the app is located within the package manager [LocationObjectId <String>]: ID of the repository where the app is located within the package manager [PackageId <String>]: [PackageManager <String>]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. INPUTOBJECT <IJumpCloudApIsIdentity>: [AccountId <String>]: [ActivedirectoryId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [CommandId <String>]: ObjectID of the Command. [CustomEmailType <String>]: [DeviceId <String>]: [GroupId <String>]: ObjectID of the System 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>]: [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>]: SETTINGS <ISoftwareAppSettings[]>: [AllowUpdateDelay <Boolean?>]: [AppleVppAssignedLicenses <Int32?>]: [AppleVppAvailableLicenses <Int32?>]: [AppleVppDetails <ISoftwareAppAppleVppDetails>]: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. [(Any) <Object>]: This indicates any property can be added to this object. [AppleVppTotalLicenses <Int32?>]: [AutoUpdate <Boolean?>]: [Location <String>]: Repository where the app is located within the package manager [LocationObjectId <String>]: ID of the repository where the app is located within the package manager [PackageId <String>]: [PackageManager <String>]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkSoftwareApp.md #> Function Set-JcSdkSoftwareApp { [OutputType([JumpCloud.SDK.V2.Models.ISoftwareApp])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(ParameterSetName='Set', Mandatory)] [Parameter(ParameterSetName='SetExpanded', Mandatory)] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Path')] [System.String] # . ${Id}, [Parameter(ParameterSetName='SetViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SetViaIdentityExpanded', 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()] [JumpCloud.SDK.V2.Category('Header')] [System.String] # Defines the creation-source header for gapps, o365 and workdays requests. # If the header isn't sent, the default value is `jumpcloud:bulk`, if you send the header with a malformed value you receive a 400 error. # Allowed: `jumpcloud:gapps`, `jumpcloud:o365`, `jumpcloud:workday`, `jumpcloud:bulk`. ${CreationSource}, [Parameter(ParameterSetName='Set', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SetViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.ISoftwareApp] # Software Application Package Object # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${DisplayName}, [Parameter(ParameterSetName='SetExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Id1}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.ISoftwareAppSettings[]] # . # To construct, see NOTES section for SETTINGS properties and create a hash table. ${Settings}, [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 { $Results = @() $PSBoundParameters.Add('HttpPipelineAppend', { param($req, $callback, $next) # call the next step in the Pipeline $ResponseTask = $next.SendAsync($req, $callback) $global:JCHttpRequest = $req # $global:JCHttpRequestContent = If (-not [System.String]::IsNullOrEmpty($req.Content)) { $req.Content.ReadAsStringAsync() } $global:JCHttpResponse = $ResponseTask # $global:JCHttpResponseContent = If (-not [System.String]::IsNullOrEmpty($ResponseTask.Result.Content)) { $ResponseTask.Result.Content.ReadAsStringAsync() } Return $ResponseTask } ) } Process { $Results = JumpCloud.SDK.V2.internal\Set-JcSdkInternalSoftwareApp @PSBoundParameters } End { Write-Debug ('HttpRequest: ' + $JCHttpRequest); # Write-Debug ('HttpRequestContent: ' + $JCHttpRequestContent.Result); Write-Debug ('HttpResponse: ' + $JCHttpResponse.Result); # Write-Debug ('HttpResponseContent: ' + $JCHttpResponseContent.Result); # Clean up global variables $GlobalVars = @('JCHttpRequest', 'JCHttpRequestContent', 'JCHttpResponse', 'JCHttpResponseContent') $GlobalVars | ForEach-Object { If ((Get-Variable -Scope:('Global')).Where( { $_.Name -eq $_ })) { Remove-Variable -Name:($_) -Scope:('Global') } } Return $Results } } |