Class EscApi

EscApi is a client for the ESC API. It wraps the raw API client and provides a more convenient interface.

Export

EscApi

Constructors

constructor

new EscApi(config): EscApi
Parameters
- config: Configuration
Returns EscApi
- Defined in index.ts:81

Properties

config

config: Configuration

rawApi

rawApi: EscRawApi

Methods

checkEnvironment

checkEnvironment(orgName, env): Promise<undefined | CheckEnvironment>
checkEnvironment checks the environment definition.
Parameters
- orgName: string
  Organization name
- env: EnvironmentDefinition
  The environment definition
Returns Promise<undefined | CheckEnvironment>
The environment diagnostics

Summary
Check environment
- Defined in index.ts:453

checkEnvironmentYaml

checkEnvironmentYaml(orgName, yaml): Promise<undefined | CheckEnvironment>
checkEnvironmentYaml checks the environment definition from a YAML string.
Parameters
- orgName: string
  Organization name
- yaml: string
  YAML representation of the environment
Returns Promise<undefined | CheckEnvironment>
The environment diagnostics

Summary
Check environment YAML
- Defined in index.ts:428

cloneEnvironment

cloneEnvironment(orgName, srcProjectName, srcEnvName, destProjectName, destEnvName, cloneOptions?): Promise<void>
cloneEnvironment clones an environment
Parameters
- orgName: string
  Organization name
- srcProjectName: string
- srcEnvName: string
- destProjectName: string
  Destination project name
- destEnvName: string
  Destionation environment name
- Optional cloneOptions: CloneEnvironmentOptions
  Clone options
Returns Promise<void>
A promise that resolves when the environment is created

Summary
Clone environment
- Defined in index.ts:335

createEnvironment

createEnvironment(orgName, projectName, envName): Promise<void>
createEnvironment creates a new environment.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<void>
A promise that resolves when the environment is created

Summary
Create environment
- Defined in index.ts:310

createEnvironmentRevisionTag

createEnvironmentRevisionTag(orgName, projectName, envName, tag, revision): Promise<void>
createEnvironmentRevisionTag creates a new environment revision tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
- revision: number
  The revision number
Returns Promise<void>
A promise that resolves when the tag is created

Summary
Create environment revision tag
- Defined in index.ts:566

createEnvironmentTag

createEnvironmentTag(orgName, projectName, envName, tag, value): Promise<void>
createEnvironmentTag creates a new environment tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
- value: string
  The tag value
Returns Promise<void>
A promise that resolves when the tag is created

Summary
Create environment tag
- Defined in index.ts:695

decryptEnvironment

decryptEnvironment(orgName, projectName, envName): Promise<undefined | EnvironmentDefinitionResponse>
decryptEnvironment decrypts the environment definition.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<undefined | EnvironmentDefinitionResponse>
The decrypted environment definition and the YAML representation

Summary
Decrypt environment
- Defined in index.ts:466

deleteEnvironment

deleteEnvironment(orgName, projectName, envName): Promise<void>
deleteEnvironment deletes an environment.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<void>
A promise that resolves when the environment is deleted

Summary
Delete environment
- Defined in index.ts:412

deleteEnvironmentRevisionTag

deleteEnvironmentRevisionTag(orgName, projectName, envName, tag): Promise<void>
deleteEnvironmentRevisionTag deletes the environment revision tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
Returns Promise<void>
A promise that resolves when the tag is deleted

Summary
Delete environment revision tag
- Defined in index.ts:623

deleteEnvironmentTag

deleteEnvironmentTag(orgName, projectName, envName, tag): Promise<void>
deleteEnvironmentTag deletes the environment tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
Returns Promise<void>
A promise that resolves when the tag is deleted

Summary
Delete environment tag
- Defined in index.ts:762

getEnvironment

getEnvironment(orgName, projectName, envName): Promise<undefined | EnvironmentDefinitionResponse>
getEnvironment gets the definition of an environment.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<undefined | EnvironmentDefinitionResponse>
The environment definition and the YAML representation

Summary
Get environment
- Defined in index.ts:110

getEnvironmentAtVersion

