ApigeeAliases Class

Summary

Contains functionality for proxy import and deployments within Apigee.
Assembly
Cake.Apigee.dll
Namespace
Cake.Apigee
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["ApigeeAliases"] class Type type-node

Syntax

public static class ApigeeAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Properties

Methods

Name Value Summary
CreateKeyValueMap(ICakeContext, string, KeyValueMap, CreateKeyValueMapSettings) void
Create an organisation or environment scoped key value map (KVM) in Apigee.
static
DeleteAllUndeployedApiProxyRevisions(ICakeContext, string, string, DeleteAllUndeployedApiProxyRevisionsSettings) void
Delete all undeployed proxy revisions. This attempts to delete ALL proxy revisions but Apigee won't let already deployed revisions be removed.
static
DeleteApiProxyRevision(ICakeContext, string, string, string, DeleteApiProxyRevisionSettings) void
Delete a particular revision of a proxy.
static
DeleteKeyValueMap(ICakeContext, string, string, DeleteKeyValueMapSettings) void
Delete a key value map (KVM).
static
DeployProxy(ICakeContext, string, string, ImportProxyResult, DeployProxySettings) DeployProxyResult
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
static
DeployProxy(ICakeContext, string, string, string, string, DeployProxySettings) DeployProxyResult
Deploy a proxy to Apigee using a specific revision number.
static
GetApiProxy(ICakeContext, string, string, GetApiProxySettings) ApiProxy
Retrieve API proxy metadata such as the list of revisions and when the proxy was created.
static
ImportProxy(ICakeContext, string, string, FilePath, ImportProxySettings) ImportProxyResult
Import a proxy into Apigee from a zip file. The zip file should contain an apiproxy folder at the top level.
static
InstallNodePackagedModules(ICakeContext, string, ImportProxyResult, InstallNodePackagedModulesSettings) NodePackagedModuleMetadata[]
Run "npm install" on NodeJS embedded as a resource in the proxy based on a previous import. This can be useful if your proxy exceeds the 15MB limit imposed by Apigee.
static
InstallNodePackagedModules(ICakeContext, string, string, string, InstallNodePackagedModulesSettings) NodePackagedModuleMetadata[]
Run "npm install" on NodeJS embedded as a resource in the proxy. This can be useful if your proxy exceeds the 15MB limit imposed by Apigee.
static
ListKeyValueMaps(ICakeContext, string, ListKeyValueMapsSettings) IEnumerable<string>
List all of the key value maps at either organisation or environment scope.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin