Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AzOps v2.0 #748

Merged
merged 1 commit into from
Feb 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/wiki-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,4 @@ jobs:
git add .
git commit -m "$github_commit_message [$GITHUB_ACTOR/${GITHUB_SHA::8}]"
git push --set-upstream https://$GITHUB_TOKEN@github.com/$wiki_target_repo.git master
working-directory: ${{ env.wiki_target_repo }}

working-directory: ${{ env.wiki_target_repo }}
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,15 @@ For tutorials, samples and quick starts, visit the [AzOps Accelerator](https://g

- [Az.Accounts](https://github.com/azure/azure-powershell)
- [Az.Billing](https://github.com/azure/azure-powershell)
- [Az.ResourceGraph](https://github.com/azure/azure-powershell)
- [Az.Resources](https://github.com/azure/azure-powershell)
- [PSFramework](https://github.com/PowershellFrameworkCollective/psframework)

## Need help?

For introduction guidance, visit the [GitHub Wiki](https://github.com/azure/azops/wiki)
For reference documentation, visit the [Enterprise-Scale](https://github.com/azure/enterprise-scale)
For tutorials, samples and quick starts, go to [AzOps Accelerator](https://github.com/azure/azops-accelerator)
For information on contributing to the module, visit the [Contributing Guide](https://github.com/Azure/azops/wiki/debug)
For information on migrating to the new version, visit the [Migration Guide](https://github.com/azure/azops/wiki/migration)
File an issue via [GitHub Issues](https://github.com/azure/azops/issues/new/choose)

## Output
Expand Down
39 changes: 19 additions & 20 deletions docs/wiki/Settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,25 @@ The following configuration values can be modified within the `settings.json` fi
| 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](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-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 | SkipPim | Do not include Privileged Identity Management resources in pull | `"Core.SkipPim": true` |
| 15 | SkipLock | Do not include ResourceLock resources in pull | `"Core.SkipLock": true` |
| 16 | SkipPolicy | Do not include Azure Policy state in pull | `"Core.SkipPolicy": false` |
| 17 | SkipResource | Do not include Resources within Resource Groups | `"Core.SkipResource": false` |
| 18 | SkipChildResource | Do not include Azure child resources | `"Core.SkipChildResource": false` |
| 19 | SkipResourceGroup | Do not include Resource Groups in pull | `"Core.SkipResourceGroup": false` |
| 20 | SkipResourceType | Skip specific [Resource Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types) (only targets Resource Group scoped resources) | `"Core.SkipResourceType": ["Microsoft.VSOnline/plans"]` |
| 21 | SkipRole | Do not include Role types in pull | `"Core.SkipRole": false` |
| 22 | State | Folder to store AzOpsState artefact, defaults to `root` | `"Core.State: "/root"` |
| 23 | SubscriptionsToIncludeResourceGroups | Filter which Subscriptions should include Resource Groups in pull | `"Core.SubscriptionsToIncludeResourceGroups": ["*"]` |
| 24 | TemplateParameterFileSuffix | Default template file suffix. *Not recommended to change* | `"Core.TemplateParameterFileSuffix": ".json"` |
| 25 | ThrottleLimit | Default template file suffix. *Not recommended to change* | `"Core.ThrottleLimit": 10` |
| 26 | WhatifExcludedChangeTypes | Exclude specific change types from WhatIf operations | `"Core.WhatifExcludedChangeTypes": ["NoChange","Ignore"]` |
| 07 | IgnoreContextCheck | Skip Azure PowerShell context validation. *Not recommended to change* | `"Core.IgnoreContextCheck": false` |
| 08 | IncludeResourcesInResourceGroup | Discover only resources in these resource groups | `"Core.IncludeResourcesInResourceGroup": ["rg1","rg2"]` |
| 09 | IncludeResourceType | Discover only specific resource types [Resource Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types) (only targets Resource Group scoped resources) | `"Core.IncludeResourceType": ["Microsoft.Network/privateDnsZones","Microsoft.Network/firewallPolicies"]` |
| 10 | InvalidateCache | Invalidate cached Subscriptions and Management Groups and do a full discovery. *Not recommended to change* | `"Core.InvalidateCache": false` |
| 11 | OfferType | Default offer type for Subscription creation | `"Core.OfferType": "MS-AZR-0017P"` |
| 12 | PartialMgDiscoveryRoot | Generate folder hierachy for specific Management Groups | `"Core.PartialMgDiscoveryRoot": []` |
| 13 | SkipPim | Do not include Privileged Identity Management resources in pull | `"Core.SkipPim": true` |
| 14 | SkipLock | Do not include ResourceLock resources in pull | `"Core.SkipLock": true` |
| 15 | SkipPolicy | Do not include Azure Policy state in pull | `"Core.SkipPolicy": false` |
| 16 | SkipResource | Do not include Resources within Resource Groups | `"Core.SkipResource": false` |
| 17 | SkipChildResource | Do not include Azure child resources | `"Core.SkipChildResource": false` |
| 18 | SkipResourceGroup | Do not include Resource Groups in pull | `"Core.SkipResourceGroup": false` |
| 19 | SkipResourceType | Skip specific [Resource Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types) (only targets Resource Group scoped resources) | `"Core.SkipResourceType": ["Microsoft.VSOnline/plans"]` |
| 20 | SkipRole | Do not include Role types in pull | `"Core.SkipRole": false` |
| 21 | State | Folder to store AzOpsState artefact, defaults to `root` | `"Core.State: "/root"` |
| 22 | SubscriptionsToIncludeResourceGroups | Filter which Subscriptions should include Resource Groups in pull | `"Core.SubscriptionsToIncludeResourceGroups": ["*"]` |
| 23 | TemplateParameterFileSuffix | Default template file suffix. *Not recommended to change* | `"Core.TemplateParameterFileSuffix": ".json"` |
| 24 | ThrottleLimit | Default template file suffix. *Not recommended to change* | `"Core.ThrottleLimit": 10` |
| 25 | WhatifExcludedChangeTypes | Exclude specific change types from WhatIf operations | `"Core.WhatifExcludedChangeTypes": ["NoChange","Ignore"]` |

## Workflow / Pipeline Settings

Expand Down
1 change: 0 additions & 1 deletion src/AzOps.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,3 @@ PrivateData = @{
# DefaultCommandPrefix = ''

}

Original file line number Diff line number Diff line change
@@ -1 +1 @@
del(.ResourceId, .Properties.Metadata, .ResourceGroupName, .SubscriptionId)
del(.ResourceId, .resourceGroup, .subscriptionId, .properties.metadata.createdOn, .properties.metadata.updatedOn, .properties.metadata.createdBy, .properties.metadata.createdBy, .properties.metadata.updatedBy, .properties.metadata.assignedBy)

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
del(.ResourceId, .ResourceName, .PolicyDefinitionId, .SubscriptionId, .Properties.PolicyType, .Properties.Metadata.createdBy, .Properties.Metadata.createdOn, .Properties.Metadata.updatedBy, .Properties.Metadata.updatedOn)
del(.ResourceId, .id, .tenantId, .subscriptionId, .properties.policyType, .properties.metadata.createdOn, .properties.metadata.updatedOn, .properties.metadata.createdBy, .properties.metadata.createdBy, .properties.metadata.updatedBy)
Original file line number Diff line number Diff line change
@@ -1 +1 @@
del(.ResourceId, .Properties.Metadata, .ResourceGroupName, .SubscriptionId, .SystemData)
del(.ResourceId, .ResourceGroupName, .SubscriptionId, .SystemData, .Properties.CreatedOn, .Properties.UpdatedOn, .Properties.CreatedBy, .Properties.CreatedBy, .Properties.UpdatedBy)
Original file line number Diff line number Diff line change
@@ -1 +1 @@
del(.ResourceId, .ResourceName, .PolicyDefinitionId, .SubscriptionId, .Properties.PolicyType, .Properties.Metadata.createdBy, .Properties.Metadata.createdOn, .Properties.Metadata.updatedBy, .Properties.Metadata.updatedOn)
del(.ResourceId, .id, .tenantId, .subscriptionId, .properties.policyType, .properties.metadata.createdOn, .properties.metadata.updatedOn, .properties.metadata.createdBy, .properties.metadata.createdBy, .properties.metadata.updatedBy)

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
del(.Id)| .Properties |=
{DisplayName, ObjectType, PrincipalId, RoleDefinitionId, RoleDefinitionName}
del(.properties.createdOn, .properties.updatedOn, .properties.createdBy, .properties.createdBy, .properties.updatedBy)

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
del(.Id)
del(.properties.createdOn, .properties.updatedOn, .properties.createdBy, .properties.createdBy, .properties.updatedBy)
Loading