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

[Automation] Add aaz model for some uncovered commands #391

Merged
merged 6 commits into from
Feb 21, 2024
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
16 changes: 16 additions & 0 deletions Commands/automation/account/_list-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation account list-keys_

Retrieve the automation keys for an account.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9saXN0a2V5cw==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/listkeys 2023-11-01 -->

#### examples

- Retrieve the automation keys
```bash
automation account list-keys --resource-group myResouceGroup --name myAutomationAccount
```
16 changes: 16 additions & 0 deletions Commands/automation/account/_show-linked-workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation account show-linked-workspace_

Get the linked workspace for the account id.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9saW5rZWR3b3Jrc3BhY2U=/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/linkedworkspace 2023-11-01 -->

#### examples

- Get the linked workspace id
```bash
automation account show-linked-workspace --resource-group myResourceGroup --name myAutomationAccount
```
11 changes: 11 additions & 0 deletions Commands/automation/account/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _automation account_

Automation Account.

## Commands

- [list-keys](/Commands/automation/account/_list-keys.md)
: Retrieve the automation keys for an account.

- [show-linked-workspace](/Commands/automation/account/_show-linked-workspace.md)
: Get the linked workspace for the account id.
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration create_

Create the configuration identified by configuration name.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucy97fQ==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations/{} 2023-11-01 -->

#### examples

- Create DSC Configuration that setups a server
```bash
automation configuration create -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {\r\n Node localhost {\r\n WindowsFeature IIS {\r\n Name = "Web-Server";\r\n Ensure = "Present"\r\n }\r\n }\r\n}"
```
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration delete_

Delete the dsc configuration identified by configuration name.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucy97fQ==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations/{} 2023-11-01 -->

#### examples

- Delete the DSC Configuration
```bash
automation configuration list -g rg --automation-account-name myAutomationAccount
```
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration list_

List a list of configurations.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucw==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations 2023-11-01 -->

#### examples

- List all DSC Configurations
```bash
automation configuration list -g rg --automation-account-name myAutomationAccount
```
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_show-content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration show-content_

Get the configuration script identified by configuration name.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucy97fS9jb250ZW50/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations/{}/content 2023-11-01 -->

#### examples

- Show the script content of DSC Configuration
```bash
automation configuration show-content -g rg --automation-account-name myAutomationAccount -n SetupServer
```
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration show_

Get the configuration identified by configuration name.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucy97fQ==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations/{} 2023-11-01 -->

#### examples

- Get the configuration by its name
```bash
automation configuration show -g rg --automation-account-name myAutomationAccount -n SetupServer
```
16 changes: 16 additions & 0 deletions Commands/automation/configuration/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation configuration update_

Update the configuration identified by configuration name.

## Versions

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9jb25maWd1cmF0aW9ucy97fQ==/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/configurations/{} 2023-11-01 -->

#### examples

- Update script in DSC Configuration
```bash
automation configuration update -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {\r\n Node localhostServer {\r\n WindowsFeature IIS {\r\n Name = "Web-Server";\r\n Ensure = "Present"\r\n }\r\n }\r\n}"
```
23 changes: 23 additions & 0 deletions Commands/automation/configuration/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# [Group] _automation configuration_

Manage Dsc Configuration.

## Commands

- [create](/Commands/automation/configuration/_create.md)
: Create the configuration identified by configuration name.

- [delete](/Commands/automation/configuration/_delete.md)
: Delete the dsc configuration identified by configuration name.

- [list](/Commands/automation/configuration/_list.md)
: List a list of configurations.

- [show](/Commands/automation/configuration/_show.md)
: Get the configuration identified by configuration name.

- [show-content](/Commands/automation/configuration/_show-content.md)
: Get the configuration script identified by configuration name.

- [update](/Commands/automation/configuration/_update.md)
: Update the configuration identified by configuration name.
4 changes: 4 additions & 0 deletions Commands/automation/hrwg/hrw/_move.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ Move a hybrid worker to a different group.
### [2022-08-08](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9oeWJyaWRydW5ib29rd29ya2VyZ3JvdXBzL3t9L2h5YnJpZHJ1bmJvb2t3b3JrZXJzL3t9L21vdmU=/2022-08-08.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/hybridrunbookworkergroups/{}/hybridrunbookworkers/{}/move 2022-08-08 -->

### [2023-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9oeWJyaWRydW5ib29rd29ya2VyZ3JvdXBzL3t9L2h5YnJpZHJ1bmJvb2t3b3JrZXJzL3t9L21vdmU=/2023-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/hybridrunbookworkergroups/{}/hybridrunbookworkers/{}/move 2023-11-01 -->
2 changes: 1 addition & 1 deletion Commands/automation/hrwg/hrw/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Group] _automation hrwg hrw_

