Skip to content

Commit 05c84bd

Browse files
stijnmoreelsstijnmoreels
authored
docs(sidebar): simplify ps module sidebar exposure (#466)
1 parent 78ff689 commit 05c84bd

20 files changed

Lines changed: 847 additions & 821 deletions

‎docs/docusaurus.config.js‎

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,36 @@ module.exports = {
1414
themeConfig: {
1515
image: 'img/arcus.jpg',
1616
navbar: {
17-
title: 'Scripting',
17+
title: '',
1818
logo: {
1919
alt: 'Arcus',
2020
src: 'img/arcus.png',
2121
srcDark: 'img/arcus_for_dark.png',
2222
},
2323
items: [
24+
{
25+
type: 'dropdown',
26+
label: 'Arcus Scripting',
27+
position: 'left',
28+
items: [
29+
{
30+
label: 'Arcus Messaging',
31+
href: 'https://messaging.arcus-azure.net/'
32+
},
33+
{
34+
label: 'Arcus Observability',
35+
href: 'https://observability.arcus-azure.net/'
36+
},
37+
{
38+
label: 'Arcus Testing',
39+
href: 'https://testing.arcus-azure.net/'
40+
},
41+
{
42+
label: 'Arcus Security',
43+
href: 'https://security.arcus-azure.net/',
44+
}
45+
]
46+
},
2447
{
2548
type: 'docsVersionDropdown',
2649

@@ -50,11 +73,31 @@ module.exports = {
5073
title: 'Community',
5174
items: [
5275
{
53-
label: 'Arcus Azure Github',
76+
label: 'GitHub',
5477
href: 'https://github.com/arcus-azure',
5578
},
79+
{
80+
label: 'Contribution guide',
81+
href: 'https://github.com/arcus-azure/.github/blob/main/CONTRIBUTING.md'
82+
},
83+
{
84+
label: 'Report an issue',
85+
href: 'https://github.com/arcus-azure/arcus.messaging/issues/new/choose'
86+
},
87+
{
88+
label: 'Discuss an idea',
89+
href: 'https://github.com/arcus-azure/arcus.messaging/discussions/new/choose'
90+
}
5691
],
5792
},
93+
{
94+
title: 'Features',
95+
96+
},
97+
{
98+
title: 'Support',
99+
100+
}
58101
],
59102
copyright: `Copyright © ${new Date().getFullYear()}, Arcus - Scripting maintained by arcus-azure`,
60103
},
@@ -76,7 +119,7 @@ module.exports = {
76119
// Please change this to your repo.
77120
editUrl:
78121
'https://github.com/arcus-azure/arcus.scripting/edit/main/docs',
79-
includeCurrentVersion:process.env.CONTEXT !== 'production',
122+
includeCurrentVersion: process.env.CONTEXT !== 'production',
80123
},
81124
theme: {
82125
customCss: require.resolve('./src/css/custom.css'),

‎docs/preview/03-Features/powershell/_category_.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
label: 'Azure'
2+
collapsible: true
3+
collapsed: true

‎docs/preview/03-Features/powershell/azure-active-directory.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "Azure Active Directory"
2+
title: "Microsoft Entra ID"
33
layout: default
44
---
55

6-
# Azure Active Directory
6+
# Microsoft Entra ID
77

88
## Installation
99

@@ -13,9 +13,9 @@ To have access to the following features, you have to import the module:
1313
PS> Install-Module -Name Arcus.Scripting.ActiveDirectory
1414
```
1515

16-
## Access Rights to Azure Active Directory
16+
## Access Rights to Microsoft Entra ID
1717

18-
To interact with Azure Active Directory these scripts use the [Microsoft.Graph.Applications](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.applications/) module, import this module:
18+
To interact with Microsoft Entra ID these scripts use the [Microsoft.Graph.Applications](https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.applications/) module, import this module:
1919

2020
```powershell
2121
PS> Install-Module -Name Microsoft.Graph.Applications
@@ -27,14 +27,14 @@ After importing this module, make sure you are connected to Microsoft Graph with
2727
PS> Connect-MgGraph -Scopes "Application.ReadWrite.All,AppRoleAssignment.ReadWrite.All"
2828
```
2929

30-
## Listing the Roles and Role Assignments for an Azure Active Directory Application
30+
## Listing the Roles and Role Assignments for an Microsoft Entra ID Application
3131

32-
Lists the roles and role assignments for an Azure Active Directory Application.
32+
Lists the roles and role assignments for an Microsoft Entra ID Application.
3333

34-
| Parameter | Mandatory | Description |
35-
| ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
36-
| `ClientId` | yes | The client ID of the Azure Active Directory Application Registration for which the roles and assignments are retrieved. |
37-
| `RolesAssignedToClientId` | no | The client ID of the Azure Active Directory Application Registration to which roles have been assigned, used when you only want to retrieve the assignments for this specific application. |
34+
| Parameter | Mandatory | Description |
35+
| ------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36+
| `ClientId` | yes | The client ID of the Microsoft Entra ID Application Registration for which the roles and assignments are retrieved. |
37+
| `RolesAssignedToClientId` | no | The client ID of the Microsoft Entra ID Application Registration to which roles have been assigned, used when you only want to retrieve the assignments for this specific application. |
3838

3939
**Example**
4040

@@ -62,15 +62,15 @@ PS> List-AzADAppRoleAssignments `
6262
#Role 'SecondRole' is assigned to the Active Directory Application 'client-application-one' with id '6ea09bbd-c21c-460c-b58a-f4a720f51826'
6363
```
6464

65-
## Add a Role and Assignment for an Azure Active Directory Application
65+
## Add a Role and Assignment for an Microsoft Entra ID Application
6666

67-
Adds a role assignment for an Azure Active Directory Application. The role will be added to the Azure Active Directory Application Registration defined by the `ClientId` parameter, and a role assignment for this role will be added to the Azure Active Directory Application Registration defined by the `AssignRoleToClientId` parameter.
67+
Adds a role assignment for an Microsoft Entra ID Application. The role will be added to the Microsoft Entra ID Application Registration defined by the `ClientId` parameter, and a role assignment for this role will be added to the Microsoft Entra ID Application Registration defined by the `AssignRoleToClientId` parameter.
6868

69-
| Parameter | Mandatory | Description |
70-
| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
71-
| `ClientId` | yes | The client ID of the Azure Active Directory Application Registration to which the role will be added if not present. |
72-
| `Role` | yes | The name of the role. |
73-
| `AssignRoleToClientId` | yes | The client ID of the Azure Active Directory Application Registration for which the role assignment will be created. The role assignment will be created based on the role added to the Azure Active Directory Application Registration defined by the `ClientId`. |
69+
| Parameter | Mandatory | Description |
70+
| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
71+
| `ClientId` | yes | The client ID of the Microsoft Entra ID Application Registration to which the role will be added if not present. |
72+
| `Role` | yes | The name of the role. |
73+
| `AssignRoleToClientId` | yes | The client ID of the Microsoft Entra ID Application Registration for which the role assignment will be created. The role assignment will be created based on the role added to the Microsoft Entra ID Application Registration defined by the `ClientId`. |
7474

7575
**Example**
7676

@@ -84,16 +84,16 @@ PS> Add-AzADAppRoleAssignment `
8484
#Role Assignment for the role 'DummyRole' added to the Active Directory Application 'client-application-one'
8585
```
8686

87-
## Remove a Role and Assignment from an Azure Active Directory Application
87+
## Remove a Role and Assignment from an Microsoft Entra ID Application
8888

89-
Removes a role assignment for an Azure Active Directory Application.
89+
Removes a role assignment for an Microsoft Entra ID Application.
9090

91-
| Parameter | Mandatory | Description |
92-
| ---------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93-
| `ClientId` | yes | The client ID of the Azure Active Directory Application Registration containing the role for which the assignment must be removed. |
94-
| `Role` | yes | The name of the role. |
95-
| `RemoveRoleFromClientId` | yes | The client ID of the Azure Active Directory Application Registration for which the role assignment will be removed. |
96-
| `RemoveRoleIfNoAssignmentsAreLeft` | no | Indicate whether to remove the role from the Azure Active Directory Application Registration defined by the `ClientId` parameter when no more role assignments remain for the role. |
91+
| Parameter | Mandatory | Description |
92+
| ---------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93+
| `ClientId` | yes | The client ID of the Microsoft Entra ID Application Registration containing the role for which the assignment must be removed. |
94+
| `Role` | yes | The name of the role. |
95+
| `RemoveRoleFromClientId` | yes | The client ID of the Microsoft Entra ID Application Registration for which the role assignment will be removed. |
96+
| `RemoveRoleIfNoAssignmentsAreLeft` | no | Indicate whether to remove the role from the Microsoft Entra ID Application Registration defined by the `ClientId` parameter when no more role assignments remain for the role. |
9797

9898
**Example**
9999

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Azure API Management"
2+
title: "API Management"
33
layout: default
44
---
55

@@ -108,7 +108,7 @@ Sign-up or invite a new user in an existing Azure API Management instance.
108108
| `UserId` | no | The UserId that will be used to create the user |
109109
| `Password` | no | The password that the user will be able to login with |
110110
| `Note` | no | A note that will be added to the user |
111-
| `SendNotification` | no | Whether or not a notification will be sent to the email address of the user |
111+
| `SendNotification` | no | Whether or not a notification will be sent to the email address of the user |
112112
| `ConfirmationType` | no | The confirmation type that will be used when creating the user, this can be `invite` (default) or `signup` |
113113
| `ApiVersion` | no | The version of the management API to be used. (default: `2021-08-01`) |
114114
| `SubscriptionId` | no | The Id of the subscription containing the Azure API Management instance. When not provided, it will be retrieved from the current context (Get-AzContext). |
@@ -459,12 +459,12 @@ PS> Import-AzApiManagementProductPolicy `
459459

460460
Imports a base-policy from a file to an API in Azure API Management.
461461

462-
| Parameter | Mandatory | Description |
463-
| ------------------- | --------- | ---------------------------------------------------------------- |
464-
| `ResourceGroupName` | yes | The resource group containing the Azure API Management instance |
465-
| `ServiceName` | yes | The name of the Azure API Management instance located in Azure |
466-
| `ApiId` | yes | The ID to identify the API running in Azure API Management |
467-
| `PolicyFilePath` | yes | The path to the file containing the to-be-imported policy |
462+
| Parameter | Mandatory | Description |
463+
| ------------------- | --------- | --------------------------------------------------------------- |
464+
| `ResourceGroupName` | yes | The resource group containing the Azure API Management instance |
465+
| `ServiceName` | yes | The name of the Azure API Management instance located in Azure |
466+
| `ApiId` | yes | The ID to identify the API running in Azure API Management |
467+
| `PolicyFilePath` | yes | The path to the file containing the to-be-imported policy |
468468

469469
```powershell
470470
PS> Import-AzApiManagementApiPolicy `
@@ -485,7 +485,7 @@ Imports a policy from a file to an API operation in Azure API Management.
485485
| `ServiceName` | yes | The name of the Azure API Management service located in Azure |
486486
| `ApiId` | yes | The ID to identify the API running in Azure API Management |
487487
| `OperationId` | yes | The ID to identify the operation for which to import the policy |
488-
| `PolicyFilePath` | yes | The path to the file containing the to-be-imported policy |
488+
| `PolicyFilePath` | yes | The path to the file containing the to-be-imported policy |
489489

490490
```powershell
491491
PS> Import-AzApiManagementOperationPolicy `
@@ -582,12 +582,12 @@ PS> Set-AzApiManagementApiSubscriptionKey `
582582

583583
Uploads a private certificate to the Azure API Management certificate store, allowing authentication against backend services.
584584

585-
| Parameter | Mandatory | Description |
586-
| --------------------- | --------- | --------------------------------------------------------------------------------------------- |
587-
| `ResourceGroupName` | yes | The resource group containing the Azure API Management instance |
588-
| `ServiceName` | yes | The name of the Azure API Management instance |
589-
| `CertificateFilePath` | yes | The full file path to the location of the private certificate |
590-
| `CertificatePassword` | yes | The password for the private certificate |
585+
| Parameter | Mandatory | Description |
586+
| --------------------- | --------- | --------------------------------------------------------------- |
587+
| `ResourceGroupName` | yes | The resource group containing the Azure API Management instance |
588+
| `ServiceName` | yes | The name of the Azure API Management instance |
589+
| `CertificateFilePath` | yes | The full file path to the location of the private certificate |
590+
| `CertificatePassword` | yes | The password for the private certificate |
591591

592592
**Example**
593593

0 commit comments

Comments
 (0)