☰
Navigation :

Connection

The Connection object stores one or more connections. Each resource is created according to a specific connection. The Connection object to allows a single deployment to be spread over multiple accounts in multiple clouds.

Connection

Attribute Type Mandatory Values Default Notes
Name String Yes
Azure Object Yes

Azure

Attribute Type Mandatory Values Default Notes
Environment String No AzureCloud AzureCloud
AzureChinaCloud
AzureUSGovernment
TenantId String
Azure Credential Object No
Azure Context Object Yes

Azure Credential

Attribute Type Mandatory Values Default Notes
Username String No
Password String No
ManagedIdentity String No
ApplicationId String No

Azure Context

Attribute Type Mandatory Values Default Notes
SubscriptionId GUID Yes

The following example shows a configuration object in YAML with one connection for a specific subscription. No credential is specified in the connection, so it will prompt you to login and supply credentials:

---
Connection:
  - Name: az-jd-test
    Azure: 
      Environment: AzureCloud
      TenantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      Credential:
        Username: 
        Password:
        ManagedIdentity:
        ApplicationId:
      Context:
        SubscriptionId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

The following example shows a configuration in JSON:

{
  "Connection": [
    {
      "Name": "az-jd-test",
      "Azure": {
        "Environment": "AzureCloud",
        "TenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "Credential": {
          "Username": ,
          "Password": ,
          "ManagedIdentity": ,
          "ApplicationId": 
        },
        "Context": {
          "SubscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      }
    }
  ]
}