hrw
Manage Automation Hybrid Runbook Worker.

## Commands

Expand Down
4 changes: 2 additions & 2 deletions Commands/automation/hrwg/readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# [Group] _automation hrwg_

Hrwg
Automation Hybrid Runbook Worker Group.

## Subgroups

- [hrw](/Commands/automation/hrwg/hrw/readme.md)
: hrw
: Manage Automation Hybrid Runbook Worker.

## Commands

Expand Down
8 changes: 8 additions & 0 deletions Commands/automation/node/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _automation node_

Manage Dsc Node.

## Subgroups

- [report](/Commands/automation/node/report/readme.md)
: Manage Dsc node report data.
9 changes: 9 additions & 0 deletions Commands/automation/node/report/_show-content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _automation node report show-content_

Get the Dsc node reports by node id and report id.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ub2Rlcy97fS9yZXBvcnRzL3t9L2NvbnRlbnQ=/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/nodes/{}/reports/{}/content 2023-05-15-preview -->
8 changes: 8 additions & 0 deletions Commands/automation/node/report/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _automation node report_

Manage Dsc node report data.

## Commands

- [show-content](/Commands/automation/node/report/_show-content.md)
: Get the Dsc node reports by node id and report id.
19 changes: 17 additions & 2 deletions Commands/automation/readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# [Group] _automation_

Manage Automation Account
Manage Automation Account.

## Subgroups

- [account](/Commands/automation/account/readme.md)
: Automation Account.

- [configuration](/Commands/automation/configuration/readme.md)
: Manage Dsc Configuration.

- [hrwg](/Commands/automation/hrwg/readme.md)
: Hrwg
: Automation Hybrid Runbook Worker Group.

- [node](/Commands/automation/node/readme.md)
: Manage Dsc Node.

- [python3-package](/Commands/automation/python3-package/readme.md)
: python3-package

- [runtime-environment](/Commands/automation/runtime-environment/readme.md)
: Manage RuntimeEnvironment.

- [source-control](/Commands/automation/source-control/readme.md)
: Manage source control.
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment create_

Create Runtime Environment.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{} 2023-05-15-preview -->

#### examples

- Create Runtime Environment
```bash
automation runtime-environment create -g rg --automation-account-name myAutomationAccount --name rt --location westus2 --language PowerShell --version 7.1 --default-packages "{Az:7.3.2}"
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment delete_

Delete the Runtime Environment.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{} 2023-05-15-preview -->

#### examples

- Delete the Runtime Environment
```bash
automation runtime-environment delete -g rg --automation-account-name myAutomationAccount --name rt -y
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment list_

List a list of RuntimeEnvironments.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRz/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments 2023-05-15-preview -->

#### examples

- List Runtime Environments
```bash
automation runtime-environment list -g rg --automation-account-name myAutomationAccount
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment show_

Get information about the Runtime Environment.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{} 2023-05-15-preview -->

#### examples

- Get information about the Runtime Environment
```bash
automation runtime-environment show -g rg --automation-account-name myAutomationAccount --name rt
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment update_

Update Runtime Environment.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{} 2023-05-15-preview -->

#### examples

- Update Runtime Environment
```bash
automation runtime-environment update -g rg --automation-account-name myAutomationAccount --name rt --default-packages "{Az:8.0.0}"
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/package/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment package create_

Create the package identified by package name.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9L3BhY2thZ2VzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{}/packages/{} 2023-05-15-preview -->

#### examples

- Create Runtime Environment Package
```bash
automation runtime-environment package create -g rg--automation-account-name myAutomationAccount --runtime-environment-name rt --name rt-package --uri https://teststorage.blob.core.windows.net/mycontainer/MyModule.zip --content-version 1.0.0.0
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/package/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment package delete_

Delete the package by name.

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9L3BhY2thZ2VzL3t9/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{}/packages/{} 2023-05-15-preview -->

#### examples

- Delete the package
```bash
automation runtime-environment package delete -g rg --automation-account-name myAutomationAccount --runtime-environment-name rt --name rt-package
```
16 changes: 16 additions & 0 deletions Commands/automation/runtime-environment/package/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _automation runtime-environment package list_

List the a list of Packages

## Versions

### [2023-05-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hdXRvbWF0aW9uL2F1dG9tYXRpb25hY2NvdW50cy97fS9ydW50aW1lZW52aXJvbm1lbnRzL3t9L3BhY2thZ2Vz/2023-05-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.automation/automationaccounts/{}/runtimeenvironments/{}/packages 2023-05-15-preview -->

#### examples

- List packages in Runtime Environment
```bash
automation runtime-environment package list -g rg --automation-account-name myAutomationAccount --runtime-environment-name rt
```
Loading
Loading