< Back
Export-ODUJob
Post
NAME Export-ODUJob
SYNOPSIS
Processes a single ExportJobDetail - DO NOT USE THIS FUNCTION DIRECTLY
SYNTAX
Export-ODUJob [-ExportJobDetail] <Object> [[-ItemIdOnlyReferencePropertyNames] <String[]>] [<CommonParameters>]
DESCRIPTION
DO NOT USE THIS FUNCTION DIRECTLY - it is only public so that it can be processed by
background jobs so it can run in parallel. In general you should NOT be directly
calling this function unless you plan on manually constructing the ExportJobDetail
object, which is a lot of work.
That said, this function processes a single ExportJobDetail:
- fetches content for a single url;
- captures ItemIdOnly value references;
- filters propertes on the exported data;
- saves data to file.
Data might be 0, 1 or multiple items.
Returns hashtable of ItemIdOnly reference values. That is: if a property listed in
ItemIdOnlyReferencePropertyNames is found on the object, the value for that property is
captured and returned at the end of the function call.
PARAMETERS
-ExportJobDetail <Object>
Information about the export: ApiCall info, Url, ApiKey to use in call, folder to save to
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ItemIdOnlyReferencePropertyNames <String[]>
ItemIdOnly property names to look for in data that is retrieved; return values for these if found
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Export-ODUJob
<...>
RELATED LINKS
https://github.com/DTW-DanWard/OctopusDeployUtilities
SYNOPSIS
Processes a single ExportJobDetail - DO NOT USE THIS FUNCTION DIRECTLY
SYNTAX
Export-ODUJob [-ExportJobDetail] <Object> [[-ItemIdOnlyReferencePropertyNames] <String[]>] [<CommonParameters>]
DESCRIPTION
DO NOT USE THIS FUNCTION DIRECTLY - it is only public so that it can be processed by
background jobs so it can run in parallel. In general you should NOT be directly
calling this function unless you plan on manually constructing the ExportJobDetail
object, which is a lot of work.
That said, this function processes a single ExportJobDetail:
- fetches content for a single url;
- captures ItemIdOnly value references;
- filters propertes on the exported data;
- saves data to file.
Data might be 0, 1 or multiple items.
Returns hashtable of ItemIdOnly reference values. That is: if a property listed in
ItemIdOnlyReferencePropertyNames is found on the object, the value for that property is
captured and returned at the end of the function call.
PARAMETERS
-ExportJobDetail <Object>
Information about the export: ApiCall info, Url, ApiKey to use in call, folder to save to
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ItemIdOnlyReferencePropertyNames <String[]>
ItemIdOnly property names to look for in data that is retrieved; return values for these if found
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Export-ODUJob
<...>
RELATED LINKS
https://github.com/DTW-DanWard/OctopusDeployUtilities