Skip to content

Commit 531a3ea

Browse files
stijnmoreelsstijnmoreels
authored
chore: use file paths io url routes (#275)
1 parent 301d4bc commit 531a3ea

82 files changed

Lines changed: 528 additions & 395 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/preview/01-index.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ For more granular packages we recommend reading the documentation.
1818

1919
# Features
2020

21-
* Automate Azure API Management tasks ([powershell](features/powershell/azure-api-management))
22-
* Automate Azure App Service tasks ([powershell](features/powershell/azure-app-service))
23-
* Automate Azure Data Factory tasks ([powershell](features/powershell/azure-data-factory))
24-
* Automate Azure DevOps tasks ([powershell](features/powershell/azure-devops))
25-
* Automate Azure Integration Account tasks ([powershell](features/powershell/azure-integration-account))
26-
* Automate Azure Key Vault tasks ([powershell](features/powershell/azure-key-vault))
27-
* Automate Azure Logic Apps tasks ([powershell](features/powershell/azure-logic-apps))
28-
* Automate Azure Resource Manager (ARM) tasks ([powershell](features/powershell/arm))
29-
* Automate Azure Security tasks ([powershell](features/powershell/azure-security))
30-
* Automate Azure SQL tasks ([powershell](features/powershell/azure-sql))
31-
* Automate Azure Storage tasks ([powershell](features/powershell/azure-storage/azure-storage-all))
32-
* Azure Table Storage tasks ([powershell](features/powershell/azure-storage/azure-storage-table))
33-
* Azure Blob Storage tasks ([powershell](features/powershell/azure-storage/azure-storage-blob))
34-
* Azure File Share Storage tasks ([powershell](features/powershell/azure-storage/azure-storage-fileshare))
21+
* Automate Azure API Management tasks ([powershell](./02-Features/powershell/azure-api-management.md))
22+
* Automate Azure App Service tasks ([powershell](./02-Features/powershell/azure-app-service.md))
23+
* Automate Azure Data Factory tasks ([powershell](./02-Features/powershell/azure-data-factory.md))
24+
* Automate Azure DevOps tasks ([powershell](./02-Features/powershell/azure-devops.md))
25+
* Automate Azure Integration Account tasks ([powershell](./02-Features/powershell/azure-integration-account.md))
26+
* Automate Azure Key Vault tasks ([powershell](./02-Features/powershell/azure-key-vault.md))
27+
* Automate Azure Logic Apps tasks ([powershell](./02-Features/powershell/azure-logic-apps.md))
28+
* Automate Azure Resource Manager (ARM) tasks ([powershell](./02-Features/powershell/arm.md))
29+
* Automate Azure Security tasks ([powershell](./02-Features/powershell/azure-security.md))
30+
* Automate Azure SQL tasks ([powershell](./02-Features/powershell/azure-sql.md))
31+
* Automate Azure Storage tasks ([powershell](./02-Features/powershell/azure-storage/azure-storage-all.md))
32+
* Azure Table Storage tasks ([powershell](./02-Features/powershell/azure-storage/azure-storage-table.md))
33+
* Azure Blob Storage tasks ([powershell](./02-Features/powershell/azure-storage/azure-storage-blob.md))
34+
* Azure File Share Storage tasks ([powershell](./02-Features/powershell/azure-storage/azure-storage-fileshare.md))
3535

3636
# License
3737
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.

‎docs/preview/02-Features/powershell/arm.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ layout: default
66
# ARM
77

88
This module provides the following capabilities:
9-
- [Injecting content into an ARM template](#injecting-content-into-an-arm-template)
9+
- [ARM](#arm)
10+
- [Installation](#installation)
11+
- [Injecting content into an ARM template](#injecting-content-into-an-arm-template)
12+
- [Usage](#usage)
13+
- [Injection Instructions](#injection-instructions)
14+
- [Recommendations](#recommendations)
1015

1116
## Installation
1217

@@ -55,6 +60,7 @@ PS> Inject-ArmContent -Path deploy\arm-template.json
5560
```
5661

5762
### Injection Instructions
63+
5864
It is possible to supply injection instructions in the injection annotation, this allows you to add specific functionality to the injection. These are the available injection instructions:
5965

6066
| Injection Instruction | Description |

‎docs/preview/02-Features/powershell/azure-api-management.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@ layout: default
66
# Azure API Management
77

88
This module provides the following capabilities:
9-
- [Backing up an API Management service](#backing-up-an-api-management-service)
10-
- [Creating a new API operation in the Azure API Management instance](#creating-a-new-api-operation-in-the-azure-api-management-instance)
11-
- [Importing a policy to a product in the Azure API Management instance](#importing-a-policy-to-a-product-in-the-azure-api-management-instance)
12-
- [Importing a policy to an API in the Azure API Management instance](#importing-a-policy-to-an-api-in-the-azure-api-management-instance)
13-
- [Importing a policy to an operation in the Azure API Management instance](#importing-a-policy-to-an-operation-in-the-azure-api-management-instance)
14-
- [Removing all Azure API Management defaults from the instance](#removing-all-azure-api-management-defaults-from-the-instance)
15-
- [Restoring an API Management service](#restoring-an-api-management-service)
16-
- [Setting authentication keys to an API in the Azure API Management instance](#setting-authentication-keys-to-an-api-in-the-azure-api-management-instance)
17-
- [Uploading private certificates to the Azure API Management certificate store](#uploading-private-certificates-to-the-azure-api-management-certificate-store)
9+
- [Azure API Management](#azure-api-management)
10+
- [Installation](#installation)
11+
- [Backing up an API Management service](#backing-up-an-api-management-service)
12+
- [Creating a new API operation in the Azure API Management instance](#creating-a-new-api-operation-in-the-azure-api-management-instance)
13+
- [Importing a policy to an API in the Azure API Management instance](#importing-a-policy-to-an-api-in-the-azure-api-management-instance)
14+
- [Importing a policy to an operation in the Azure API Management instance](#importing-a-policy-to-an-operation-in-the-azure-api-management-instance)
15+
- [Removing all Azure API Management defaults from the instance](#removing-all-azure-api-management-defaults-from-the-instance)
16+
- [Restoring an API Management service](#restoring-an-api-management-service)
17+
- [Setting authentication keys to an API in the Azure API Management instance](#setting-authentication-keys-to-an-api-in-the-azure-api-management-instance)
18+
- [Uploading private certificates to the Azure API Management certificate store](#uploading-private-certificates-to-the-azure-api-management-certificate-store)
1819

1920
## Installation
2021

@@ -118,6 +119,7 @@ PS> Import-AzApiManagementApiPolicy -ResourceGroupName $ResourceGroup -ServiceNa
118119
```
119120

120121
## Importing a policy to an operation in the Azure API Management instance
122+
121123
Imports a policy from a file to an API operation in Azure API Management.
122124

123125
| Parameter | Mandatory | Description |
@@ -149,7 +151,7 @@ PS> Remove-AzApiManagementDefaults -ResourceGroupName $ResourceGroup -ServiceNam
149151
# Removing Unlimited product...
150152
```
151153

152-
# Restoring an API Management service
154+
## Restoring an API Management service
153155

154156
The Restore-AzApiManagement cmdlet restores an API Management Service from the specified backup residing in an Azure Storage blob.
155157

@@ -165,7 +167,7 @@ The Restore-AzApiManagement cmdlet restores an API Management Service from the s
165167
| `DefaultProfile` | no | The credentials, account, tenant, and subscription used for communication with azure. |
166168

167169
```powershell
168-
PS> Restore-AzApiManagementService -ResourceGroupName $ResourceGroupName -$StorageAcountResourceGroupName -StorageAccountName $StorageAccountName -ServiceName $ServiceName -ContainerName $ContainerName -BlobName $BlobName
170+
PS> Restore-AzApiManagementService -ResourceGroupName $ResourceGroupName -$StorageAccountResourceGroupName -StorageAccountName $StorageAccountName -ServiceName $ServiceName -ContainerName $ContainerName -BlobName $BlobName
169171
# Getting Azure storage account key...
170172
# Got Azure storage key!
171173
# Create new Azure storage context with storage key...
@@ -175,7 +177,8 @@ PS> Restore-AzApiManagementService -ResourceGroupName $ResourceGroupName -$Stora
175177
```
176178

177179
## Setting authentication keys to an API in the Azure API Management instance
178-
Sets the subscription header/query paramenter name to an API in Azure API Management.
180+
181+
Sets the subscription header/query parameter name to an API in Azure API Management.
179182

180183
| Parameter | Mandatory | Description |
181184
| ------------------- | --------- | --------------------------------------------------------------------------------------------- |
@@ -204,6 +207,7 @@ Write-Host "Subscription key query parameter 'myApiKey' was assigned"
204207
```
205208

206209
## Uploading private certificates to the Azure API Management certificate store
210+
207211
Uploads a private certificate to the Azure API Management certificate store, allowing authentication against backend services.
208212

209213
| Parameter | Mandatory | Description |

‎docs/preview/02-Features/powershell/azure-app-service.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ layout: default
66
# Azure App Service
77

88
This module provides the following capabilities:
9-
- [Set an app setting within an Azure App Service](#set-an-app-setting-within-an-azure-app-service)
9+
- [Azure App Service](#azure-app-service)
10+
- [Installation](#installation)
11+
- [Set an app setting within an Azure App Service](#set-an-app-setting-within-an-azure-app-service)
1012

1113
## Installation
1214

‎docs/preview/02-Features/powershell/azure-data-factory.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ layout: default
66
# Azure Data Factory
77

88
This module provides the following capabilities:
9-
- [Enabling a trigger of an Azure Data Factory pipeline](#enabling-a-trigger-of-an-azure-data-factory-pipeline)
10-
- [Disabling a trigger of an Azure Data Factory pipeline](#disabling-a-trigger-of-an-azure-data-factory-pipeline)
9+
- [Azure Data Factory](#azure-data-factory)
10+
- [Installation](#installation)
11+
- [Enabling a trigger of an Azure Data Factory pipeline](#enabling-a-trigger-of-an-azure-data-factory-pipeline)
12+
- [Disabling a trigger of an Azure Data Factory pipeline](#disabling-a-trigger-of-an-azure-data-factory-pipeline)
1113

1214
## Installation
1315

@@ -36,7 +38,7 @@ PS> Enable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFact
3638
```
3739

3840
```powershell
39-
PS> Enable-AzDataFactoryTrigger -ResourceGroupName "my-resouce-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
41+
PS> Enable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
4042
# Error: Error retrieving trigger 'unknown-data-factory-trigger-name' in data factory 'my-data-factory'.
4143
```
4244

@@ -60,6 +62,6 @@ PS> Disable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFac
6062
```
6163

6264
```powershell
63-
PS> Disable-AzDataFactoryTrigger -ResourceGroupName "my-resouce-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
65+
PS> Disable-AzDataFactoryTrigger -ResourceGroupName "my-resource-group" -DataFactoryName "my-data-factory-name" -DataFactoryTriggerName "unknown-data-factory-trigger-name" -FailWhenTriggerIsNotFound
6466
# Error: Error retrieving trigger 'unknown-data-factory-trigger-name' in data factory 'my-data-factory'.
6567
```

‎docs/preview/02-Features/powershell/azure-devops.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ layout: default
77

88
This module provides the following capabilities:
99

10-
- [Installation](#installation)
11-
- [Setting a variable in an Azure DevOps pipeline](#setting-a-variable-in-an-azure-devops-pipeline)
12-
- [Setting ARM outputs to Azure DevOps variable group](#setting-arm-outputs-to-azure-devops-variable-group)
13-
- [Setting ARM outputs to Azure DevOps pipeline variables](#setting-arm-outputs-to-azure-devops-pipeline-variables)
14-
- [Save Azure DevOps build](#save-azure-devops-build)
10+
- [Azure DevOps](#azure-devops)
11+
- [Installation](#installation)
12+
- [Setting a variable in an Azure DevOps pipeline](#setting-a-variable-in-an-azure-devops-pipeline)
13+
- [Setting ARM outputs to Azure DevOps variable group](#setting-arm-outputs-to-azure-devops-variable-group)
14+
- [Setting ARM outputs to Azure DevOps pipeline variables](#setting-arm-outputs-to-azure-devops-pipeline-variables)
15+
- [Save Azure DevOps build](#save-azure-devops-build)
1516

1617
## Installation
1718

‎docs/preview/02-Features/powershell/azure-integration-account.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ layout: default
66
# Azure Integration Account
77

88
This module provides the following capabilities:
9-
- [Uploading schemas into an Azure Integration Account](#uploading-schemas-into-an-azure-integration-account)
10-
- [Uploading maps into an Azure Integration Account](#uploading-maps-into-an-azure-integration-account)
11-
- [Uploading assemblies into an Azure Integration Account#](#uploading-assemblies-into-an-azure-integration-account)
12-
- [Uploading certificates into an Azure Integration Account#](#uploading-certificates-into-an-azure-integration-account)
13-
- [Uploading partners into an Azure Integration Account#](#uploading-partners-into-an-azure-integration-account)
14-
- [Uploading agreements into an Azure Integration Account#](#uploading-agreements-into-an-azure-integration-account)
9+
- [Azure Integration Account](#azure-integration-account)
10+
- [Installation](#installation)
11+
- [Uploading schemas into an Azure Integration Account](#uploading-schemas-into-an-azure-integration-account)
12+
- [Uploading maps into an Azure Integration Account](#uploading-maps-into-an-azure-integration-account)
13+
- [Uploading assemblies into an Azure Integration Account](#uploading-assemblies-into-an-azure-integration-account)
14+
- [Uploading certificates into an Azure Integration Account](#uploading-certificates-into-an-azure-integration-account)
15+
- [Uploading partners into an Azure Integration Account](#uploading-partners-into-an-azure-integration-account)
16+
- [Uploading agreements into an Azure Integration Account](#uploading-agreements-into-an-azure-integration-account)
1517

1618
## Installation
1719

@@ -122,7 +124,7 @@ PS> Set-AzIntegrationAccountMaps -ResourceGroupName 'my-resource-group' -Name 'm
122124
Uploading a *single map* into an Integration Account and set add a prefix to the name of the schema within the Integration Account.
123125
```powershell
124126
PS> Set-AzIntegrationAccountMaps -ResourceGroupName 'my-resource-group' -Name 'my-integration-account' -MapFilePath "C:\Maps\MyMap.xslt" -ArtifactsPrefix 'dev-'
125-
# Uploading smapchema 'dev-MyMap.xsd' into the Azure Integration Account 'my-integration-account'
127+
# Uploading map 'dev-MyMap.xsd' into the Azure Integration Account 'my-integration-account'
126128
# Map 'dev-MyMap.xsd' has been uploaded into the Azure Integration Account 'my-integration-account'
127129
```
128130

‎docs/preview/02-Features/powershell/azure-key-vault.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ layout: default
66
# Azure Key Vault
77

88
This module provides the following capabilities:
9-
- [Getting all access policies for an Azure Key Vault](#getting-all-access-policies-for-an-azure-key-vault)
10-
- [Setting a secret value from file into Azure Key Vault](#setting-a-secret-value-from-file-into-azure-key-vault)
11-
- [Setting a secret value with BASE64 encoded file-content into Azure Key Vault](#setting-a-secret-value-with-base64-encoded-file-content-into-azure-key-vault)
9+
- [Azure Key Vault](#azure-key-vault)
10+
- [Installation](#installation)
11+
- [Getting all access policies for an Azure Key Vault](#getting-all-access-policies-for-an-azure-key-vault)
12+
- [Setting a secret value from file into Azure Key Vault](#setting-a-secret-value-from-file-into-azure-key-vault)
13+
- [Setting a secret value with BASE64 encoded file-content into Azure Key Vault](#setting-a-secret-value-with-base64-encoded-file-content-into-azure-key-vault)
1214

1315
## Installation
1416

@@ -37,8 +39,8 @@ PS> $accessPolicies = Get-AzKeyVaultAccessPolicies -KeyVaultName "my-key-vault"
3739
```
3840

3941
```powershell
40-
PS> $accessPolicies = Get-AzKeyVaultAccessPolicies -KeyVaultName "my-key-vault" -ResourceGroupName "my-resouce-group"
41-
# Looking for the Azure Key Vault with name 'my-key-vault' in resourcegroup 'my-resource-group'...
42+
PS> $accessPolicies = Get-AzKeyVaultAccessPolicies -KeyVaultName "my-key-vault" -ResourceGroupName "my-resource-group"
43+
# Looking for the Azure Key Vault with name 'my-key-vault' in resource group 'my-resource-group'...
4244
# Found Azure Key Vault 'my-key-vault'
4345
# accessPolicies: {list: [{tenantId: ...,permissions: ...}]}
4446
```

‎docs/preview/02-Features/powershell/azure-logic-apps.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ layout: default
66
# Azure Logic Apps
77

88
This module provides the following capabilities:
9-
- [Disable an Azure Logic App](#disable-an-azure-logic-app)
10-
- [Enable an Azure Logic App](#enable-an-azure-logic-app)
11-
- [Disabling Azure Logic Apps from configuration file](#disabling-azure-logic-apps-from-configuration-file)
12-
- [Enabling Azure Logic Apps from configuration file](#enabling-azure-logic-apps-from-configuration-file)
9+
- [Azure Logic Apps](#azure-logic-apps)
10+
- [Installation](#installation)
11+
- [Disable an Azure Logic App](#disable-an-azure-logic-app)
12+
- [Enable an Azure Logic App](#enable-an-azure-logic-app)
13+
- [Disabling Azure Logic Apps from configuration file](#disabling-azure-logic-apps-from-configuration-file)
14+
- [Enabling Azure Logic Apps from configuration file](#enabling-azure-logic-apps-from-configuration-file)
1315

1416
## Installation
1517

@@ -21,7 +23,7 @@ PS> Install-Module -Name Arcus.Scripting.LogicApps
2123

2224
## Disable an Azure Logic App
2325

24-
Using this script to enabel a specific Azure Logic App.
26+
Using this script to enable a specific Azure Logic App.
2527

2628
| Parameter | Mandatory | Description |
2729
| ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------- |
@@ -170,7 +172,7 @@ PS> Disable-AzLogicAppsFromConfig -DeployFilename "./deploy-orderControl" -Resou
170172
# Executing batch: Protocol Receiver(s)
171173
# ==========================
172174
# > Executing CheckType 'None' for batch 'Protocol Receiver(s)' in resource group 'my-resource-group'"
173-
# Executing Check 'None' => peforming no check and executing stopType
175+
# Executing Check 'None' => performing no check and executing stopType
174176
175177
# > Executing StopType 'Immediate' for Logic App 'rcv-shopping-order-ftp' in resource group 'my-resource-group'
176178
# Attempting to disable rcv-shopping-order-ftp
@@ -219,7 +221,7 @@ PS> Disable-AzLogicAppsFromConfig -DeployFilename "./deploy-orderControl" -Resou
219221
# Executing batch: Protocol Receiver(s)
220222
# ==========================
221223
# > Executing CheckType 'None' for batch 'Protocol Receiver(s)' in resource group 'my-resource-group'"
222-
# Executing Check 'None' => peforming no check and executing stopType
224+
# Executing Check 'None' => performing no check and executing stopType
223225
224226
# > Executing StopType 'Immediate' for Logic App 'la-cod-dev-we-rcv-shopping-order-ftp' in resource group 'my-resource-group'
225227
# Attempting to disable la-cod-dev-we-rcv-shopping-order-ftp

0 commit comments

Comments
 (0)