Skip to content

Commit 1ba20ad

Browse files
Small grammar fixes in README (#703)
* Small grammar fixes in README * update docs references to learn Co-authored-by: Johan Dahlbom <johan@dahlbom.eu>
1 parent adbe044 commit 1ba20ad

15 files changed

+30
-30
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ For tutorials, samples and quick starts, visit the [AzOps Accelerator](https://g
2121

2222
## Need help?
2323

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

3333
AzOps is rooted in the principle that everything in Azure is a resource and to operate at-scale, it should be managed declaratively to determine target goal state of the overall platform.
3434

35-
This PowerShell module provides the ability to deploy Resource Templates & Bicep files at all Azure [scope](https://docs.microsoft.com/azure/role-based-access-control/scope-overview) levels. To provide this functionality the multiple scopes within Azure Resource Manager are represented (example below) within Git. Using directories and files, templates can be deployed (Push) at various scopes whilst also exporting (Pull) composite templates from ARM and placing them within the repository.
35+
This PowerShell module provides the ability to deploy Resource Templates & Bicep files at all Azure [scope](https://learn.microsoft.com/azure/role-based-access-control/scope-overview) levels. To provide this functionality the multiple scopes within Azure Resource Manager are represented (example below) within Git. Using directories and files, templates can be deployed (Push) at various scopes whilst also exporting (Pull) composite templates from ARM and placing them within the repository.
3636

3737
```bash
3838
root
@@ -89,4 +89,4 @@ This project may contain trademarks or logos for projects, products, or services
8989
trademarks or logos is subject to and must follow
9090
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
9191
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
92-
Any use of third-party trademarks or logos are subject to those third-party's policies.
92+
Any use of third-party trademarks or logos are subject to those third-party's policies.

SUPPORT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Microsoft Support Policy
44

5-
If issues are encountered when using template and code in this repo, users will be able to engage Microsoft support via their usual channels. Please provide corelation IDs where possible when contacting support to be able to investigate issue effectively and in timely fashion. For instruction on how to get deployments and correlation ID, please follow this link [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/deployment-history?tabs=azure-portal#get-deployments-and-correlation-id).
5+
If issues are encountered when using template and code in this repo, users will be able to engage Microsoft support via their usual channels. Please provide corelation IDs where possible when contacting support to be able to investigate issue effectively and in timely fashion. For instruction on how to get deployments and correlation ID, please follow this link [here](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/deployment-history?tabs=azure-portal#get-deployments-and-correlation-id).
66

77
Following list of issues are within the scope of Microsoft support:
88

docs/wiki/Azure-Pipelines.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Before you start, make sure you have followed the steps in the [prerequisites](.
1515

1616
Links to documentation for further reading:
1717

18-
- [Create the Service Principal](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
19-
- [Assign the permissions at the required scope (/)](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
20-
- [Assign the Directory role permissions](https://docs.microsoft.com/azure/active-directory/roles/manage-roles-portal)
21-
- [Create Azure DevOps project](https://docs.microsoft.com/azure/devops/organizations/projects/create-project?view=azure-devops&tabs=preview-page)
18+
- [Create the Service Principal](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
19+
- [Assign the permissions at the required scope (/)](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
20+
- [Assign the Directory role permissions](https://learn.microsoft.com/azure/active-directory/roles/manage-roles-portal)
21+
- [Create Azure DevOps project](https://learn.microsoft.com/azure/devops/organizations/projects/create-project?view=azure-devops&tabs=preview-page)
2222

2323
### Important Repository link to refer
2424

@@ -42,8 +42,8 @@ The PowerShell script below will set up a new project or use an existing if it a
4242
<br/>
4343

4444
- Install dependent tools & extensions
45-
- [Azure CLI](https://docs.microsoft.com/cli/azure/)
46-
- [DevOps Extension](https://docs.microsoft.com/azure/devops/cli/?view=azure-devops)
45+
- [Azure CLI](https://learn.microsoft.com/cli/azure/)
46+
- [DevOps Extension](https://learn.microsoft.com/azure/devops/cli/?view=azure-devops)
4747

4848
<br/>
4949

docs/wiki/Debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Connect-AzAccount -Credential $Credential -Tenant xxxx-xxx-xxxx-xxxx-xxx -Servic
2626

2727
### Making a change
2828

29-
Running `Debug.ps1` in the last step leaves us on a [nested prompt](https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.host.pshost.enternestedprompt). We're now able to feed in new Powershell commands at the command prompt to run in the correct context.
29+
Running `Debug.ps1` in the last step leaves us on a [nested prompt](https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.host.pshost.enternestedprompt). We're now able to feed in new Powershell commands at the command prompt to run in the correct context.
3030

3131
In this example, we're going to provide a new ARM template at a specific scope. The Arm template is the [Create New Subscription](https://github.com/Azure/Enterprise-Scale/blob/main/examples/landing-zones/empty-subscription/emptySubscription.json)
3232
template from the Enterprise Scale repo, it has had default values provided for each of the parameters. The file is being dropped it inside the file structure that was created in the last step, inside the `Sandboxes` directory; `root\myorg (myorg)\myorg-sandboxes (myorg-sandboxes`).

docs/wiki/Frequently-Asked-Questions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ If you have changed `"Core.DefaultDeploymentRegion":` from the default `northeur
3737

3838
`Invalid deployment location 'westeurope'. The deployment 'AzOps-microsoft.management_managementgroups-nested' already exists in location 'northeurope'`
3939

40-
This happens because [it is unsupported in ARM](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/deploy-to-management-group?tabs=azure-cli#deployment-location-and-name) to create a deployment in one location when there's an existing deployment with the same name in a different location.
40+
This happens because [it is unsupported in ARM](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/deploy-to-management-group?tabs=azure-cli#deployment-location-and-name) to create a deployment in one location when there's an existing deployment with the same name in a different location.
4141

42-
To resolve the error, remove the failed deployment(s) from the target scope and re-run the failed Push pipeline. This can be done either under 'Deployments' at the particular scope in the Azure portal or with [PowerShell](https://docs.microsoft.com/en-us/powershell/module/az.resources/remove-azmanagementgroupdeployment?view=azps-7.1.0)/[Azure CLI](https://docs.microsoft.com/en-us/cli/azure/deployment/mg?view=azure-cli-latest#az-deployment-mg-delete)/[REST](https://docs.microsoft.com/en-us/rest/api/resources/deployments/delete-at-management-group-scope).
42+
To resolve the error, remove the failed deployment(s) from the target scope and re-run the failed Push pipeline. This can be done either under 'Deployments' at the particular scope in the Azure portal or with [PowerShell](https://learn.microsoft.com/en-us/powershell/module/az.resources/remove-azmanagementgroupdeployment?view=azps-7.1.0)/[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/deployment/mg?view=azure-cli-latest#az-deployment-mg-delete)/[REST](https://learn.microsoft.com/en-us/rest/api/resources/deployments/delete-at-management-group-scope).
4343
![Delete Deployments at scope](./Media/FAQ/delete_deployments.png)
4444

4545
## Pull fail with active pull request already exists error
@@ -52,7 +52,7 @@ This happens because it is not supported in Azure DevOps to create a pull reques
5252

5353
![Error](./Media/FAQ/existing_pr_error.png)
5454

55-
To resolve the error, [complete or abandon the existing pull request (PR)](https://docs.microsoft.com/en-us/azure/devops/repos/git/complete-pull-requests?view=azure-devops&tabs=browser) first and then rerun the pipeline.
55+
To resolve the error, [complete or abandon the existing pull request (PR)](https://learn.microsoft.com/en-us/azure/devops/repos/git/complete-pull-requests?view=azure-devops&tabs=browser) first and then rerun the pipeline.
5656

5757
![PR](./Media/FAQ/pr.png)
5858

docs/wiki/GitHub-Actions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ AzOps is supported with [GitHub Enterprise Server version 3.4.0](https://docs.gi
1919

2020
Links to documentation for further reading:
2121

22-
- [Create the Service Principal](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
23-
- [Assign the permissions at the required scope (/)](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
24-
- [Assign the Directory role permissions](https://docs.microsoft.com/azure/active-directory/roles/manage-roles-portal)
22+
- [Create the Service Principal](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
23+
- [Assign the permissions at the required scope (/)](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal)
24+
- [Assign the Directory role permissions](https://learn.microsoft.com/azure/active-directory/roles/manage-roles-portal)
2525

2626
### Important Repository link to refer
2727

docs/wiki/GitHub-OIDC.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ Before you start to configure the workload federation feature in Azure AD and ch
5959
## Resources
6060
Read more about the functionality in the official docs below:
6161

62-
* [Azure AD Workload identity federation](https://docs.microsoft.com/en-us/azure/active-directory/develop/workload-identity-federation)
62+
* [Azure AD Workload identity federation](https://learn.microsoft.com/en-us/azure/active-directory/develop/workload-identity-federation)
6363
* [GitHub Actions: Secure cloud deployments with OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/)

docs/wiki/Introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ File -> New -> Landing Zones (i.e. Subscription) process is ARM orchestrating th
6767
- Subscription move under the target management structure
6868
- Configuring Subscription to desired state by policy enforcement - autonomously.
6969

70-
To get started, follow the [**User Guide**](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale) that describes how the Enterprise-Scale reference implementations can be deployed at the tenant ("/") root scope. The [reference implementations](https://github.com/azure/enterprise-scale#deploying-enterprise-scale-architecture-in-your-own-environment) provide everything that is necessary in [Implementation Guide](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/enterprise-scale/implementation-guidelines), and will have the following sequence:
70+
To get started, follow the [**User Guide**](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale) that describes how the Enterprise-Scale reference implementations can be deployed at the tenant ("/") root scope. The [reference implementations](https://github.com/azure/enterprise-scale#deploying-enterprise-scale-architecture-in-your-own-environment) provide everything that is necessary in [Implementation Guide](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/enterprise-scale/implementation-guidelines), and will have the following sequence:
7171

7272
- Create (1) Management Group hierarchy and (2) Subscription organization structure in (Platform + N) fashion where N represents the number of landing zones.
7373
- Create Policies (deployIfNotExists) assigned to (2) Management Groups and (3) Subscription scope to govern and deploy necessary resources, enabling platform autonomy as new landing zones (Subscriptions) are being created by application teams

docs/wiki/Prerequisites.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ AzOps pipelines can use either a Service Principal, or a Managed Identity if run
1717
- Assign Azure `Owner` role at the required scope to the Service Principal/Managed Identity
1818
- Add Service Principal/Managed Identity to Azure AD `Directory Readers` role
1919

20-
The Azure Active Directory [Directory Readers](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#directory-readers) role is required to discover Azure 'roleAssignments'. These permissions are used to enrich data around the role assignments with additional Azure AD context such as `ObjectType` and Azure AD object `DisplayName`.
20+
The Azure Active Directory [Directory Readers](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#directory-readers) role is required to discover Azure 'roleAssignments'. These permissions are used to enrich data around the role assignments with additional Azure AD context such as `ObjectType` and Azure AD object `DisplayName`.
2121

2222
> Theses steps require PowerShell 7 and _Az.Accounts_, _Az.Resources_, _Microsoft.Graph.Applications_ and _Microsoft.Graph.Identity.DirectoryManagement_ modules, they will be installed.
2323

docs/wiki/Self-Hosted.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ The AzOps pipelines/actions are running on Microsoft-hosted agents or GitHub Act
1111
AzOps have full support for the use of self-hosted agents/runners and this article outlines the requirements needed.
1212

1313
For more information about using GitHub Actions self-hosted runners see, [About self-hosted runners](https://docs.github.com/actions/hosting-your-own-runners/about-self-hosted-runners).
14-
For more information about using Azure DevOps self-hosted agents see, [Azure Pipelines agents](https://docs.microsoft.com/azure/devops/pipelines/agents/agents?view=azure-devops&tabs=browser).
14+
For more information about using Azure DevOps self-hosted agents see, [Azure Pipelines agents](https://learn.microsoft.com/azure/devops/pipelines/agents/agents?view=azure-devops&tabs=browser).
1515

1616
## Virtual Machine Scale Sets (VMSS)
1717

18-
Virtual Machine Scale Sets are optimal for hosting your self-hosted agents/runners. They are easy to create and manage and will automatically scale as resource demand changes. To learn more about Virtual Machine Scale Sets see, [Virtual Machine Scale Sets documentation](https://docs.microsoft.com/azure/virtual-machine-scale-sets/).
18+
Virtual Machine Scale Sets are optimal for hosting your self-hosted agents/runners. They are easy to create and manage and will automatically scale as resource demand changes. To learn more about Virtual Machine Scale Sets see, [Virtual Machine Scale Sets documentation](https://learn.microsoft.com/azure/virtual-machine-scale-sets/).
1919

2020
## Image
2121

0 commit comments

Comments
 (0)