diff --git a/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py b/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py index b4c9bade2fa..07f0696e6ba 100644 --- a/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py +++ b/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py @@ -506,7 +506,7 @@ examples: - name: List default host name and state for all web apps. text: > - az webapp list --query "[].{ hostName: defaultHostName, state: state }" + az webapp list --query "[].{hostName: defaultHostName, state: state}" - name: List all running web apps. text: > az webapp list --query "[?state=='Running']" @@ -558,7 +558,7 @@ examples: - name: List default host name and state for all function apps. text: > - az functionapp list --query "[].{ hostName: defaultHostName, state: state }" + az functionapp list --query "[].{hostName: defaultHostName, state: state}" - name: List all running function apps. text: > az functionapp list --query "[?state=='Running']" diff --git a/src/command_modules/azure-cli-dla/HISTORY.rst b/src/command_modules/azure-cli-dla/HISTORY.rst index 4cc3ebe0d16..72c49fe6254 100644 --- a/src/command_modules/azure-cli-dla/HISTORY.rst +++ b/src/command_modules/azure-cli-dla/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +0.0.17 +++++++ +* Update helpfile + 0.0.16 ++++++ * Update for CLI core changes. diff --git a/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py b/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py index 96b497226ff..e5af61484ec 100644 --- a/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py +++ b/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py @@ -25,7 +25,7 @@ short-summary: Name for the submitted job. - name: --script type: string - short-summary: Script to submit. This may be an @{file} to load from a file. + short-summary: Script to submit. This may be '@{file}' to load from a file. - name: --runtime-version short-summary: The runtime version to use. long-summary: This parameter is used for explicitly overwriting the default runtime. It should only be done if you know what you are doing. diff --git a/src/command_modules/azure-cli-dla/setup.py b/src/command_modules/azure-cli-dla/setup.py index 50ebef97474..872d13f0998 100644 --- a/src/command_modules/azure-cli-dla/setup.py +++ b/src/command_modules/azure-cli-dla/setup.py @@ -16,7 +16,7 @@ cmdclass = {} -VERSION = "0.0.16" +VERSION = "0.0.17" # The full list of classifiers is available at # https://pypi.python.org/pypi?%3Aaction=list_classifiers CLASSIFIERS = [ diff --git a/src/command_modules/azure-cli-lab/HISTORY.rst b/src/command_modules/azure-cli-lab/HISTORY.rst index 23255d6f908..ca13a8095aa 100644 --- a/src/command_modules/azure-cli-lab/HISTORY.rst +++ b/src/command_modules/azure-cli-lab/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +0.0.15 +++++++ +* Update helpfile + 0.0.14 ++++++ * Update for CLI core changes. diff --git a/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py b/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py index ef34915c1de..d623d3395cd 100644 --- a/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py +++ b/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py @@ -55,10 +55,10 @@ short-summary: 'Type of IP configuration to use for the VM. Allowed values are: shared, public, private.' long-summary: If omitted, will be selected based on the VM's vnet. - name: --artifacts - short-summary: JSON encoded array of artifacts to be applied. Use @{file} to load from a file. + short-summary: JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file. - name: --tags short-summary: Space separated tags in `key[=value]` format. - long-summary: Tags may be cleared by assigning the empty value `""` to them. + long-summary: Tags may be cleared by assigning the empty value "" to them. - name: --allow-claim short-summary: Flag indicating if the VM should be created as claimable. - name: --disk-type @@ -70,25 +70,25 @@ examples: - name: Create a VM in the lab from a gallery image. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 - name: Create a VM in the lab from a gallery image with SSH authentication. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --authentication-type ssh + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --authentication-type ssh - name: Create a claimable VM in the lab from a gallery image with password authentication. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --allow-claim + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --allow-claim - name: Create a windows VM in the lab from a gallery image with password authentication. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Windows Server 2008 R2 SP1" --image-type gallery --size Standard_DS1_v2 + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Windows Server 2008 R2 SP1" --image-type gallery --size Standard_DS1_v2 - name: Create a VM in the lab from a custom image. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "jenkins_custom" --image-type custom --size Standard_DS1_v2 + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "jenkins_custom" --image-type custom --size Standard_DS1_v2 - name: Create a VM in the lab with a public IP. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --ip-configuration public + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --ip-configuration public - name: Create a VM from a formula. text: > - az lab vm create --lab-name MyLab -g MyRG --name MyVM --formula MyFormula --artifacts @/artifacts.json + az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --formula MyFormula --artifacts '@artifacts.json' """ helps['lab vm list'] = """ type: command @@ -124,7 +124,7 @@ - name: --name -n short-summary: Name of the virtual machine. - name: --artifacts - short-summary: JSON encoded array of artifacts to be applied. Use @{file} to load from a file. + short-summary: JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file. """ helps['lab vm claim'] = """ type: command @@ -141,15 +141,15 @@ examples: - name: Claim any available virtual machine in the lab. text: > - az lab vm claim -g MyRG --lab-name MyLab + az lab vm claim -g {ResourceGroup} --lab-name {LabName} - name: Claim a specific virtual machine in the lab. text: > - az lab vm claim -g MyRG --lab-name MyLab --name MyVM - - name: Claim multiple virtual machines in the lab using `--ids`. + az lab vm claim -g {ResourceGroup} --lab-name {LabName} --name {VMName} + - name: Claim multiple virtual machines in the lab by IDs. text: | az lab vm claim --ids \\ - /subscriptions/{SubID}/resourcegroups/{MyRG}/providers/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM1} \\ - /subscriptions/{SubID}/resourcegroups/{MyRG}/providers/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM2} + /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName1} \\ + /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName2} """ helps['lab custom-image'] = """ type: group @@ -175,13 +175,13 @@ short-summary: The current state of the virtual machine. long-summary: > For Windows virtual machines: NonSysprepped, SysprepRequested, SysprepApplied - For Linux virtual machines - NonDeprovisioned, DeprovisionRequested, DeprovisionApplied + For Linux virtual machines: NonDeprovisioned, DeprovisionRequested, DeprovisionApplied examples: - name: Create a custom image in the lab from a running Windows virtual machine without applying sysprep. text: | - az lab custom-image create --lab-name MyLab -g MyRG --name MyVM \\ + az lab custom-image create --lab-name {LabName} -g {ResourceGroup} --name {VMName} \\ --os-type Windows --os-state NonSysprepped \\ - --source-vm-id "/subscriptions/{SubID}/resourcegroups/{MyRG}/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM}" + --source-vm-id "/subscriptions/{SubID}/resourcegroups/{ResourceGroup}/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName}" """ helps['lab gallery-image'] = """ type: group @@ -276,7 +276,7 @@ populator-commands: - az lab artifact-source list - name: --parameters - short-summary: JSON encoded list of parameters. Use @{file} to load from a file. + short-summary: JSON encoded list of parameters. Use '@{file}' to load from a file. - name: --tags short-summary: The tags for the resource. """ diff --git a/src/command_modules/azure-cli-lab/setup.py b/src/command_modules/azure-cli-lab/setup.py index e3870855bdc..a7f124538bb 100644 --- a/src/command_modules/azure-cli-lab/setup.py +++ b/src/command_modules/azure-cli-lab/setup.py @@ -12,7 +12,7 @@ logger.warn("Wheel is not available, disabling bdist_wheel hook") cmdclass = {} -VERSION = "0.0.14" +VERSION = "0.0.15" CLASSIFIERS = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', diff --git a/src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_help.py b/src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_help.py index e0c674febdb..b6bc981b348 100644 --- a/src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_help.py +++ b/src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_help.py @@ -44,14 +44,14 @@ examples: - name: Create a high CPU usage alert on a VM with no actions. text: > - az monitor alert create -n rule1 -g {RG} --target {VM ID} --condition "Percentage CPU > 90 avg 5m" + az monitor alert create -n rule1 -g {ResourceGroup} --target {VirtualMachineID} --condition "Percentage CPU > 90 avg 5m" - name: Create a high CPU usage alert on a VM with email and webhook actions. text: | - az monitor alert create -n rule1 -g {RG} --target {VM ID} \\ + az monitor alert create -n rule1 -g {ResourceGroup} --target {VirtualMachineID} \\ --condition "Percentage CPU > 90 avg 5m" \\ --action email bob@contoso.com ann@contoso.com --email-service-owners \\ --action webhook https://www.contoso.com/alerts?type=HighCPU \\ - --action webhook https://alerts.contoso.com apiKey={KEY} type=HighCPU + --action webhook https://alerts.contoso.com apiKey={APIKey} type=HighCPU """ helps['monitor alert update'] = """ @@ -141,15 +141,18 @@ short-summary: The interval of the metric query. In ISO 8601 duration format, eg "PT1M" - name: --start-time type: string - short-summary: The start time of the query. In ISO format with explicit indication of timezone, - 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500. Defaults to 1 Hour prior to the current time. + short-summary: > + The start time of the query. In ISO format with explicit indication of timezone, 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500. + Defaults to 1 Hour prior to the current time. - name: --end-time type: string - short-summary: The end time of the query. In ISO format with explicit indication of timezone, - 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500. Defaults to current time. + short-summary: > + The end time of the query. In ISO format with explicit indication of timezone, 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500. + Defaults to the current time. - name: --filter type: string short-summary: A string used to reduce the set of metric data returned. eg. "BlobType eq '*'" + long-summary: 'For a full list of filters, see the filter string reference at https://docs.microsoft.com/en-us/rest/api/monitor/metrics/list' - name: --metadata short-summary: Returns the metadata values instead of metric data - name: --dimension @@ -158,32 +161,31 @@ examples: - name: List a VM's CPU usage for the past hour text: > - az monitor metrics list --resource --metric "Percentage CPU" + az monitor metrics list --resource {ResourceName} --metric "Percentage CPU" - name: List success E2E latency of a storage account and split the data series based on API name text: > - az monitor metrics list --resource --metric SuccessE2ELatency \\ + az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \\ --dimension ApiName - name: List success E2E latency of a storage account and split the data series based on both API name and geo type text: > - az monitor metrics list --resource --metric SuccessE2ELatency \\ + az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \\ --dimension ApiName GeoType - name: List success E2E latency of a storage account and split the data series based on both API name and geo type using "--filter" parameter text: > - az monitor metrics list --resource --metric SuccessE2ELatency \\ + az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \\ --filter "ApiName eq '*' and GeoType eq '*'" - name: List success E2E latency of a storage account and split the data series based on both API name and geo type. Limits the api name to 'DeleteContainer' text: > - az monitor metrics list --resource --metric SuccessE2ELatency \\ + az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \\ --filter "ApiName eq 'DeleteContainer' and GeoType eq '*'" - Filter string reference: https://docs.microsoft.com/en-us/rest/api/monitor/metrics/list - name: List transactions of a storage account per day since 2017-01-01 text: > - az monitor metrics list --resource --metric Transactions \\ + az monitor metrics list --resource {ResourceName} --metric Transactions \\ --start-time 2017-01-01T00:00:00Z \\ --interval PT24H - name: List the metadata values for a storage account under transaction metric's api name dimension since 2017 text: > - az monitor metrics list --resource --metric Transactions \\ + az monitor metrics list --resource {ResourceName} --metric Transactions \\ --filter "ApiName eq '*'" \\ --start-time 2017-01-01T00:00:00Z """ @@ -226,10 +228,13 @@ the service instead of a full resource ID is given. - name: --logs type: string - short-summary: JSON encoded list of logs settings. Use @{file} to load from a file. + short-summary: JSON encoded list of logs settings. Use '@{file}' to load from a file. + - name: --event-hub-name + type: string + short-summary: The name of the event hub. If none is specified, the default event hub will be selected. - name: --metrics type: string - short-summary: JSON encoded list of metric settings. Use @{file} to load from a file. + short-summary: JSON encoded list of metric settings. Use '@{file}' to load from a file. - name: --storage-account type: string short-summary: Name or ID of the storage account to send diagnostic logs to. @@ -242,6 +247,8 @@ selected. - name: --event-hub-rule short-summary: The resource Id for the event hub authorization rule + - name: --tags + short-summary: Space separated tags in 'key[=value]' format. Use the "" value to clear existing tags. """ helps['monitor diagnostic-settings update'] = """ type: command @@ -272,8 +279,9 @@ parameters: - name: --resource-group -g type: string - short-summary: Name of the resource group under which the action groups are being listed. If it is omitted, - all the action groups under the current subscription are listed. + short-summary: > + Name of the resource group under which the action groups are being listed. If it is omitted, all the action groups under + the current subscription are listed. """ helps['monitor action-group show'] = """ @@ -339,46 +347,46 @@ - name: --name -n short-summary: Name of the activity log alerts - name: --scope -s - short-summary: A list of string that will be used as prefixes. The alert will only apply to activityLogs - with resourceIds that fall under one of these prefixes. If not provided, the path to this - resource group will be used. + short-summary: A list of strings that will be used as prefixes. + long-summary: > + The alert will only apply to activity logs with resourceIDs that fall under one of these prefixes. + If not provided, the path to the resource group will be used. - name: --disable short-summary: Disable the activity log alert after it is created. - name: --description short-summary: A description of this activity log alert - name: --condition -c - short-summary: A condition expression represents the condition that will cause the alert to activate. The - format is FIELD=VALUE[ and FILED=VALUE...]. The possible values for the field are 'resourceId', - 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', - 'subStatus', 'resourceType', or anything beginning with 'properties.'. + short-summary: The condition that will cause the alert to activate. The format is FIELD=VALUE[ and FIELD=VALUE...]. + long-summary: > + The possible values for the field are 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', + 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'. - name: --action-group -a - short-summary: Add action group. Accept space separated action groups identifiers. The identify can be the - action group's name or its resource id. + short-summary: > + Add an action group. Accepts space separated action group identifiers. The identifier can be the action group's name + or its resource ID. - name: --webhook-properties -w - short-summary: Space separated web hook properties in 'key[=value]' format. These properties will be - associated with the action groups added in this command. For any webhook receiver in these - action group, these data are appended to the webhook payload. To attach different webhook - properties to different action groups, add the action groups in separate update-action - commands. + short-summary: > + Space separated webhook properties in 'key[=value]' format. These properties are associated with the action groups + added in this command. + long-summary: > + For any webhook receiver in these action group, this data is appended to the webhook payload. To attach different webhook + properties to different action groups, add the action groups in separate update-action commands. examples: - name: Create an alert with default settings. text: > - az monitor activity-log alert create -n {ALERT_NAME} -g {RG} - + az monitor activity-log alert create -n {AlertName} -g {ResourceGroup} - name: Create an alert with condition about error level service health log. text: > - az monitor activity-log alert create -n {ALERT_NAME} -g {RG} \\ + az monitor activity-log alert create -n {AlertName} -g {ResourceGroup} \\ --condition category=ServiceHealth and level=Error - - name: Create an alert with an action group and specify webhook properties. text: > - az monitor activity-log alert create -n {ALERT_NAME} -g {RG} \\ - -a /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/microsoft.insights/actionGroups/example_action_group + az monitor activity-log alert create -n {AlertName} -g {ResourceGroup} \\ + -a /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/microsoft.insights/actionGroups/{ActionGroup} \\ -w usage=test owner=jane - - - name: Create an alert is disabled initially. + - name: Create an alert which is initially disabled. text: > - az monitor activity-log alert create -n {ALERT_NAME} -g {RG} --disable + az monitor activity-log alert create -n {AlertName} -g {ResourceGroup} --disable """ helps['monitor activity-log alert update'] = """ @@ -388,21 +396,20 @@ - name: --description short-summary: A description of this activity log alert. - name: --condition -c - short-summary: A condition expression represents the condition that will cause the alert to activate. The - format is FIELD=VALUE[ and FILED=VALUE...]. The possible values for the field are 'resourceId', - 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', - 'subStatus', 'resourceType', or anything beginning with 'properties.'. + short-summary: The conditional expression that will cause the alert to activate. The format is FIELD=VALUE[ and FIELD=VALUE...]. + long-summary: > + The possible values for the field are 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', + 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'. - name: --enable - short-summary: Enable or disable this activity log alert. + short-summary: Enable or disable this activity log alert. Takes a boolean value of 'true' or 'false'. examples: - name: Update the condition text: > - az monitor activity-log alert update -n {ALERT_NAME} -g {RG} \\ + az monitor activity-log alert update -n {AlertName} -g {ResourceGroup} \\ --condition category=ServiceHealth and level=Error - - name: Disable an alert text: > - az monitor activity-log alert update -n {ALERT_NAME} -g {RG} --enable false + az monitor activity-log alert update -n {AlertName} -g {ResourceGroup} --enable false """ helps['monitor activity-log alert action-group'] = """ @@ -422,35 +429,33 @@ - name: --reset short-summary: Remove all the existing action groups before add new conditions. - name: --webhook-properties -w - short-summary: Space separated web hook properties in 'key[=value]' format. These properties will be - associated with the action groups added in this command. For any webhook receiver in these - action group, these data are appended to the webhook payload. To attach different webhook - properties to different action groups, add the action groups in separate update-action - commands. + short-summary: > + Space separated webhook properties in 'key[=value]' format. These properties will be associated with + the action groups added in this command. + long-summary: > + For any webhook receiver in these action group, these data are appended to the webhook payload. + To attach different webhook properties to different action groups, add the action groups in separate update-action commands. - name: --strict short-summary: Fails the command if an action group to be added will change existing webhook properties. examples: - name: Add an action group and specify webhook properties. - text: > - az monitor activity-log alert action-group add -n {ALERT_NAME} -g {RG} \\ - --action /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/microsoft.insights/actionGroups/example_action_group + text: | + az monitor activity-log alert action-group add -n {AlertName} -g {ResourceGroup} \\ + --action /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/microsoft.insights/actionGroups/{ActionGroup} \\ --webhook-properties usage=test owner=jane - - name: Overwite an existing action group's webhook properties. - text: > - az monitor activity-log alert action-group add -n {ALERT_NAME} -g {RG} \\ - -a /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/microsoft.insights/actionGroups/example_action_group + text: | + az monitor activity-log alert action-group add -n {AlertName} -g {ResourceGroup} \\ + -a /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/microsoft.insights/actionGroups/{ActionGroup} \\ --webhook-properties usage=test owner=john - - name: Remove webhook properties from an existing action group. - text: > - az monitor activity-log alert action-group add -n {ALERT_NAME} -g {RG} \\ - -a /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/microsoft.insights/actionGroups/example_action_group - + text: | + az monitor activity-log alert action-group add -n {AlertName} -g {ResourceGroup} \\ + -a /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/microsoft.insights/actionGroups/{ActionGroup} - name: Add new action groups but prevent the command from accidently overwrite existing webhook properties - text: > - az monitor activity-log alert action-group add -n {ALERT_NAME} -g {RG} --strict \\ - --action-group {A_LIST_OF_RESOURCE_IDS} + text: | + az monitor activity-log alert action-group add -n {AlertName} -g {ResourceGroup} --strict \\ + --action-group {ResourceIDList} """ helps['monitor activity-log alert action-group remove'] = """ diff --git a/src/command_modules/azure-cli-network/azure/cli/command_modules/network/_help.py b/src/command_modules/azure-cli-network/azure/cli/command_modules/network/_help.py index f9ec37a2857..70a276c8a5e 100644 --- a/src/command_modules/azure-cli-network/azure/cli/command_modules/network/_help.py +++ b/src/command_modules/azure-cli-network/azure/cli/command_modules/network/_help.py @@ -557,7 +557,7 @@ az network application-gateway waf-config list-rule-sets --type OWASP - name: List available rules in the OWASP 3.0 rule set. text: > - az network application-gateway waf-config list-rule-sets --group * --type OWASP --version 3.0 + az network application-gateway waf-config list-rule-sets --group '*' --type OWASP --version 3.0 - name: List available rules in the 'crs_35_bad_robots' rule group. text: > az network application-gateway waf-config list-rule-sets --group crs_35_bad_robots @@ -1379,7 +1379,7 @@ text: > az network nsg rule create -g MyResourceGroup --nsg-name MyNsg -n MyNsgRule --priority 4096 --source-address-prefixes 208.130.28/24 --source-port-ranges 80 - --destination-address-prefixes * --destination-port-ranges 80 8080 --access Deny + --destination-address-prefixes '*' --destination-port-ranges 80 8080 --access Deny --protocol Tcp --description "Deny from specific IP address ranges on 80 and 8080." """ @@ -1404,7 +1404,7 @@ examples: - name: Update an NSG rule with a new wildcard destination address prefix. text: > - az network nsg rule update -g MyResourceGroup --nsg-name MyNsg -n MyNsgRule --destination-address-prefix * + az network nsg rule update -g MyResourceGroup --nsg-name MyNsg -n MyNsgRule --destination-address-prefix '*' """ # endregion @@ -1457,7 +1457,7 @@ az network public-ip show -g MyResourceGroup -n MyIp - name: Get the FQDN and IP address for a public IP resource. text: > - az network public-ip show -g MyResourceGroup -n MyIp --query "{ fqdn:dnsSettings.fqdn, address: ipAddress }" + az network public-ip show -g MyResourceGroup -n MyIp --query "{fqdn: dnsSettings.fqdn, address: ipAddress}" """ helps['network public-ip update'] = """ diff --git a/src/command_modules/azure-cli-rdbms/HISTORY.rst b/src/command_modules/azure-cli-rdbms/HISTORY.rst index 366cb8ec828..db5e316c7ff 100644 --- a/src/command_modules/azure-cli-rdbms/HISTORY.rst +++ b/src/command_modules/azure-cli-rdbms/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +0.0.11 +++++++ +* Updated helpfile + 0.0.10 ++++++ * Update for CLI core changes. diff --git a/src/command_modules/azure-cli-rdbms/azure/cli/command_modules/rdbms/_help.py b/src/command_modules/azure-cli-rdbms/azure/cli/command_modules/rdbms/_help.py index 5cc39306cf1..c91fd60961f 100644 --- a/src/command_modules/azure-cli-rdbms/azure/cli/command_modules/rdbms/_help.py +++ b/src/command_modules/azure-cli-rdbms/azure/cli/command_modules/rdbms/_help.py @@ -38,7 +38,7 @@ def add_helps(command_group, server_type): - name: Restore 'testsvr2' to 'testsvrnew', where 'testsvrnew' is in a different resource group than the backup. text: | az {0} server restore -g testgroup -n testsvrnew \\ - -s "/subscriptions/{{SubID}}/resourceGroups/{{ResourceGroup}}/providers/Microsoft.DBfor{1}/servers/testsvr2" \\ + -s "/subscriptions/${{SubID}}/resourceGroups/${{ResourceGroup}}/providers/Microsoft.DBfor{1}/servers/testsvr2" \\ --restore-point-in-time "2017-06-15T13:10:00Z" """.format(command_group, server_type) helps['{} server update'.format(command_group)] = """ diff --git a/src/command_modules/azure-cli-rdbms/setup.py b/src/command_modules/azure-cli-rdbms/setup.py index 99e3d7ba25b..2661a4a6f16 100644 --- a/src/command_modules/azure-cli-rdbms/setup.py +++ b/src/command_modules/azure-cli-rdbms/setup.py @@ -12,7 +12,7 @@ logger.warn("Wheel is not available, disabling bdist_wheel hook") cmdclass = {} -VERSION = "0.0.10" +VERSION = "0.0.11" CLASSIFIERS = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', diff --git a/src/command_modules/azure-cli-resource/HISTORY.rst b/src/command_modules/azure-cli-resource/HISTORY.rst index fe846eeb405..560aaa79d32 100644 --- a/src/command_modules/azure-cli-resource/HISTORY.rst +++ b/src/command_modules/azure-cli-resource/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +2.0.21 +++++++ +* Helpfile changes + 2.0.20 ++++++ * Update for CLI core changes. diff --git a/src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py b/src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py index 7cc639272a8..ce9eb30d8f4 100644 --- a/src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py +++ b/src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py @@ -21,12 +21,12 @@ - name: Create a managed application of kind 'ServiceCatalog'. This requires a valid managed application definition ID. text: | az managedapp create -g MyResourceGroup -n MyManagedApp -l westcentralus --kind ServiceCatalog \\ - -m "/subscriptions/{SubID}/resourceGroups/{ManagedRG}" \\ - -d "/subscriptions/{SubID}/resourceGroups/{MyRG}/providers/Microsoft.Solutions/applianceDefinitions/{ManagedAppDef}" + -m "/subscriptions/{SubID}/resourceGroups/{ManagedResourceGroup}" \\ + -d "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Solutions/applianceDefinitions/{ApplianceDefinition}" - name: Create a managed application of kind 'MarketPlace'. This requires a valid plan, containing details about existing marketplace package like plan name, version, publisher and product. text: | az managedapp create -g MyResourceGroup -n MyManagedApp -l westcentralus --kind MarketPlace \\ - -m "/subscriptions/{SubID}/resourceGroups/myManagedRG" \\ + -m "/subscriptions/{SubID}/resourceGroups/{ManagedResourceGroup}" \\ --plan-name ContosoAppliance --plan-version "1.0" --plan-product "contoso-appliance" --plan-publisher Contoso """ helps['managedapp definition create'] = """ @@ -170,31 +170,29 @@ examples: - name: Create a read-only policy. text: | - az policy definition create -n readOnlyStorage --rules \\ - { \\ - "if": \\ - { \\ - "source": "action", \\ - "equals": "Microsoft.Storage/storageAccounts/write" \\ - }, \\ - "then": \\ - { \\ - "effect": "deny" \\ - } \\ - } + az policy definition create -n readOnlyStorage --rules '{ + "if": + { + "source": "action", + "equals": "Microsoft.Storage/storageAccounts/write" + }, + "then": + { + "effect": "deny" + } + }' - name: Create a policy parameter definition with the following example text: | - { - "allowedLocations": { - "type": "array", - "metadata": { - "description": "The list of locations that can be specified - when deploying resources", - "strongType": "location", - "displayName": "Allowed locations" - } + az policy definition create -n allowedLocations --rules '{ + "allowedLocations": { + "type": "array", + "metadata": { + "description": "The list of locations that can be specified when deploying resources", + "strongType": "location", + "displayName": "Allowed locations" } } + }' """ helps['policy definition delete'] = """ type: command @@ -226,12 +224,11 @@ examples: - name: Create a policy set definition. text: | - az policy setdefinition create -n readOnlyStorage --definitions \\ - [ \\ - { \\ - "policyDefinitionId": "/subscriptions/mySubId/providers/Microsoft.Authorization/policyDefinitions/storagePolicy" \\ - } \\ - ] + az policy setdefinition create -n readOnlyStorage --definitions '[ + { + "policyDefinitionId": "/subscriptions/mySubId/providers/Microsoft.Authorization/policyDefinitions/storagePolicy" + } + ]' """ helps['policy set-definition delete'] = """ type: command @@ -259,7 +256,7 @@ examples: - name: Provide rule parameter values with the following example text: | - { + az policy assignment create --policy {PolicyNamed} -p '{ "allowedLocations": { "value": [ "australiaeast", @@ -267,7 +264,7 @@ "japaneast" ] } - } + }' """ helps['policy assignment delete'] = """ type: command @@ -300,7 +297,7 @@ az resource list --tag test - name: List all resources with a tag that starts with 'test'. text: > - az resource list --tag test* + az resource list --tag 'test*' - name: List all resources with the tag 'test' that have the value 'example'. text: > az resource list --tag test=example @@ -351,7 +348,7 @@ az resource tag --tags vmlist=vm1 -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" - name: Tag a web app with the key 'vmlist' and value 'vm1', using a resource identifier. text: > - az resource tag --tags vmlist=vm1 --id /subscriptions/{SubID}/resourceGroups/{MyRG}/providers/Microsoft.Web/sites/{MyWebApp} + az resource tag --tags vmlist=vm1 --id /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} """ helps['resource create'] = """ @@ -360,23 +357,21 @@ examples: - name: Create an API app by providing a full JSON configuration. text: | - az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites --is-full-object --properties \\ - '{\\ - "kind": "api",\\ - "location": "West US",\\ - "properties": {\\ - "serverFarmId": "/subscriptions/{SubID}/resourcegroups/{MyRG}/providers/Microsoft.Web/serverfarms/{MyServicePlan}"\\ - }\\ + az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites --is-full-object --properties '{ + "kind": "api", + "location": "West US", + "properties": { + "serverFarmId": "/subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/Microsoft.Web/serverfarms/{ServicePlan}" + } }' - name: Create a resource by loading JSON configuration from a file. text: > az resource create -g myRG -n myApiApp --resource-type Microsoft.web/sites --is-full-object --properties @jsonConfigFile - name: Create a web app with the minimum required configuration information. text: | - az resource create -g myRG -n myWeb --resource-type Microsoft.web/sites --properties \\ - { \\ - "serverFarmId":"/subscriptions/{SubID}/resourcegroups/{MyRG}/providers/Microsoft.Web/serverfarms/{MyServicePlan}" \\ - } + az resource create -g myRG -n myWeb --resource-type Microsoft.web/sites --properties '{ + "serverFarmId":"/subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/Microsoft.Web/serverfarms/{ServicePlan}" + }' """ helps['resource update'] = """ @@ -389,16 +384,22 @@ short-summary: Invoke an action on the resource. long-summary: > A list of possible actions corresponding to a resource can be found at https://docs.microsoft.com/en-us/rest/api/. All POST requests are actions that can be invoked and are specified at the end of the URI path. For instance, to stop a VM, the - request URI is https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vm}/powerOff?api-version={apiVersion} and the corresponding action is `powerOff`. This can + request URI is https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.Compute/virtualMachines/{VM}/powerOff?api-version={APIVersion} and the corresponding action is `powerOff`. This can be found at https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/virtualmachines-stop. examples: - name: Power-off a vm, specified by Id. text: > - az resource invoke-action --action powerOff --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM + az resource invoke-action --action powerOff \\ + --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Compute/virtualMachines/{VMName} - name: Capture information for a stopped vm. text: > - az resource invoke-action --action capture --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM --request-body - {\\"vhdPrefix\\":\\"myPrefix\\",\\"destinationContainerName\\":\\"myContainer\\",\\"overwriteVhds\\":\\"true\\"} + az resource invoke-action --action capture \\ + --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Compute/virtualMachines/{VMName} \\ + --request-body '{ + "vhdPrefix": "myPrefix", + "destinationContainerName": "myContainer", + "overwriteVhds": true + }' """ helps['feature'] = """ @@ -474,15 +475,15 @@ az group deployment create -g MyResourceGroup --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json - name: Create a deployment from a local template file, using parameters from a JSON string. text: | - az group deployment create -g MyResourceGroup --template-file azuredeploy.json --parameters \\ - '{ \\ - "location": {\\ - "value": "westus" \\ - } \\ - }' + az group deployment create -g MyResourceGroup --template-file azuredeploy.json --parameters '{ + "location": { + "value": "westus" + } + }' - name: Create a deployment from a local template, using a parameter file and selectively overriding key/value pairs. text: > - az group deployment create -g MyResourceGroup --template-file azuredeploy.json --parameters @params.json --parameters MyValue=This MyArray=@array.json + az group deployment create -g MyResourceGroup --template-file azuredeploy.json \\ + --parameters @params.json --parameters MyValue=This MyArray=@array.json """ helps['group deployment export'] = """ type: command @@ -598,29 +599,29 @@ helps['resource link create'] = """ type: command short-summary: Create a new link between resources. - long-summary: A link-id is of the form /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name} + long-summary: A link-id is of the form /subscriptions/{SubID}/resourceGroups/{ResourceGroupID}/{ProviderNamespace}/{ResourceType}/{ResourceName}/Microsoft.Resources/links/{LinkName} examples: - - name: Create a link from to with notes "some notes to explain this link" + - name: Create a link from {SourceID} to {ResourceID} with notes text: > - az resource link create --link-id --target-id --notes "some notes to explain this link" + az resource link create --link-id {SourceID} --target-id {ResourceID} --notes "SourceID depends on ResourceID" """ helps['resource link update'] = """ type: command short-summary: Update link between resources. - long-summary: A link-id is of the form /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name} + long-summary: A link-id is of the form /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/{ProviderNamespace}/{ResourceType}/{ResourceName}/Microsoft.Resources/links/{LinkName} examples: - - name: Update the notes for notes "some notes to explain this link" + - name: Update the notes for {LinkID} notes "some notes to explain this link" text: > - az resource link update --link-id --notes "some notes to explain this link" + az resource link update --link-id {LinkID} --notes "some notes to explain this link" """ helps['resource link delete'] = """ type: command short-summary: Delete a link between resources. - long-summary: A link-id is of the form /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name} + long-summary: A link-id is of the form /subscriptions/{SubID}/resourceGroups/{ResourceGroupID}/{ProviderNamespace}/{ResourceType}/{ResourceName}/Microsoft.Resources/links/{LinkName} examples: - - name: Delete link + - name: Delete link {LinkID} text: > - az resource link delete --link-id + az resource link delete --link-id {LinkID} """ helps['resource link list'] = """ type: command @@ -629,18 +630,14 @@ - name: List links, filtering with text: > az resource link list --filter - - name: List all links at /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup + - name: List all links for resource group {ResourceGroup} in subscription {SubID} text: > - az resource link list --scope /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup + az resource link list --scope /subscriptions/{SubID}/resourceGroups/{ResourceGroup} """ helps['resource link show'] = """ type: command short-summary: Get details for a resource link. - long-summary: A link-id is of the form /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name} - examples: - - name: Show the resource link. - text: > - az resource link show --link-id + long-summary: A link-id is of the form /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/{ProviderNamespace}/{ResourceType}/{ResourceName}/Microsoft.Resources/links/{LinkName} """ helps['resource lock'] = """ type: group @@ -655,7 +652,7 @@ az resource lock create --lock-type ReadOnly -n lockName -g MyResourceGroup --resource myvnet --resource-type Microsoft.Network/virtualNetworks - name: Create a read-only resource level lock on a vnet using a vnet id. text: > - az resource lock create --lock-type ReadOnly -n lockName --resource /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/myvnet + az resource lock create --lock-type ReadOnly -n lockName --resource /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName} """ helps['resource lock delete'] = """ type: command @@ -666,7 +663,7 @@ az resource lock delete --name lockName -g MyResourceGroup --resource myvnet --resource-type Microsoft.Network/virtualNetworks - name: Delete a resource level lock on a vnet using a vnet id. text: > - az resource lock delete -n lockName --resource /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/myvnet + az resource lock delete -n lockName --resource /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VMName} """ helps['resource lock list'] = """ type: command diff --git a/src/command_modules/azure-cli-resource/setup.py b/src/command_modules/azure-cli-resource/setup.py index 2000dd50594..a96d6bff3f3 100644 --- a/src/command_modules/azure-cli-resource/setup.py +++ b/src/command_modules/azure-cli-resource/setup.py @@ -14,7 +14,7 @@ logger.warn("Wheel is not available, disabling bdist_wheel hook") cmdclass = {} -VERSION = "2.0.20" +VERSION = "2.0.21" CLASSIFIERS = [ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', diff --git a/src/command_modules/azure-cli-role/HISTORY.rst b/src/command_modules/azure-cli-role/HISTORY.rst index cb897daf499..ec5af061867 100644 --- a/src/command_modules/azure-cli-role/HISTORY.rst +++ b/src/command_modules/azure-cli-role/HISTORY.rst @@ -2,6 +2,7 @@ Release History =============== + 2.0.17 ++++++ * role assignment: expose --assignee-object-id to bypass graph query diff --git a/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py index 187a991d89f..367891c107e 100644 --- a/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py +++ b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py @@ -47,8 +47,8 @@ - name: Create with customized contributor assignments. text: | az ad sp create-for-rbac -n "MyApp" --role contributor \\ - --scopes /subscriptions/{SubID}/resourceGroups/{MyRG1} \\ - /subscriptions/{SubID}/resourceGroups/{MyRG2} + --scopes /subscriptions/{SubID}/resourceGroups/{ResourceGroup1} \\ + /subscriptions/{SubID}/resourceGroups/{ResourceGroup2} - name: Create using a self-signed certificte. text: az ad sp create-for-rbac --create-cert - name: Create using a self-signed certificate, and store it within KeyVault. @@ -160,23 +160,23 @@ examples: - name: Create a role with read-only access to storage and network resources, and the ability to start or restart VMs. text: | - az role definition create --role-definition { \\ - "Name": "Contoso On-call", \\ - "Description": "Perform VM actions and read storage and network information." \\ - "Actions": [ \\ - "Microsoft.Compute/*/read", \\ - "Microsoft.Compute/virtualMachines/start/action", \\ - "Microsoft.Compute/virtualMachines/restart/action", \\ - "Microsoft.Network/*/read", \\ - "Microsoft.Storage/*/read", \\ - "Microsoft.Authorization/*/read", \\ - "Microsoft.Resources/subscriptions/resourceGroups/read", \\ - "Microsoft.Resources/subscriptions/resourceGroups/resources/read", \\ - "Microsoft.Insights/alertRules/*", \\ - "Microsoft.Support/*" \\ - ], \\ - "AssignableScopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] \\ - } + az role definition create --role-definition '{ + "Name": "Contoso On-call", + "Description": "Perform VM actions and read storage and network information." + "Actions": [ + "Microsoft.Compute/*/read", + "Microsoft.Compute/virtualMachines/start/action", + "Microsoft.Compute/virtualMachines/restart/action", + "Microsoft.Network/*/read", + "Microsoft.Storage/*/read", + "Microsoft.Authorization/*/read", + "Microsoft.Resources/subscriptions/resourceGroups/read", + "Microsoft.Resources/subscriptions/resourceGroups/resources/read", + "Microsoft.Insights/alertRules/*", + "Microsoft.Support/*" + ], + "AssignableScopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] + }' - name: Create a role from a file containing a JSON description. text: > az role definition create --role-definition @ad-role.json @@ -200,23 +200,23 @@ examples: - name: Create a role with read-only access to storage and network resources, and the ability to start or restart VMs. text: | - az role definition create --role-definition { \\ - "Name": "Contoso On-call", \\ - "Description": "Perform VM actions and read storage and network information." \\ - "Actions": [ \\ - "Microsoft.Compute/*/read", \\ - "Microsoft.Compute/virtualMachines/start/action", \\ - "Microsoft.Compute/virtualMachines/restart/action", \\ - "Microsoft.Network/*/read", \\ - "Microsoft.Storage/*/read", \\ - "Microsoft.Authorization/*/read", \\ - "Microsoft.Resources/subscriptions/resourceGroups/read", \\ - "Microsoft.Resources/subscriptions/resourceGroups/resources/read", \\ - "Microsoft.Insights/alertRules/*", \\ - "Microsoft.Support/*" \\ - ], \\ - "AssignableScopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] \\ - } + az role definition create --role-definition '{ + "Name": "Contoso On-call", + "Description": "Perform VM actions and read storage and network information." + "Actions": [ + "Microsoft.Compute/*/read", + "Microsoft.Compute/virtualMachines/start/action", + "Microsoft.Compute/virtualMachines/restart/action", + "Microsoft.Network/*/read", + "Microsoft.Storage/*/read", + "Microsoft.Authorization/*/read", + "Microsoft.Resources/subscriptions/resourceGroups/read", + "Microsoft.Resources/subscriptions/resourceGroups/resources/read", + "Microsoft.Insights/alertRules/*", + "Microsoft.Support/*" + ], + "AssignableScopes": ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] + }' - name: Create a role from a file containing a JSON description. text: > az role definition create --role-definition ad-role.json diff --git a/src/command_modules/azure-cli-servicefabric/azure/cli/command_modules/servicefabric/_help.py b/src/command_modules/azure-cli-servicefabric/azure/cli/command_modules/servicefabric/_help.py index e36337137ee..ee3dd90fdb6 100644 --- a/src/command_modules/azure-cli-servicefabric/azure/cli/command_modules/servicefabric/_help.py +++ b/src/command_modules/azure-cli-servicefabric/azure/cli/command_modules/servicefabric/_help.py @@ -82,7 +82,7 @@ - name: Use a keyvault certificate and custom template to deploy a cluster. text: > az sf cluster create -g group-name -n cluster1 -l westus --template-file template.json \\ - --parameter-file parameter.json --secret-identifier https://{MyKeyVault}.vault.azure.net:443/secrets/{MyCertificate} + --parameter-file parameter.json --secret-identifier https://{KeyVault}.vault.azure.net:443/secrets/{MyCertificate} """ @@ -93,7 +93,7 @@ - name: Add a certificate to a cluster using a keyvault secret identifier. text: | az sf cluster certificate add -g group-name -n cluster1 \\ - --secret-identifier 'https://{MyKeyVault}.vault.azure.net/secrets/{MySecret} + --secret-identifier 'https://{KeyVault}.vault.azure.net/secrets/{Secret} - name: Add a self-signed certificate to a cluster. text: > az sf cluster certificate add -g group-name -n cluster1 --certificate-subject-name test.com @@ -207,7 +207,6 @@ - name: Set a cluster to use the 'Automatic' upgrade mode. text: > az sf cluster upgrade-type set -g group-name -n cluster1 --upgrade-mode Automatic - """ helps["sf application certificate add"] = """ @@ -216,6 +215,5 @@ examples: - name: Add an application certificate. text: > - az sf cluster application certificate add -g group-name -n cluster1 --secret-identifier 'https://{KeyVault}.vault.azure.net/secrets/{MySecret}' - + az sf cluster application certificate add -g group-name -n cluster1 --secret-identifier 'https://{KeyVault}.vault.azure.net/secrets/{Secret}' """ diff --git a/src/command_modules/azure-cli-sql/HISTORY.rst b/src/command_modules/azure-cli-sql/HISTORY.rst index 9721304df8d..df5f33de6dd 100644 --- a/src/command_modules/azure-cli-sql/HISTORY.rst +++ b/src/command_modules/azure-cli-sql/HISTORY.rst @@ -3,6 +3,10 @@ Release History =============== +2.0.19 +++++++ +* Updated helpfile + 2.0.18 ++++++ * Update for CLI core changes. diff --git a/src/command_modules/azure-cli-sql/azure/cli/command_modules/sql/_help.py b/src/command_modules/azure-cli-sql/azure/cli/command_modules/sql/_help.py index feb8be6917e..486920d2f58 100644 --- a/src/command_modules/azure-cli-sql/azure/cli/command_modules/sql/_help.py +++ b/src/command_modules/azure-cli-sql/azure/cli/command_modules/sql/_help.py @@ -354,7 +354,9 @@ examples: - name: Create a vnet rule by providing the subnet id. - text: az sql server vnet-rule create --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/subnetName + text: | + az sql server vnet-rule create \\ + --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} - name: Create a vnet rule by providing the vnet and subnet name. The subnet id is created by taking the resource group name and subscription id of the SQL server. text: az sql server vnet-rule create --subnet subnetName --vnet-name vnetName """ diff --git a/src/command_modules/azure-cli-sql/setup.py b/src/command_modules/azure-cli-sql/setup.py index 63bc6b27bcb..60aa72fd23d 100644 --- a/src/command_modules/azure-cli-sql/setup.py +++ b/src/command_modules/azure-cli-sql/setup.py @@ -12,7 +12,7 @@ logger.warn("Wheel is not available, disabling bdist_wheel hook") cmdclass = {} -VERSION = "2.0.18" +VERSION = "2.0.19" CLASSIFIERS = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', diff --git a/src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py b/src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py index 62ada4c6531..7c77b8f1e2b 100644 --- a/src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py +++ b/src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py @@ -114,7 +114,7 @@ short-summary: Show storage account properties. examples: - name: Show properties for a storage account by resource ID. - text: az storage account show --ids /subscriptions/{SubID}/resourceGroups/{MyResourceGroup}/providers/Microsoft.Storage/storageAccounts/{MyStorageAccount} + text: az storage account show --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Storage/storageAccounts/{StorageAccount} - name: Show properties for a storage account using an account name and resource group. text: az storage account show -g MyResourceGroup -n MyStorageAccount """ @@ -137,7 +137,7 @@ short-summary: Delete a storage account. examples: - name: Delete a storage account using a resource ID. - text: az storage account delete --ids /subscriptions/{SubID}/resourceGroups/{MyResourceGroup}/providers/Microsoft.Storage/storageAccounts/{MyStorageAccount} + text: az storage account delete --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Storage/storageAccounts/{StorageAccount} - name: Delete a storage account using an account name and resource group. text: az storage account delete -n MyStorageAccount -g MyResourceGroup """ @@ -407,7 +407,7 @@ - name: --max-age short-summary: The maximum number of seconds the client/browser should cache a preflight response. - name: --origins - short-summary: List of origin domains that will be allowed via CORS, or "*" to allow all domains. + short-summary: List of origin domains that will be allowed via CORS, or '*' to allow all domains. - name: --methods short-summary: List of HTTP methods allowed to be executed by the origin. - name: --allowed-headers diff --git a/src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py b/src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py index 4baf272479d..e1b09488ce3 100644 --- a/src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py +++ b/src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py @@ -514,11 +514,11 @@ --account-name $my_diagnostic_storage_account --expiry 9999-12-31T23:59Z \\ --permissions wlacu --resource-types co --services bt -o tsv) - protected_settings="{'storageAccountName': '${my_diagnostic_storage_account}', \\ - 'storageAccountSasToken': '${storage_sastoken}'}" + protected_settings="{'storageAccountName': '{my_diagnostic_storage_account}', \\ + 'storageAccountSasToken': '{storage_sastoken}'}" - az vm diagnostics set --settings "${default_config}" \\ - --protected-settings "${protected_settings}" \\ + az vm diagnostics set --settings "{default_config}" \\ + --protected-settings "{protected_settings}" \\ --resource-group $my_resource_group --vm-name $my_linux_vm """ @@ -735,11 +735,11 @@ location=westus\n latest=$(az vm extension image list-versions \\ - --publisher ${publisher} -l ${location} -n ${extension} \\ + --publisher {publisher} -l {location} -n {extension} \\ --query "[].name" -o tsv | sort | tail -n 1) - az vm extension image show -l ${location} \\ - --publisher ${publisher} -n ${extension} --version ${latest} + az vm extension image show -l {location} \\ + --publisher {publisher} -n {extension} --version {latest} """ helps['vm image'] = """ @@ -804,7 +804,7 @@ text: > latest=$(az vm image list -p OpenLogic -s 7.3 --all --query \\ "[?offer=='CentOS'].version" -o tsv | sort -u | tail -n 1) - az vm image show -l westus -f CentOS -p OpenLogic --s 7.3 --version ${latest} + az vm image show -l westus -f CentOS -p OpenLogic --s 7.3 --version {latest} """ helps['vm nic'] = """ @@ -941,9 +941,9 @@ - name: Deallocate, generalize, and capture multiple stopped virtual machines. text: | vms_ids=$(az vm list -g MyResourceGroup --query "[].id" -o tsv) - az vm deallocate --ids ${vms_ids} - az vm generalize --ids ${vms_ids} - az vm capture --ids ${vms_ids} --vhd-name-prefix MyPrefix + az vm deallocate --ids {vms_ids} + az vm generalize --ids {vms_ids} + az vm capture --ids {vms_ids} --vhd-name-prefix MyPrefix """ helps['vmss encryption'] = """ @@ -1092,7 +1092,7 @@ network commands directly (nsg rule create, etc). examples: - name: Open all ports on a VM to inbound traffic. - text: az vm open-port -g MyResourceGroup -n MyVm --port * + text: az vm open-port -g MyResourceGroup -n MyVm --port '*' - name: Open a range of ports on a VM to inbound traffic with the highest priority. text: az vm open-port -g MyResourceGroup -n MyVm --port 80-100 --priority 100 {0}