diff --git a/src/azure-cli/azure/cli/command_modules/monitor/_help.py b/src/azure-cli/azure/cli/command_modules/monitor/_help.py index dc1b49a2431..264a577d765 100644 --- a/src/azure-cli/azure/cli/command_modules/monitor/_help.py +++ b/src/azure-cli/azure/cli/command_modules/monitor/_help.py @@ -279,11 +279,10 @@ - name: --reset short-summary: Remove all the existing scopes before add new scopes. examples: - - name: Add three levels of scopes into activity-log alert. - text: > - az monitor activity-log alert scope add -n {AlertName} -g {ResourceGroup} -s /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \\ - /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myRG \\ - /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myRG/Microsoft.KeyVault/vaults/mykey + - name: Add scopes to this activity log alert. (autogenerated) + text: | + az monitor activity-log alert scope add --name MyActivityLogAlerts --resource-group MyResourceGroup --scope /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myRG /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myRG/Microsoft.KeyVault/vaults/mykey + crafted: true """ helps['monitor activity-log alert scope remove'] = """ @@ -499,6 +498,10 @@ text: | az monitor alert update --name MyAlertRule --remove-action email bob@contoso.com --resource-group MyResourceGroup crafted: true + - name: Update a classic metric-based alert rule. (autogenerated) + text: | + az monitor alert update --name MyAlertRule --resource-group MyResourceGroup --set retentionPolicy.days=365 + crafted: true """ helps['monitor autoscale'] = """ @@ -605,7 +608,11 @@ --recurrence week sat sun --timezone "Pacific Standard Time" - name: Create a fixed or recurring autoscale profile. (autogenerated) text: | - az monitor autoscale profile create --autoscale-name MyAutoscale --count 2 --end 2018-12-26 --name Christmas --recurrence week sat sun --resource-group MyResourceGroup --start 2018-12-24 --timezone "Pacific Standard Time" + az monitor autoscale profile create --autoscale-name MyAutoscale --copy-rules default --count 2 --end 2018-12-26 --max-count 10 --min-count 1 --name Christmas --recurrence week sat sun --resource-group MyResourceGroup --start 2018-12-24 --timezone "Pacific Standard Time" + crafted: true + - name: Create a fixed or recurring autoscale profile. (autogenerated) + text: | + az monitor autoscale profile create --autoscale-name MyAutoscale --count 2 --max-count 10 --min-count 1 --name Christmas --recurrence week sat sun --resource-group MyResourceGroup --start 2018-12-24 --subscription MySubscription --timezone "Pacific Standard Time" crafted: true """ @@ -929,7 +936,7 @@ examples: - name: Get a list of usage metrics for a workspace. (autogenerated) text: | - az monitor log-analytics workspace list-usages --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace list-usages --resource-group MyResourceGroup --subscription MySubscription --workspace-name MyWorkspace crafted: true """ @@ -946,11 +953,21 @@ helps['monitor log-analytics workspace pack enable'] = """ type: command short-summary: Enable an intelligence pack for a given workspace. +examples: + - name: Enable an intelligence pack for a given workspace. (autogenerated) + text: | + az monitor log-analytics workspace pack enable --name MyIntelligencePack --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace pack list'] = """ type: command short-summary: List all the intelligence packs possible and whether they are enabled or disabled for a given workspace. +examples: + - name: List all the intelligence packs possible and whether they are enabled or disabled for a given workspace. (autogenerated) + text: | + az monitor log-analytics workspace pack list --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace show'] = """ diff --git a/src/azure-cli/azure/cli/command_modules/network/_help.py b/src/azure-cli/azure/cli/command_modules/network/_help.py index 0d9e61590ae..3efd33e8549 100644 --- a/src/azure-cli/azure/cli/command_modules/network/_help.py +++ b/src/azure-cli/azure/cli/command_modules/network/_help.py @@ -186,7 +186,7 @@ text: az network application-gateway frontend-ip update -g MyResourceGroup --gateway-name MyAppGateway \\ -n MyFrontendIp --public-ip-address MyNewPublicIpAddress - name: Update a frontend IP address. (autogenerated) text: | - az network application-gateway frontend-ip update --gateway-name MyAppGateway --name MyFrontendIp --resource-group MyResourceGroup --set useRemoteGateways=true + az network application-gateway frontend-ip update --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup crafted: true """ @@ -403,6 +403,10 @@ examples: - name: Delete a probe. text: az network application-gateway probe delete -g MyResourceGroup --gateway-name MyAppGateway -n MyProbe + - name: Delete a probe. (autogenerated) + text: | + az network application-gateway probe delete --gateway-name MyAppGateway --name MyProbe --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network application-gateway probe list'] = """ @@ -1122,6 +1126,11 @@ helps['network application-gateway waf-policy list'] = """ type: command short-summary: List application gateway WAF policies. +examples: + - name: List application gateway WAF policies. (autogenerated) + text: | + az network application-gateway waf-policy list --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy policy-setting'] = """ @@ -1132,6 +1141,11 @@ helps['network application-gateway waf-policy policy-setting update'] = """ type: command short-summary: Update properties of a web application firewall global configuration. +examples: + - name: Update properties of a web application firewall global configuration. (autogenerated) + text: | + az network application-gateway waf-policy policy-setting update --mode Prevention --policy-name MyPolicy --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy policy-setting list'] = """ @@ -1207,6 +1221,11 @@ helps['network application-gateway waf-policy custom-rule update'] = """ type: command short-summary: Update an application gateway WAF policy custom rule. +examples: + - name: Update an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule update --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --set useRemoteGateways=true + crafted: true """ helps['network application-gateway waf-policy managed-rule'] = """ @@ -1243,7 +1262,6 @@ - name: Remove a managed rule set by rule set group name if rule_group_name is specified. Otherwise, remove all rule set. text: | az network application-gateway waf-policy managed-rule rule-set remove --policy-name MyPolicy --resource-group MyResourceGroup --type Permanent --version IPv4 - crafted: true """ helps['network application-gateway waf-policy managed-rule rule-set list'] = """ @@ -1289,10 +1307,6 @@ text: | az network application-gateway waf-policy update --add communities='12076:5010' --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup crafted: true - - name: Update an application gateway WAF policy. (autogenerated) - text: | - az network application-gateway waf-policy update --name MyApplicationGatewayWAFPolicy --remove tags.no_80 --resource-group MyResourceGroup - crafted: true """ helps['network application-gateway waf-policy wait'] = """ @@ -1423,6 +1437,10 @@ examples: - name: Add a Vnet to a DDoS protection plan in the same subscription. text: az network ddos-protection update -g MyResourceGroup -n MyDdosPlan --vnets MyVnet + - name: Update a DDoS protection plan. (autogenerated) + text: | + az network ddos-protection update --name MyDdosPlan --remove tags.no_80 --resource-group MyResourceGroup + crafted: true """ helps['network dns'] = """ @@ -1758,6 +1776,10 @@ examples: - name: Create an empty MX record set. text: az network dns record-set mx create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty MX record set. (autogenerated) + text: | + az network dns record-set mx create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + crafted: true """ helps['network dns record-set mx delete'] = """ @@ -2638,6 +2660,11 @@ helps['network express-route port update'] = """ type: command short-summary: Update settings of an ExpressRoute port. +examples: + - name: Update settings of an ExpressRoute port (autogenerated) + text: | + az network express-route port update --name MyExpressRoutePort --resource-group MyResourceGroup + crafted: true """ helps['network express-route port identity'] = """ @@ -2883,6 +2910,10 @@ text: | az network lb inbound-nat-pool update --backend-port 8080 --enable-tcp-reset true --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --resource-group MyResourceGroup crafted: true + - name: Update an inbound NAT address pool. (autogenerated) + text: | + az network lb inbound-nat-pool update --enable-tcp-reset true --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup + crafted: true """ helps['network lb inbound-nat-rule'] = """ @@ -3007,10 +3038,6 @@ text: | az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup crafted: true - - name: Update an outbound-rule. (autogenerated) - text: | - az network lb outbound-rule update --frontend-ip-configs myfrontendoutbound --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup - crafted: true """ helps['network lb probe'] = """ @@ -3728,6 +3755,11 @@ helps['network private-link-service delete'] = """ type: command short-summary: Delete a private link service. +examples: + - name: Delete a private link service. (autogenerated) + text: | + az network private-link-service delete --name MyPrivateLinkService --resource-group MyResourceGroup + crafted: true """ helps['network private-link-service list'] = """ @@ -4345,6 +4377,10 @@ examples: - name: Update a traffic manager profile to change the TTL to 300. text: az network traffic-manager profile update -g MyResourceGroup -n MyTmProfile --ttl 300 + - name: Update a traffic manager profile. (autogenerated) + text: | + az network traffic-manager profile update --name MyTmProfile --resource-group MyResourceGroup --status Enabled + crafted: true """ helps['network vnet'] = """ @@ -5534,6 +5570,10 @@ examples: - name: Delete a packet capture session. This only deletes the session and not the capture file. text: az network watcher packet-capture delete -n packetCaptureName -l westcentralus + - name: Delete a packet capture session. (autogenerated) + text: | + az network watcher packet-capture delete --location westcentralus --name packetCaptureName --subscription MySubscription + crafted: true """ helps['network watcher packet-capture list'] = """ @@ -5542,6 +5582,10 @@ examples: - name: List all packet capture sessions within a region. text: az network watcher packet-capture list -l westus + - name: List all packet capture sessions within a resource group (autogenerated) + text: | + az network watcher packet-capture list --location westus --subscription MySubscription + crafted: true """ helps['network watcher packet-capture show'] = """ diff --git a/src/azure-cli/azure/cli/command_modules/privatedns/_help.py b/src/azure-cli/azure/cli/command_modules/privatedns/_help.py index 5dbdcfcb7fd..8bbca22547a 100644 --- a/src/azure-cli/azure/cli/command_modules/privatedns/_help.py +++ b/src/azure-cli/azure/cli/command_modules/privatedns/_help.py @@ -80,7 +80,7 @@ - name: Update a virtual network link properties to enable registration. text: > az network private-dns link vnet update -g MyResourceGroup -n MyLinkName -z www.mysite.com -e True - - name: Update a virtual network link's properties. Does not modify virtual network within the link. (autogenerated) + - name: Update a virtual network link's properties (autogenerated) text: | az network private-dns link vnet update --name MyLinkName --registration-enabled true --resource-group MyResourceGroup --tags CostCenter=Marketing --zone-name www.mysite.com crafted: true @@ -169,7 +169,7 @@ -z www.mysite.com --metadata owner=WebTeam - name: Update an A record set. (autogenerated) text: | - az network private-dns record-set a update --name MyRecordSet --resource-group MyResourceGroup --set useRemoteGateways=true --zone-name www.mysite.com + az network private-dns record-set a update --name MyRecordSet --resource-group MyResourceGroup --set useRemoteGateways=true --subscription MySubscription --zone-name www.mysite.com crafted: true """ diff --git a/src/azure-cli/azure/cli/command_modules/resource/_help.py b/src/azure-cli/azure/cli/command_modules/resource/_help.py index dd1ba9a82b2..a1f40430a4d 100644 --- a/src/azure-cli/azure/cli/command_modules/resource/_help.py +++ b/src/azure-cli/azure/cli/command_modules/resource/_help.py @@ -1321,7 +1321,7 @@ examples: - name: Show a policy assignment's managed identity. (autogenerated) text: | - az policy assignment identity show --name MyPolicyAssignment + az policy assignment identity show --name MyPolicyAssignment --scope '/providers/Microsoft.Management/managementGroups/MyManagementGroup' crafted: true """ @@ -1745,6 +1745,10 @@ - name: Delete a resource level lock on a vnet using a vnet id. text: > az resource lock delete -n lockName --resource /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VMName} + - name: Delete a resource-level lock. (autogenerated) + text: | + az resource lock delete --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} + crafted: true """ helps['resource lock list'] = """ @@ -1805,13 +1809,9 @@ - name: Tag a web app with the key 'vmlist' and value 'vm1', using a resource identifier. text: > az resource tag --tags vmlist=vm1 --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} - - name: Tag the virtual machine 'MyVm' with the key 'vmlist' and value 'vm1' incrementally, it doesn't empty the existing tags. + - name: Tag the virtual machine 'MyVm' with the key 'vmlist' and value 'vm1' incrementally. It doesn't empty the existing tags. text: > az resource tag --tags vmlist=vm1 -g MyResourceGroup -n MyVm --resource-type "Microsoft.Compute/virtualMachines" -i - - name: Tag a resource. (autogenerated) - text: | - az resource tag --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --tags vmlist=vm1 - crafted: true """ helps['resource update'] = """ diff --git a/src/azure-cli/azure/cli/command_modules/storage/_help.py b/src/azure-cli/azure/cli/command_modules/storage/_help.py index a85d024253c..64c6aec9dfc 100644 --- a/src/azure-cli/azure/cli/command_modules/storage/_help.py +++ b/src/azure-cli/azure/cli/command_modules/storage/_help.py @@ -867,7 +867,7 @@ end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'` sas=`az storage container generate-sas -n mycontainer --https-only --permissions dlrw --expiry $end -o tsv` az storage blob upload -n MyBlob -c mycontainer -f file.txt --sas-token $sas - - name: Generates a shared access signature for the container (autogenerated) + - name: Generate a shared access signature for the container (autogenerated) text: | az storage container generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2020-01-01 --name mycontainer --permissions dlrw crafted: true @@ -1053,7 +1053,7 @@ examples: - name: List directories in a share. (autogenerated) text: | - az storage directory list --account-name MyAccount --share-name MyShare + az storage directory list --account-key 00000000 --account-name MyAccount --share-name MyShare crafted: true """ @@ -1234,10 +1234,6 @@ text: | az storage file download-batch --account-key 00000000 --account-name MyAccount --destination . --no-progress --source /path/to/file crafted: true - - name: Download files from an Azure Storage File Share to a local directory in a batch operation. (autogenerated) - text: | - az storage file download-batch --destination . --pattern *.py --source /path/to/file - crafted: true """ helps['storage file exists'] = """ @@ -1631,10 +1627,6 @@ text: | az storage share url --account-key 00000000 --account-name MyAccount --name MyFileShare crafted: true - - name: Create a URI to access a file share. (autogenerated) - text: | - az storage share url --connection-string $connectionString --name MyFileShare - crafted: true """ helps['storage table'] = """ diff --git a/src/azure-cli/azure/cli/command_modules/vm/_help.py b/src/azure-cli/azure/cli/command_modules/vm/_help.py index 4b108fd4cfd..cde94d53f2c 100644 --- a/src/azure-cli/azure/cli/command_modules/vm/_help.py +++ b/src/azure-cli/azure/cli/command_modules/vm/_help.py @@ -75,7 +75,7 @@ examples: - name: Grant a resource read access to a managed disk. (autogenerated) text: | - az disk grant-access --duration-in-seconds 3600 --name MyManagedDisk --resource-group MyResourceGroup + az disk grant-access --access-level Read --duration-in-seconds 3600 --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ @@ -800,7 +800,6 @@ - name: Convert all VMs with unmanaged disks in a resource group to use managed disks. text: > az vm convert --ids $(az vm list -g MyResourceGroup --query "[].id" -o tsv) - """ helps['vm create'] = """ @@ -2504,10 +2503,6 @@ type: command short-summary: Update a VMSS. examples: - - name: Update a VMSS. (autogenerated) - text: | - az vmss update --name MyScaleSet --resource-group MyResourceGroup --set virtualMachineProfile.storageProfile.imageReference.version=16.04.201801090 - crafted: true - name: Update a VMSS' license type for Azure Hybrid Benefit. text: az vmss update --name MyScaleSet --resource-group MyResourceGroup --license-type windows_server - name: Update a VM instance's protection policies. @@ -2534,14 +2529,14 @@ type: command short-summary: Place the CLI in a waiting state until a condition of a scale set is met. examples: - - name: Place the CLI in a waiting state until a condition of a scale set is met. (autogenerated) - text: | - az vmss wait --created --name MyScaleSet --resource-group MyResourceGroup - crafted: true - name: Place the CLI in a waiting state until the VMSS has been updated. text: az vmss wait --updated --name MyScaleSet --resource-group MyResourceGroup - name: Place the CLI in a waiting state until the VMSS instance has been updated. text: az vmss wait --updated --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup + - name: Place the CLI in a waiting state until a condition of a scale set is met. (autogenerated) + text: | + az vmss wait --created --name MyScaleSet --resource-group MyResourceGroup + crafted: true """ helps['vmss set-orchestration-service-state'] = """