internal/Set-JcSdkInternalSoftwareApp.ps1
|
# ---------------------------------------------------------------------------------- # Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.6.6, generator: @autorest/powershell@3.0.463) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis This endpoint updates a specific Software Application configuration for the organization.\ndisplayName can be changed alone if no settings are provided.\nIf a setting is provided, it should include all its information since this endpoint will update all the settings' fields.\n\n#### Sample Request - displayName only\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"displayName\": \"My Software App\"\n }'\n```\n\n#### Sample Request - all attributes\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"displayName\": \"My Software App\",\n \"settings\": [\n {\n \"packageId\": \"123456\",\n \"autoUpdate\": false,\n \"allowUpdateDelay\": false,\n \"packageManager\": \"APPLE_VPP\",\n \"locationObjectId\": \"123456789012123456789012\",\n \"location\": \"123456\",\n \"desiredState\": \"Install\",\n \"appleVpp\": {\n \"appConfiguration\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?><!DOCTYPE plist PUBLIC \\\"-//Apple//DTD PLIST 1.0//EN\\\" \\\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\\\"><plist version=\\\"1.0\\\"><dict><key>MyKey</key><string>My String</string></dict></plist>\",\n \"assignedLicenses\": 20,\n \"availableLicenses\": 10,\n \"details\": {},\n \"isConfigEnabled\": true,\n \"supportedDeviceFamilies\": [\n \"IPAD\",\n \"MAC\"\n ],\n \"totalLicenses\": 30\n },\n \"packageSubtitle\": \"My package subtitle\",\n \"packageVersion\": \"1.2.3\",\n \"packageKind\": \"software-package\",\n \"assetKind\": \"software\",\n \"assetSha256Size\": 256,\n \"assetSha256Strings\": [\n \"a123b123c123d123\"\n ],\n \"description\": \"My app description\"\n }\n ]\n }'\n``` .Description This endpoint updates a specific Software Application configuration for the organization.\ndisplayName can be changed alone if no settings are provided.\nIf a setting is provided, it should include all its information since this endpoint will update all the settings' fields.\n\n#### Sample Request - displayName only\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"displayName\": \"My Software App\"\n }'\n```\n\n#### Sample Request - all attributes\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"displayName\": \"My Software App\",\n \"settings\": [\n {\n \"packageId\": \"123456\",\n \"autoUpdate\": false,\n \"allowUpdateDelay\": false,\n \"packageManager\": \"APPLE_VPP\",\n \"locationObjectId\": \"123456789012123456789012\",\n \"location\": \"123456\",\n \"desiredState\": \"Install\",\n \"appleVpp\": {\n \"appConfiguration\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?><!DOCTYPE plist PUBLIC \\\"-//Apple//DTD PLIST 1.0//EN\\\" \\\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\\\"><plist version=\\\"1.0\\\"><dict><key>MyKey</key><string>My String</string></dict></plist>\",\n \"assignedLicenses\": 20,\n \"availableLicenses\": 10,\n \"details\": {},\n \"isConfigEnabled\": true,\n \"supportedDeviceFamilies\": [\n \"IPAD\",\n \"MAC\"\n ],\n \"totalLicenses\": 30\n },\n \"packageSubtitle\": \"My package subtitle\",\n \"packageVersion\": \"1.2.3\",\n \"packageKind\": \"software-package\",\n \"assetKind\": \"software\",\n \"assetSha256Size\": 256,\n \"assetSha256Strings\": [\n \"a123b123c123d123\"\n ],\n \"description\": \"My app description\"\n }\n ]\n }'\n``` .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity .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>: Software Application Package [DisplayName <String>]: [Id <String>]: [Settings <ISoftwareAppSettings[]>]: [AllowUpdateDelay <Boolean?>]: [AppleVppAppConfiguration <String>]: Text sent to configure the application, the text should be a valid plist. [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. [AppleVppIsConfigEnabled <Boolean?>]: Denotes if configuration has been enabled for the application. [AppleVppSupportedDeviceFamilies <String[]>]: The supported device families for this VPP Application. [AppleVppTotalLicenses <Int32?>]: [AssetKind <String>]: The manifest asset kind (ex: software). [AssetSha256Size <Int32?>]: The incremental size to use for summing the package as it is downloaded. [AssetSha256Strings <String[]>]: The array of checksums, one each for the hash size up to the total size of the package. [AutoUpdate <Boolean?>]: [Description <String>]: The software app description. [DesiredState <String>]: State of Install or Uninstall [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>]: [PackageKind <String>]: The package manifest kind (ex: software-package). [PackageManager <String>]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. [PackageSubtitle <String>]: The package manifest subtitle. [PackageVersion <String>]: The package manifest version. INPUTOBJECT <IJumpCloudApiIdentity>: Identity Parameter [AccountId <String>]: [ActivedirectoryId <String>]: [AdministratorId <String>]: [AgentId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [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>]: SETTINGS <ISoftwareAppSettings[]>: . [AllowUpdateDelay <Boolean?>]: [AppleVppAppConfiguration <String>]: Text sent to configure the application, the text should be a valid plist. [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. [AppleVppIsConfigEnabled <Boolean?>]: Denotes if configuration has been enabled for the application. [AppleVppSupportedDeviceFamilies <String[]>]: The supported device families for this VPP Application. [AppleVppTotalLicenses <Int32?>]: [AssetKind <String>]: The manifest asset kind (ex: software). [AssetSha256Size <Int32?>]: The incremental size to use for summing the package as it is downloaded. [AssetSha256Strings <String[]>]: The array of checksums, one each for the hash size up to the total size of the package. [AutoUpdate <Boolean?>]: [Description <String>]: The software app description. [DesiredState <String>]: State of Install or Uninstall [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>]: [PackageKind <String>]: The package manifest kind (ex: software-package). [PackageManager <String>]: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. [PackageSubtitle <String>]: The package manifest subtitle. [PackageVersion <String>]: The package manifest version. .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkInternalSoftwareApp.md #> function Set-JcSdkInternalSoftwareApp { [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.IJumpCloudApiIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='Set', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SetViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.ISoftwareApp] # Software Application Package # 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')] [AllowEmptyCollection()] [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 { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Set = 'JumpCloud.SDK.V2.private\Set-JcSdkInternalSoftwareApp_Set'; SetExpanded = 'JumpCloud.SDK.V2.private\Set-JcSdkInternalSoftwareApp_SetExpanded'; SetViaIdentity = 'JumpCloud.SDK.V2.private\Set-JcSdkInternalSoftwareApp_SetViaIdentity'; SetViaIdentityExpanded = 'JumpCloud.SDK.V2.private\Set-JcSdkInternalSoftwareApp_SetViaIdentityExpanded'; } $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 } } } |