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.

Sign up for GitHub

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

Refine doc for azure_deploy transformer #3622

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refine doc for azure_deploy transformer #3622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion docs/run_test/transformers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Usage

transformer:
- type: azure_deploy
name: custom_name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be introduced in a general section, not for one of transformer.

resource_group_name: rg_name
requirement:
azure:
Expand All @@ -190,6 +191,16 @@ Usage

Outputs
````````
When the `name` parameter is specified, the outputs are prefixed with the given name:

- custom_name_address
- custom_name_port
- custom_name_username
- custom_name_password
- custom_name_private_key_file

If the `name` parameter is omitted, the default prefix is `azure_deploy`:

- azure_deploy_address
- azure_deploy_port
- azure_deploy_username
Expand All @@ -202,7 +213,7 @@ Reference
resource_group_name
^^^^^^^^^^^^^^^^^^^

type: string
type: string

Name of the resource group in which VM should be deployed. Creates a new RG if not specified.

Expand Down
Loading