This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Apigee.

Summary

Deploy a proxy to Apigee using a specific revision number.

Assembly: Cake.Apigee.dll
Namespace: Cake.Apigee
Containing Type: ApigeeAliases

Syntax

public static DeployProxyResult DeployProxy(this ICakeContext ctx, string orgName, string envName, string apiName, string revisionNumber, DeployProxySettings settings = null)

Examples

Cake task to deploy revision 123 of myapi to the dev environment for myorg:

 var orgName = "myorg";
 var apigeeCredentials = new Credentials
 {
    Username = "[email protected]",
    Password = "mypassword"
 };

 DeployProxy(
     orgName,
     "dev",
     "myapi",
     "123",
     new DeployProxySettings { Credentials = apigeeCredentials });

Remarks

This calls the following API: https://docs.apigee.com/management/apis/post/organizations/%7Borg_name%7D/environments/%7Benv_name%7D/apis/%7Bapi_name%7D/revisions/%7Brevision_number%7D/deployments

Attributes

Type	Description
CakeMethodAliasAttribute

Parameters

Name	Type	Description
ctx	ICakeContext	The Cake context.
orgName	string	Your org name as shown in Apigee.
envName	string	The name of the environment as shown in Apigee.
apiName	string	Name of the proxy/api.
revisionNumber	string	The revision number of the proxy.
settings	DeployProxySettings	The deployment settings such as the credentials. At least pass new settings to get the seamless deployment parameters described above.

Return Value

Type	Description
DeployProxyResult	Result of the deployment.

ApigeeAliases.