Genpact Cora Knowledge Center

Support

PowerShell Function: Add-CoraOrchestrationSecretEnvironmentVariables

Starting with V10.0, Cora SeQuence has been renamed to Cora Orchestration.

V10.5

Module

CoraSeQuence

Description

Adds and updates environment variables for Secret stores.

Syntax

Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString <String> -DatabaseCredentials <String> -DatabaseProvider <String> -Sha256Salt <String> -RijndaelKey <String> -RijndaelSalt <String> -MessageBusDefaultConnectionName <String> -ActiveMQConnectionString <String> [-ActiveMQCredentials <String>] [-AzureServiceBusConnectionString <String>] [-MessageBusNotificationConnectionName <String>] -MessageBusRedundancyConnectionName [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString <String> -DatabaseCredentials <String> -DatabaseProvider <String> -Sha256Salt <String> -RijndaelKey <String> -RijndaelSalt <String> [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseAzureKeyVault -AzureKeyVaultClientId <Guid> -AzureKeyVaultClientSecret <String> -AzureKeyVaultTenantId <Guid> -AzureKeyVaultUri <String> [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseAWSSecretManager -AwsRegion <String> -AwsAccessKey <String> -AwsSecretKey <String> [-AwsSecretNamesFilter <String>] [-AwsUseSecretNameAsKeyPrefix <Boolean>] [-AwsKeyPrefixFilter <String>] [<CommonParameters>]

Parameters

-UseEnvironmentVariables [<SwitchParameter>]

Fetches the credentials from environment variables.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-UseAzureKeyVault [<SwitchParameter>]

Fetches the credentials from AzureKeyVault.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-UseAWSSecretManager [<SwitchParameter>]

Fetches the credentials from AWS SecretManager.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseConnectionString <String>

Sets the connection string to the database.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseCredentials <String>

Provides credentials to connect to the database.  
Correct syntax is user id=<userid>;password=<password>;.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseProvider <String>

Sets the database provider name to connect to the database.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false

 

-Sha256Salt <String>

Sets Salt for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-RijndaelKey <String>

Sets RijndaelKey for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-RijndaelSalt <String>

Sets RijndaelSalt for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-MessageBusDefaultConnectionName <String>

Sets default connection name for MessageBus. 

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-ActiveMQConnectionString <String>

Sets connection string for ActiveMQ, if using ActiveMQ as MessageBus or ServiceBroker. 

NOTE
For default service broker as SqlServiceBroker, don't set this parameter.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-ActiveMQCredentials <String>

Sets credentials for ActiveMQ, if using ActiveMQ as MessageBus or ServiceBroker.

Correct syntax is user id=<userid>;password=<password>;.

NOTE
For default service broker as SqlServiceBroker, don't set this parameter.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureServiceBusConnectionString <String>

Sets connection string for AzureServiceBus. 

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-MessageBusNotificationConnectionName <String>

Sets connection name for MessageBus notification. 

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-MessageBusRedundancyConnectionName <String>

Sets connection name for MessageBus redundancy. 

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultClientId <Guid>

Sets the Client ID to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultClientSecret <String>

Sets the Client Secret to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultTenantId <Guid>

Sets the Tenant ID to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultUri <String>

Sets the AzureKeyVault URI to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsRegion <String>

Sets the AWSRegion to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsAccessKey <String>

Sets the AWS Access Key ID to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsSecretKey <String>

Sets the AWS Secret Access Key to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsSecretNamesFilter <String>

Specifies the case sensitive prefix of the secrets to fetch from. Supports multiple values separated by ';'.

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsUseSecretNameAsKeyPrefix <Boolean>

When true, generates keys with secret name as prefix: "secretName:secretKey".
When false, generates keys without secret name as prefix: "secretKey".

Required? false
Position?  named
Default value True
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsKeyPrefixFilter <String>

Sets the prefix that all keys must start with to be included in the final configuration.

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
For more information, see about_CommonParameters.  

Example

Add-CoraOrchestrationSecretEnvironmentVariables -UseAzureKeyVault -AzureKeyVaultClientId '<ClientID>' -AzureKeyVaultClientSecret '<Secret>' -AzureKeyVaultTenantId '<TenantID>' -AzureKeyVaultUri '<KeyVaultUri>'
Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString '' -DatabaseCredentials 'user id=;password=;' -DatabaseProvider 'Microsoft.Data.SqlClient' -Sha256Salt '' -RijndaelKey '' -RijndaelSalt '' -ActiveMQConnectionString '' -ActiveMQCredentials 'user id=;password=;'

V10.1

Module

CoraSeQuence

Description

Adds and updates environment variables for Secret stores.

Syntax

Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString <String> -DatabaseCredentials <String> -DatabaseProvider <String> -Sha256Salt <String> -RijndaelKey <String> -RijndaelSalt <String> -ActiveMQConnectionString <String> -ActiveMQCredentials <String> [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString <String> -DatabaseCredentials <String> -DatabaseProvider <String> -Sha256Salt <String> -RijndaelKey <String> -RijndaelSalt <String> [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseAzureKeyVault -AzureKeyVaultClientId <Guid> -AzureKeyVaultClientSecret <String> -AzureKeyVaultTenantId <Guid> -AzureKeyVaultUri <String> [<CommonParameters>]
Add-CoraOrchestrationSecretEnvironmentVariables -UseAWSSecretManager -AwsRegion <String> -AwsAccessKey <String> -AwsSecretKey <String> [-AwsSecretNamesFilter <String>] [-AwsUseSecretNameAsKeyPrefix <Boolean>] [-AwsKeyPrefixFilter <String>] [<CommonParameters>]

Parameters

-UseEnvironmentVariables [<SwitchParameter>]

Fetches the credentials from environment variables.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-UseAzureKeyVault [<SwitchParameter>]

Fetches the credentials from AzureKeyVault.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-UseAWSSecretManager [<SwitchParameter>]

Fetches the credentials from AWS SecretManager.

Required? true
Position?  named
Default value False
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseConnectionString <String>

Sets the connection string to the database.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseCredentials <String>

Provides credentials to connect to the database.  
Correct syntax is user id=<userid>;password=<password>;.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-DatabaseProvider <String>

Sets the database provider name to connect to the database.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false

 

-Sha256Salt <String>

Sets Salt for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-RijndaelKey <String>

Sets RijndaelKey for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-RijndaelSalt <String>

Sets RijndaelSalt for security. Base64Encoded value of any string.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-ActiveMQConnectionString <String>

Sets connection string for ActiveMQ, if using ActiveMQ as MessageBus or ServiceBroker. 

NOTE
For default service broker as SqlServiceBroker, don't set this parameter.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-ActiveMQCredentials <String>

Sets credentials for ActiveMQ, if using ActiveMQ as MessageBus or ServiceBroker. Correct syntax is user id=<userid>;password=<password>;

NOTE
For default service broker as SqlServiceBroker, don't set this parameter.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultClientId <Guid>

Sets the Client ID to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultClientSecret <String>

Sets the Client Secret to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultTenantId <Guid>

Sets the Tenant ID to connect to AzureKeyVault

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AzureKeyVaultUri <String>

Sets the AzureKeyVault URI to connect to AzureKeyVault.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsRegion <String>

Sets the AWSRegion to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsAccessKey <String>

Sets the AWS Access Key ID to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsSecretKey <String>

Sets the AWS Secret Access Key to connect to AWS SecretManager.

Required? true
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsSecretNamesFilter <String>

Specifies the case-sensitive prefix of the secrets to fetch from. Supports multiple values separated by ';'.

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsUseSecretNameAsKeyPrefix  <Boolean>

When true, generates keys with secret name as prefix: "secretName:secretKey". When false, generates keys without secret name as prefix: "secretKey".

Required? false
Position?  named
Default value True
Accept pipeline input?  false
Accept wildcard characters?   false


-AwsKeyPrefixFilter <String>

Sets the prefix that all keys must start with to be included in the final configuration.

Required? false
Position?  named
Default value
Accept pipeline input?  false
Accept wildcard characters?   false


<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
For more information, see about_CommonParameters.  


Example

Add-CoraOrchestrationSecretEnvironmentVariables -UseAzureKeyVault -AzureKeyVaultClientId '<ClientID>' -AzureKeyVaultClientSecret '<Secret>' -AzureKeyVaultTenantId '<TenantID>' -AzureKeyVaultUri '<KeyVaultUri>'
Add-CoraOrchestrationSecretEnvironmentVariables -UseEnvironmentVariables -DatabaseConnectionString '<Connection String>' -DatabaseCredentials 'user id=<userid>;password=<password>;' -DatabaseProvider 'Microsoft.Data.SqlClient' -Sha256Salt '<Base64Encoded String>' -RijndaelKey '<Base64Encoded String>' -RijndaelSalt '<Base64Encoded String>' -ActiveMQConnectionString '<activeMQ Connection string>' -ActiveMQCredentials 'user id=<userid>;password=<password>;'