getEnvironmentAtVersion(orgName, projectName, envName, version): Promise<undefined | EnvironmentDefinitionResponse>
getEnvironmentAtVersion gets the definition of an environment at a specific version.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- version: string
  Version of the environment
Returns Promise<undefined | EnvironmentDefinitionResponse>
The environment definition and the YAML representation

Summary
Get environment at version
- Defined in index.ts:136

getEnvironmentRevisionTag

getEnvironmentRevisionTag(orgName, projectName, envName, tag): Promise<undefined | EnvironmentRevisionTag>
getEnvironmentRevisionTag gets the environment revision tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
Returns Promise<undefined | EnvironmentRevisionTag>
The environment revision tag

Summary
Get environment revision tag
- Defined in index.ts:542

getEnvironmentTag

getEnvironmentTag(orgName, projectName, envName, tag): Promise<undefined | EnvironmentTag>
getEnvironmentTag gets the environment tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
Returns Promise<undefined | EnvironmentTag>
The environment tag

Summary
Get environment tag
- Defined in index.ts:671

listEnvironmentRevisionTags

listEnvironmentRevisionTags(orgName, projectName, envName, after?, count?): Promise<undefined | EnvironmentRevisionTags>
listEnvironmentRevisionTags lists the environment revision tags.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optional after: string
  The tag to start listing from
- Optional count: number
  The number of tags to list
Returns Promise<undefined | EnvironmentRevisionTags>
A list of environment revision tags

Summary
List environment revision tags
- Defined in index.ts:518

listEnvironmentRevisions

listEnvironmentRevisions(orgName, projectName, envName, before?, count?): Promise<undefined | EnvironmentRevision[]>
listEnvironmentRevisions lists the environment revisions, from oldest to newest.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optional before: number
  The revision number to start listing from
- Optional count: number
  The number of revisions to list
Returns Promise<undefined | EnvironmentRevision[]>
A list of environment revisions

Summary
List environment revisions
- Defined in index.ts:493

listEnvironmentTags

listEnvironmentTags(orgName, projectName, envName, after?, count?): Promise<undefined | ListEnvironmentTags>
listEnvironmentTags lists the environment tags.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optional after: string
  The tag to start listing from
- Optional count: number
  The number of tags to list
Returns Promise<undefined | ListEnvironmentTags>
A list of environment tags

Summary
List environment tags
- Defined in index.ts:647

listEnvironments

listEnvironments(orgName, continuationToken?): Promise<undefined | OrgEnvironments>
listEnvironments lists the environments in an organization.
Parameters
- orgName: string
  Organization name
- Optional continuationToken: string
  continuation Token from previous query to fetch next page of results
Returns Promise<undefined | OrgEnvironments>
A list of environments

Summary
List environments
- Defined in index.ts:93

openAndReadEnvironment

openAndReadEnvironment(orgName, projectName, envName): Promise<undefined | EnvironmentResponse>
openAndReadEnvironment opens an environment session and reads the environment properties, resolving configuration variables and secrets.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<undefined | EnvironmentResponse>
The environment and its values

Summary
Open and read environment
- Defined in index.ts:230

openAndReadEnvironmentAtVersion

openAndReadEnvironmentAtVersion(orgName, projectName, envName, version): Promise<undefined | EnvironmentResponse>
openAndReadEnvironmentAtVersion opens an environment session at a specific version and reads the environment properties, resolving configuration variables and secrets.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- version: string
  Version of the environment
Returns Promise<undefined | EnvironmentResponse>
The environment and its values

Summary
Open and read environment at version
- Defined in index.ts:253

openEnvironment

openEnvironment(orgName, projectName, envName): Promise<undefined | OpenEnvironment>
openEnvironment opens an environment session
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
Returns Promise<undefined | OpenEnvironment>
The open environment session information

Summary
Open environment
- Defined in index.ts:162

openEnvironmentAtVersion

openEnvironmentAtVersion(orgName, projectName, envName, version): Promise<undefined | OpenEnvironment>
openEnvironmentAtVersion opens an environment session at a specific version
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- version: string
  Version of the environment
Returns Promise<undefined | OpenEnvironment>
The open environment session information

