< Back
Deploy-EdgeApi
Post
NAME Deploy-EdgeApi
SYNOPSIS
Deploy an apiproxy in Apigee Edge.
SYNTAX
Deploy-EdgeApi [-Name] <String> [-Environment] <String> [-Revision] <String> [[-Org] <String>] [[-Basepath]
<String>] [[-Params] <Hashtable>] [<CommonParameters>]
DESCRIPTION
Deploy a revision of an API proxy that is not yet deployed.
PARAMETERS
-Name <String>
Required. The name of the apiproxy to deploy.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Environment <String>
Required. The name of the environment to which to deploy the api proxy.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Revision <String>
Required. The revision of the apiproxy.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Org <String>
Optional. The Apigee Edge organization. The default is to use the value from Set-EdgeConnection.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Basepath <String>
Optional. The basepath to prepend to the proxy endpoints in the API proxy bundle.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Params <Hashtable>
Required? false
Position? 6
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:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8 -Params @{ override = true }
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8 -Params @{ override = true; delay = 45 }
RELATED LINKS
SYNOPSIS
Deploy an apiproxy in Apigee Edge.
SYNTAX
Deploy-EdgeApi [-Name] <String> [-Environment] <String> [-Revision] <String> [[-Org] <String>] [[-Basepath]
<String>] [[-Params] <Hashtable>] [<CommonParameters>]
DESCRIPTION
Deploy a revision of an API proxy that is not yet deployed.
PARAMETERS
-Name <String>
Required. The name of the apiproxy to deploy.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Environment <String>
Required. The name of the environment to which to deploy the api proxy.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Revision <String>
Required. The revision of the apiproxy.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Org <String>
Optional. The Apigee Edge organization. The default is to use the value from Set-EdgeConnection.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Basepath <String>
Optional. The basepath to prepend to the proxy endpoints in the API proxy bundle.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Params <Hashtable>
Required? false
Position? 6
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:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8 -Params @{ override = true }
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Deploy-EdgeApi -Name oauth2-pwd-cc -Environment test -Revision 8 -Params @{ override = true; delay = 45 }
RELATED LINKS