Skip to content

Settings

github-actions edited this page May 5, 2022 · 23 revisions

AzOps Settings

The following configuration values can be modified within the settings.json file to change the default behavior of AzOps.

ID Name Description Example
01 AutoGeneratedTemplateFolderPath Generate sub folder for composite resources (/.Az) Auto-Generated-Template-FolderPath
02 AutoInitialize Run Initialize-AzOpsEnvironment when module is loaded. Not recommended to change "Core.AutoInitialize": true
03 DefaultDeploymentRegion Default region for deployments "Core.DefaultDeploymentRegion": "northeurope"
04 EnrollmentAccountPrincipalName Default enrollment account for Subscription creation "Core.EnrollmentAccountPrincipalName": ""
05 ExcludedSubOffer Exclude specific Subscription offer types from pull "Core.ExcludedSubOffer": ["AzurePass_2014-09-01","FreeTrial_2014-09-01","AAD_2015-09-01"]
06 ExcludedSubState Exclude specific states of Subscription from pull "Core.ExcludedSubState": ["Disabled","Deleted","Warned","Expired"]
07 ExportRawTemplate Export generic templates without embedding them in the parameter block "Core.ExportRawTemplate": true
08 IgnoreContextCheck Skip Azure PowerShell context validation. Not recommended to change "Core.IgnoreContextCheck": false
09 IncludeResourcesInResourceGroup Discover only resources in these resource groups "Core.IncludeResourcesInResourceGroup": ["rg1","rg2"]
10 IncludeResourceType Discover only specific resource types Resource Types (only targets Resource Group scoped resources) "Core.IncludeResourceType": ["Microsoft.Network/privateDnsZones","Microsoft.Network/firewallPolicies"]
11 InvalidateCache Invalidate cached Subscriptions and Management Groups and do a full discovery. Not recommended to change "Core.InvalidateCache": false
12 OfferType Default offer type for Subscription creation "Core.OfferType": "MS-AZR-0017P"
13 PartialMgDiscoveryRoot Generate folder hierachy for specific Management Groups "Core.PartialMgDiscoveryRoot": []
14 SkipPolicy Do not include Azure Policy state in pull "Core.SkipPolicy": false
15 SkipResource Do not include Resources within Resource Groups "Core.SkipResource": false
16 SkipChildResource Do not include Azure child resources "Core.SkipChildResource": false
17 SkipResourceGroup Do not include Resource Groups in pull "Core.SkipResourceGroup": false
18 SkipResourceType Skip specific Resource Types (only targets Resource Group scoped resources) "Core.SkipResourceType": ["Microsoft.VSOnline/plans"]
19 SkipRole Do not include Role types in pull "Core.SkipRole": false
20 State Folder to store AzOpsState artefact, defaults to root State
21 SubscriptionsToIncludeResourceGroups Filter which Subscriptions should include Resource Groups in pull "Core.SubscriptionsToIncludeResourceGroups": ["*"]
22 TemplateParameterFileSuffix Default template file suffix. Not recommended to change "Core.TemplateParameterFileSuffix": ".json"
23 ThrottleLimit Default template file suffix. Not recommended to change "Core.ThrottleLimit": 10
24 WhatifExcludedChangeTypes Exclude specific change types from WhatIf operations "Core.WhatifExcludedChangeTypes": ["NoChange","Ignore"]