Initialize-CafSubscription

Initializes the subscription management resources for a single subscription.

Syntax

Initialize-CafSubscription
    [-BicepSettingsPath <string>]
    [-DeploymentFileName <string>]
    [-DeploymentParameterFileName <string>]
    [-DeploymentTechType <string>]
    [-KeyVaultName <string>]
    [-SubscriptionId <string>]
    [-SubscriptionName <string>]
    [-ForceAssetDownload]
    [-RemoveArtifacts]
    [-WhatIf]

Description

Deploys the subscription management resources to a single subscription.

Example

Initialize-CafSubscription
    -SubscriptionId "00000000-0000-0000-0000-000000000000"
    -SubscriptionName "mySubscription"

Parameter

-BicepSettingsPath The path to the Bicep settings file.

Property	Value
Type:	string
Default value:	""
Required:	False

-DeploymentFileName The name of the Bicep or Terraform deployment file.

Property	Value
Type:	string
Default value:	"main.bicep"
Required:	False

-DeploymentParameterFileName The name of the Bicep or Terraform parameter file.

Property	Value
Type:	string
Default value:	"main.bicepparam"
Required:	False

-DeploymentTechType The deployment technology to use for the deployment.

Property	Value
Type:	string
Allowed values:	["bicep", "terraform"]
Default value:	"bicep"
Required:	False

-KeyVaultName The name of the KeyVault where the credentials of the service principal are stored.

Property	Value
Type:	string
Default value:	""
Required:	False

-SubscriptionId The subscription id to use for the deployment.

Property	Value
Type:	string
Default value:	""
Required:	False

-SubscriptionName The subscription name to use for the deployment.

Note

If not specified, the subscription name is retrieved from Azure.

Property	Value
Type:	string
Default value:	""
Required:	False

-ForceAssetDownload
If specified, the assets are downloaded again even if they already exist.

Property	Value
Type:	SwitchParameter
Default value:	False
Required:	False

-RemoveArtifacts
If specified, the downloaded assets are removed after the deployment.

Property	Value
Type:	SwitchParameter
Default value:	False
Required:	False

-WhatIf
If specified, the deployment is only simulated.