Summary
Open environment at version
- Defined in index.ts:180

readOpenEnvironment

readOpenEnvironment(orgName, projectName, envName, openSessionID): Promise<undefined | EnvironmentResponse>
readOpenEnvironment reads the environment properties in an open session, resolving configuration variables and secrets.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- openSessionID: string
  Open session ID
Returns Promise<undefined | EnvironmentResponse>
The environment and its values

Summary
Read environment
- Defined in index.ts:204

readOpenEnvironmentProperty

readOpenEnvironmentProperty(orgName, projectName, envName, openSessionID, property): Promise<undefined | EnvironmentPropertyResponse>
readOpenEnvironmentProperty reads a specific environment property in an open session, resolving configuration variables and secrets.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- openSessionID: string
  Open session ID
- property: string
  Property name
Returns Promise<undefined | EnvironmentPropertyResponse>
The environment property and its value

Summary
Read environment property
- Defined in index.ts:278

updateEnvironment

updateEnvironment(orgName, projectName, envName, values): Promise<undefined | EnvironmentDiagnostics>
updateEnvironment updates the environment definition.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- values: EnvironmentDefinition
  The environment definition
Returns Promise<undefined | EnvironmentDiagnostics>
The environment diagnostics

Summary
Update environment
- Defined in index.ts:389

updateEnvironmentRevisionTag

updateEnvironmentRevisionTag(orgName, projectName, envName, tag, revision): Promise<void>
updateEnvironmentRevisionTag updates the environment revision tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
- revision: number
  The revision number
Returns Promise<void>
A promise that resolves when the tag is updated

Summary
Update environment revision tag
- Defined in index.ts:596

updateEnvironmentTag

updateEnvironmentTag(orgName, projectName, envName, tag, current_value, new_tag, new_value): Promise<void>
updateEnvironmentTag updates the environment tag.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tag: string
  The tag name
- current_value: string
  The tag value
- new_tag: string
  The new tag name
- new_value: string
  The new tag value
Returns Promise<void>
A promise that resolves when the tag is updated

Summary
Update environment tag
- Defined in index.ts:727

updateEnvironmentYaml

updateEnvironmentYaml(orgName, projectName, envName, yaml): Promise<undefined | EnvironmentDiagnostics>
updateEnvironmentYaml updates the environment definition from a YAML string.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- yaml: string
  YAML representation of the environment
Returns Promise<undefined | EnvironmentDiagnostics>
The environment diagnostics

Summary
Update environment YAML
- Defined in index.ts:366

Class EscApi

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EscApi

Properties

config

rawApi

Methods

checkEnvironment

Parameters

Returns Promise<undefined | CheckEnvironment>

Summary

checkEnvironmentYaml

Parameters

Returns Promise<undefined | CheckEnvironment>

Summary

cloneEnvironment

Parameters

Returns Promise<void>

Summary

createEnvironment

Parameters

Returns Promise<void>

Summary

createEnvironmentRevisionTag

Parameters

Returns Promise<void>

Summary

createEnvironmentTag

Parameters

Returns Promise<void>

Summary

decryptEnvironment

Parameters

Returns Promise<undefined | EnvironmentDefinitionResponse>

Summary

deleteEnvironment

Parameters

Returns Promise<void>

Summary

deleteEnvironmentRevisionTag

Parameters

Returns Promise<void>

Summary

deleteEnvironmentTag

Parameters

Returns Promise<void>

Summary

getEnvironment

Parameters

Returns Promise<undefined | EnvironmentDefinitionResponse>

Summary

getEnvironmentAtVersion

Parameters

Returns Promise<undefined | EnvironmentDefinitionResponse>

Summary

getEnvironmentRevisionTag

Parameters

Returns Promise<undefined | EnvironmentRevisionTag>

Summary

getEnvironmentTag

Parameters

Returns Promise<undefined | EnvironmentTag>

Summary

listEnvironmentRevisionTags

Parameters

Returns Promise<undefined | EnvironmentRevisionTags>

Summary

listEnvironmentRevisions

Parameters

Returns Promise<undefined | EnvironmentRevision[]>

Summary

listEnvironmentTags

Parameters