ApigeeAliases.

DeployProxy(ICakeContext, string, string, ImportProxyResult, DeployProxySettings) Method

Summary

Deploy a proxy within Apigee to an environment in Apigee using the results of an import. By default, if settings are supplied, they will use override and a 15 second delay to minimize downtime as described in: http://docs.apigee.com/api-services/content/deploy-api-proxies-using-management-api#seamless
Assembly
Cake.Apigee.dll
Namespace
Cake.Apigee
Containing Type
ApigeeAliases

Syntax

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

Examples

Cake task:

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

 DeployProxy(
     orgName,
     "dev",
     result,
     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.
importResult ImportProxyResult Using the result of the import saves re-specifying the name and revision.
settings DeployProxySettings The setting such as authentication credentials.

Return Value

Type Description
DeployProxyResult