|
| 1 | +# -------------------------------------------------------------------------------------------- |
| 2 | +# Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | +# Licensed under the MIT License. See License.txt in the project root for license information. |
| 4 | +# |
| 5 | +# Code generated by aaz-dev-tools |
| 6 | +# -------------------------------------------------------------------------------------------- |
| 7 | + |
| 8 | +# pylint: disable=line-too-long |
| 9 | +# pylint: disable=too-many-lines |
| 10 | + |
| 11 | +from knack.help_files import helps # pylint: disable=unused-import |
| 12 | + |
| 13 | +helps['changesafety'] = """ |
| 14 | + type: group |
| 15 | + short-summary: Manage Change Safety resources. |
| 16 | +""" |
| 17 | + |
| 18 | +helps['changesafety changestate'] = """ |
| 19 | + type: group |
| 20 | + short-summary: Manage ChangeState resources that describe planned changes across targets. |
| 21 | +""" |
| 22 | + |
| 23 | +helps['changesafety changestate create'] = """ |
| 24 | + type: command |
| 25 | + short-summary: Create a ChangeState resource. |
| 26 | + long-summary: > |
| 27 | + Provide at least one target definition to describe which resources or operations the change |
| 28 | + will affect. Targets are expressed as comma or semicolon separated key=value pairs such as |
| 29 | + resourceId=RESOURCE_ID,operation=DELETE. The command is also available through the alias |
| 30 | + `az change-safety change-state`. |
| 31 | + parameters: |
| 32 | + - name: --targets |
| 33 | + short-summary: > |
| 34 | + One or more target definitions expressed as key=value pairs (for example |
| 35 | + resourceId=RESOURCE_ID,operation=CREATE,resourceType=Microsoft.Compute/virtualMachines). |
| 36 | + - name: --change-type |
| 37 | + short-summary: Classify the change such as AppDeployment, Config, ManualTouch, or PolicyDeployment. |
| 38 | + - name: --rollout-type |
| 39 | + short-summary: Specify the rollout urgency (Normal, Hotfix, or Emergency). |
| 40 | + - name: --stage-map |
| 41 | + short-summary: Reference an existing StageMap resource using resource-id=RESOURCE_ID and optional parameters key=value pairs. |
| 42 | + - name: --links |
| 43 | + short-summary: Add supporting links by repeating --links name=NAME uri=URL [description=TEXT]. |
| 44 | + examples: |
| 45 | + - name: Create a change state for a VM rollout |
| 46 | + text: |- |
| 47 | + az changesafety changestate create -g MyResourceGroup -n deploy-001 --change-type AppDeployment --rollout-type Normal --targets resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PUT |
| 48 | + - name: Create with staging rollout configuration |
| 49 | + text: |- |
| 50 | + az changesafety changestate create -g MyResourceGroup -n ops-change-01 --rollout-type Hotfix --targets resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=POST |
| 51 | +""" |
| 52 | + |
| 53 | +helps['changesafety changestate update'] = """ |
| 54 | + type: command |
| 55 | + short-summary: Update an existing ChangeState resource. |
| 56 | + long-summary: > |
| 57 | + Use this command to modify descriptive metadata, rollout settings, or replace targets for an |
| 58 | + existing change. When you pass --targets, the supplied definitions overwrite the previous set. |
| 59 | + This command is also available through the alias `az change-safety change-state`. |
| 60 | + parameters: |
| 61 | + - name: --targets |
| 62 | + short-summary: > |
| 63 | + Optional target definitions to replace the existing list. Provide key=value pairs such as |
| 64 | + resourceId=RESOURCE_ID,operation=DELETE. |
| 65 | + - name: --comments |
| 66 | + short-summary: Provide notes about the latest update to the change state. |
| 67 | + - name: --anticipated-start-time |
| 68 | + short-summary: Update the expected start time in ISO 8601 format. |
| 69 | + - name: --anticipated-end-time |
| 70 | + short-summary: Update the expected completion time in ISO 8601 format. |
| 71 | + examples: |
| 72 | + - name: Adjust rollout type and add a comment |
| 73 | + text: |- |
| 74 | + az changesafety changestate update -g MyResourceGroup -n deploy-001 --rollout-type Emergency --comments "Escalated to emergency rollout" |
| 75 | + - name: Replace the target definition |
| 76 | + text: |- |
| 77 | + az changesafety changestate update -g MyResourceGroup -n deploy-001 --targets resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Sql/servers/myServer,operation=PATCH |
| 78 | +""" |
| 79 | + |
| 80 | +helps['changesafety changestate delete'] = """ |
| 81 | + type: command |
| 82 | + short-summary: Delete a ChangeState resource. |
| 83 | + examples: |
| 84 | + - name: Delete a change state without confirmation |
| 85 | + text: |- |
| 86 | + az changesafety changestate delete -g MyResourceGroup -n deploy-001 --yes |
| 87 | +""" |
| 88 | + |
| 89 | +helps['changesafety changestate show'] = """ |
| 90 | + type: command |
| 91 | + short-summary: Show details for a ChangeState resource. |
| 92 | + examples: |
| 93 | + - name: Show a change state |
| 94 | + text: |- |
| 95 | + az changesafety changestate show -g MyResourceGroup -n deploy-001 |
| 96 | +""" |
0 commit comments