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

docs: add versioned module installations #240

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
2 changes: 0 additions & 2 deletions docs/preview/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: /
sidebar_label: Welcome
---

![PowerShell Gallery Version](https://img.shields.io/powershellgallery/v/Arcus.Scripting.All)

# Installation

The Arcus.Scripting modules can be found on the PowerShell gallery.
Expand Down
4 changes: 1 addition & 3 deletions docs/versioned_docs/version-v0.1.3/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ slug: /
sidebar_label: Welcome
---

[![PowerShell Gallery Version](https://img.shields.io/badge/powershell%20gallery-v0.1.3-orange)](https://www.powershellgallery.com/packages/Arcus.Scripting.ARM/0.1.3)

# Installation

The Arcus.Scripting modules can be found on the PowerShell gallery.
Install the latest version of a module by executing the following command:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM -Version 0.1.3
PS> Install-Module -Name Arcus.Scripting.ARM -RequiredVersion 0.1.3
```

For more granular packages we recommend reading the documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM
PS> Install-Module -Name Arcus.Scripting.ARM -RequiredVersion 0.1.3
```

## Injecting content into an ARM template
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ApiManagement
PS> Install-Module -Name Arcus.Scripting.ApiManagement -RequiredVersion 0.1.3
```

## Creating a new API operation in the Azure API Management instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DataFactory
PS> Install-Module -Name Arcus.Scripting.DataFactory -RequiredVersion 0.1.3
```

## Enabling a trigger of an Azure Data Factory pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DevOps
PS> Install-Module -Name Arcus.Scripting.DevOps -RequiredVersion 0.1.3
```

## Setting a variable in an Azure DevOps pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.KeyVault
PS> Install-Module -Name Arcus.Scripting.KeyVault -RequiredVersion 0.1.3
```

## Getting all access policies for an Azure Key Vault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Table
PS> Install-Module -Name Arcus.Scripting.Storage.Table -RequiredVersion 0.1.3
```

## Creating a new table in an Azure Storage Account
Expand Down
2 changes: 0 additions & 2 deletions docs/versioned_docs/version-v0.2/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ slug: /
sidebar_label: Welcome
---

[![PowerShell Gallery Version](https://img.shields.io/badge/powershell%20gallery-v0.2.0-orange)](https://www.powershellgallery.com/packages/Arcus.Scripting.ARM/0.2.0)

# Installation

The Arcus.Scripting modules can be found on the PowerShell gallery.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM
PS> Install-Module -Name Arcus.Scripting.ARM --RequiredVersion 0.2.0
```

## Injecting content into an ARM template
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ApiManagement
PS> Install-Module -Name Arcus.Scripting.ApiManagement --RequiredVersion 0.2.0
```

## Backing up an API Management service
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DataFactory
PS> Install-Module -Name Arcus.Scripting.DataFactory --RequiredVersion 0.2.0
```

## Enabling a trigger of an Azure Data Factory pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DevOps
PS> Install-Module -Name Arcus.Scripting.DevOps --RequiredVersion 0.2.0
```

## Setting a variable in an Azure DevOps pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.KeyVault
PS> Install-Module -Name Arcus.Scripting.KeyVault --RequiredVersion 0.2.0
```

## Getting all access policies for an Azure Key Vault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.LogicApps
PS> Install-Module -Name Arcus.Scripting.LogicApps --RequiredVersion 0.2.0
```

## Disabling Azure Logic Apps from configuration file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Table
PS> Install-Module -Name Arcus.Scripting.Storage.Table --RequiredVersion 0.2.0
```

## Creating a new table in an Azure Storage Account
Expand Down
4 changes: 1 addition & 3 deletions docs/versioned_docs/version-v0.3/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ slug: /
sidebar_label: Welcome
---

[![PowerShell Gallery Version](https://img.shields.io/badge/powershell%20gallery-v0.3.0-orange)](https://www.powershellgallery.com/packages/Arcus.Scripting.ARM/0.3.0)

# Installation

The Arcus.Scripting modules can be found on the PowerShell gallery.
Install the latest version of a module by executing the following command:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM -Version 0.3.0
PS> Install-Module -Name Arcus.Scripting.ARM -RequiredVersion 0.3.0
```

For more granular packages we recommend reading the documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM
PS> Install-Module -Name Arcus.Scripting.ARM -RequiredVersion 0.3.0
```

## Injecting content into an ARM template
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ApiManagement
PS> Install-Module -Name Arcus.Scripting.ApiManagement -RequiredVersion 0.3.0
```

## Backing up an API Management service
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DataFactory
PS> Install-Module -Name Arcus.Scripting.DataFactory -RequiredVersion 0.3.0
```

## Enabling a trigger of an Azure Data Factory pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DevOps
PS> Install-Module -Name Arcus.Scripting.DevOps -RequiredVersion 0.3.0
```

## Setting a variable in an Azure DevOps pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.KeyVault
PS> Install-Module -Name Arcus.Scripting.KeyVault -RequiredVersion 0.3.0
```

## Getting all access policies for an Azure Key Vault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.LogicApps
PS> Install-Module -Name Arcus.Scripting.LogicApps -RequiredVersion 0.3.0
```

## Disable an Azure Logic App
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Import-Module -Name Arcus.Scripting.Security
PS> Import-Module -Name Arcus.Scripting.Security -RequiredVersion 0.3.0
```

## Removing resource locks from an Azure resource group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Blob
PS> Install-Module -Name Arcus.Scripting.Storage.Blob -RequiredVersion 0.3.0
```

## Uploading files to a Azure Storage Blob container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.FileShare
PS> Install-Module -Name Arcus.Scripting.Storage.FileShare -RequiredVersion 0.3.0
```

## Creating a folder on an Azure file share
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Table
PS> Install-Module -Name Arcus.Scripting.Storage.Table -RequiredVersion 0.3.0
```

## Creating a new table in an Azure Storage Account
Expand Down
4 changes: 1 addition & 3 deletions docs/versioned_docs/version-v0.4.3/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ slug: /
sidebar_label: Welcome
---

[![PowerShell Gallery Version](https://img.shields.io/badge/powershell%20gallery-v0.4.3-orange)](https://www.powershellgallery.com/packages/Arcus.Scripting.All/0.4.3)

# Installation

The Arcus.Scripting modules can be found on the PowerShell gallery.
Install the latest version of a module by executing the following command:

```powershell
PS> Install-Module -Name Arcus.Scripting.All --Version 0.4.3
PS> Install-Module -Name Arcus.Scripting.All -RequiredVersion 0.4.3
```

For more granular packages we recommend reading the documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ARM
PS> Install-Module -Name Arcus.Scripting.ARM -RequiredVersion 0.4.3
```

## Injecting content into an ARM template
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.ApiManagement
PS> Install-Module -Name Arcus.Scripting.ApiManagement -RequiredVersion 0.4.3
```

## Backing up an API Management service
Expand Down Expand Up @@ -239,4 +239,4 @@ PS> Upload-AzApiManagementSystemCertificate -ResourceGroupName "ContosoGroup" -N
# Loaded public CA certificate 'C:\contoso\certificates\privateCa.cer'
# Retrieved Azure API Management service 'ContosoApi' instance
# Uploaded public CA certificate 'C:\contoso\certificates\privateCa.cer' into Azure API Management 'ContosoApi'
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DataFactory
PS> Install-Module -Name Arcus.Scripting.DataFactory -RequiredVersion 0.4.3
```

## Enabling a trigger of an Azure Data Factory pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ layout: default
# Azure DevOps

This module provides the following capabilities:
- [Installation](#installation)
- [Setting a variable in an Azure DevOps pipeline](#setting-a-variable-in-an-azure-devops-pipeline)
- [Setting ARM outputs to Azure DevOps variable group](#setting-arm-outputs-to-azure-devops-variable-group)
- [Setting ARM outputs to Azure DevOps pipeline variables](#setting-arm-outputs-to-azure-devops-pipeline-variables)
Expand All @@ -16,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.DevOps
PS> Install-Module -Name Arcus.Scripting.DevOps -RequiredVersion 0.4.3
```

## Setting a variable in an Azure DevOps pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.KeyVault
PS> Install-Module -Name Arcus.Scripting.KeyVault -RequiredVersion 0.4.3
```

## Getting all access policies for an Azure Key Vault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.LogicApps
PS> Install-Module -Name Arcus.Scripting.LogicApps -RequiredVersion 0.4.3
```

## Disable an Azure Logic App
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Import-Module -Name Arcus.Scripting.Security
PS> Import-Module -Name Arcus.Scripting.Security -RequiredVersion 0.4.3
```

## Removing resource locks from an Azure resource group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.SQL
PS> Install-Module -Name Arcus.Scripting.SQL -RequiredVersion 0.4.3
```

## Invoke a database migration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module contains several sub-modules, all related to Azure Storage.
Install all Azure Storage-related modules at once via:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.All
PS> Install-Module -Name Arcus.Scripting.Storage.All -RequiredVersion 0.4.3
```

## Azure Table Storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Blob
PS> Install-Module -Name Arcus.Scripting.Storage.Blob -RequiredVersion 0.4.3
```

## Uploading files to a Azure Storage Blob container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.FileShare
PS> Install-Module -Name Arcus.Scripting.Storage.FileShare -RequiredVersion 0.4.3
```

## Creating a folder on an Azure file share
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module provides the following capabilities:
To have access to the following features, you have to import the module:

```powershell
PS> Install-Module -Name Arcus.Scripting.Storage.Table
PS> Install-Module -Name Arcus.Scripting.Storage.Table -RequiredVersion 0.4.3
```

## Creating a new table in an Azure Storage Account
Expand Down
Loading