Update-EdgeApiProduct

NAME Update-EdgeApiProduct



SYNOPSIS

Update a API Product in Apigee Edge.





SYNTAX

Update-EdgeApiProduct [-Name] <String> [-Environments] <String[]> [-Proxies] <String[]> [[-Approval] <String>]

[[-Attributes] <Hashtable>] [[-DisplayName] <String>] [[-Description] <String>] [[-Scopes] <String[]>] [[-Quota]

<String>] [[-Org] <String>] [<CommonParameters>]





DESCRIPTION

Update a API Product in Apigee Edge. When invoking this cmdlet you need

to specify all the data that you would like to retain the API Product. For example,

not specifying a Description means you will remove any previous Description

attached to the product. Only the custom attributes you specify here will

be retained. Not specifying an attribute of 'access' will result in the

API Product having no access setting. Similarly, with Scopes.





PARAMETERS

-Name <String>

The name of the product. It must exist.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Environments <String[]>

An array of strings, the names of environments this Product should be valid for.

Each environment must be valid.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Proxies <String[]>

An array of strings, the names of API Proxies that should be enabled for this Product.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Approval <String>

Optional. The approval type for this product - either 'manual' or 'auto'.

Defaults to 'auto'.



Required? false

Position? 4

Default value auto

Accept pipeline input? false

Accept wildcard characters? false



-Attributes <Hashtable>

Optional. Hashtable specifying custom attributes for the product.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisplayName <String>

Optional. The display name for the product. Defaults to the name.



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

Optional. The description. Defaults to empty.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Scopes <String[]>

Optional. An array of strings, each one a valid scope for this product.

Defaults to empty.



Required? false

Position? 8

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Quota <String>

Optional. Aa string of the form "1000pm" implying 1000 per minute, which represents the quota.

The suffix can be 'pm', 'ph', 'pd', 'pM', for minute, hour, day, month. If not

specified, no Quota applies.



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Org <String>

The Apigee Edge organization. The default is to use the value from Set-EdgeConnection.



Required? false

Position? 10

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:\\>Update-EdgeApiProduct -Name 'Product-7' -DisplayName 'Product-7' -Environments @('test') -Proxies

@('oauth2-pwd-cc') -Attributes @{ CreatedBy = 'dino'; access = 'public' } -Description 'This is a test product'















RELATED LINKS