Get-EdgeObject

NAME Get-EdgeObject



SYNOPSIS

Get one or more objects from Apigee Edge.





SYNTAX

Get-EdgeObject [[-Collection] <String>] [[-Name] <String>] [[-Environment] <String>] [[-Org] <String>] [[-Params]

<Hashtable>] [<CommonParameters>]





DESCRIPTION

Get one or more objects from Apigee Edge, such as developers, apis, apiproducts.

This is a lower-level cmdlet. You may want to try the higher-level cmdlets like

Get-EdgeApi or Get-EdgeDeveloper, etc.





PARAMETERS

-Collection <String>

Type of object to query for.



Example: 'developers', 'apis', 'caches', or 'apiproducts'



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Name of the object to retrieve.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Environment <String>

The Apigee Edge environment. This parameter does not apply to all object types.

It applies to 'caches' and 'kvms' but not developers or apis.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Org <String>

Optional. The Apigee Edge organization.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Params <Hashtable>

Hash table with query options for the specific collection type.



Required? false

Position? 5

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



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-EdgeObject -Collection developers -Org cap500



# List developers on Edge organization 'cap500'









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-EdgeObject -Collection developers -Org cap500 -Params @{ expand='true' }















RELATED LINKS