Skip to content

Commit 7c6d1c6

Browse files
CopilotLiliDeng
andauthored
Update documentation for azure_deploy and azure_delete transformer (#3824)
* Update documentation for azure_deploy and azure_delete transformer Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: LiliDeng <10083705+LiliDeng@users.noreply.github.com>
1 parent 9306bf3 commit 7c6d1c6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/run_test/transformers.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,12 @@ type: int
282282

283283
Automatically selects vm_size based on the count provided.
284284

285+
deploy
286+
^^^^^^
287+
type: bool | Default: true
288+
289+
Whether to create a new deployment. If true, creates a new VM deployment. If false, uses existing VMs in the specified resource_group_name.
290+
285291

286292
Use Delete Transformer
287293
~~~~~~~~~~~~~~~~~~~~~~
@@ -295,6 +301,8 @@ Usage
295301
transformer:
296302
- type: azure_delete
297303
resource_group_name: rg_name
304+
keep_environment: "failed"
305+
wait_delete: true
298306
299307
Reference
300308
`````````
@@ -306,6 +314,19 @@ type: string
306314

307315
Name of the resource group that should be deleted.
308316

317+
keep_environment
318+
^^^^^^^^^^^^^^^
319+
320+
type: string | bool | Default: "no"
321+
322+
Whether to keep the environment after deletion. Allowed values: "always", "no", "failed", or True/False.
323+
324+
wait_delete
325+
^^^^^^^^^^
326+
327+
type: bool | Default: false
328+
329+
Whether to wait for the deletion to complete. If set to true, the transformer will wait for the resource group to be fully deleted before proceeding.
309330

310331

311332
Use Vhd Transformer

0 commit comments

Comments
 (0)