...
How you retrieve credentials a Connect Id depends on whether or not you want the credentials for the "RunAs" Connect Id, or for one of the available Connect Ids.
Using the “RunAs” ConnectId
To access/use the current Run As ConnectID, either call Get-Credential cmdlet or use $ConnectId.Credentials in your script. For scripts with multiple Run As ConnectIDs bound, the credential associated with the "current" ConnectID of the current script run will be provided.
...
| Code Block |
|---|
# This command would retrieve the credentials for the "RunAs" Connect Id $runAsCredentials = Get-Credential |
Using an “Available” Connect Id
For any available Connect Id, you can retrieve the credentials by accessing them from the $ConnectIds hashtable. The $ConnectIds hashtable stores the Connect Id names as the keys, and the Connect Id properties in a hashtable stored in the value associated with that key. If you know the name of the Connect Id for which you want credentials, you can do the following to access the credentials in your script:
Retrieving an “Available” Connect Id By Name
| Code Block |
|---|
# This command would retrieve the credentials for the Connect Id called "Azure" $availableCredentials = $connectIds['Azure'].Credentials |
Retrieving an “Available” Connect Id by Property value
| Info |
|---|
Connect Ids also have other properties that can be used from within a script. For example, to obtain the credentials from an available Connect Id based on its Type, you could do the following:
...
Property Name | Description | Connect Id Type |
| The name of the Connect Id. | All |
| The type of Connect Id. | All |
| The URL associated with the Connect Id. | Email, Generic |
| The credentials stored in the Connect Id. | All |
| The (domain) name of the SMTP server. | |
| The port to use for the SMTP server. | |
| The URL to use to connect to ServiceNow. | Service Now |
variableName | Any variable name created on the Connect Id. | All |
ConnectId Properties
A ConnectId has the following available properties:
Property Name | Description |
|---|---|
Credential | Holds the PSCredential associated with the ConnectID |
Name | The name given to the ConnectID |
Type | The Type of ConnectId, eg.
|
Run User | The Cloudbridge user currently running the script. |
variable name | Any variable names created on the ConnectID |