diff --git a/src/azure-cli/azure/cli/command_modules/keyvault/_help.py b/src/azure-cli/azure/cli/command_modules/keyvault/_help.py index 91871b9b3f2..5a484bdeeea 100644 --- a/src/azure-cli/azure/cli/command_modules/keyvault/_help.py +++ b/src/azure-cli/azure/cli/command_modules/keyvault/_help.py @@ -525,6 +525,10 @@ type: command short-summary: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions. This operation requires the storage/delete permission. examples: + - name: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions (autogenerated) + text: | + az keyvault storage remove --id "/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-00000000000000000" + crafted: true - name: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions (autogenerated) text: | az keyvault storage remove --name MyStorageAccount --vault-name MyVault 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 f01383d85ce..8281d9af21e 100644 --- a/src/azure-cli/azure/cli/command_modules/monitor/_help.py +++ b/src/azure-cli/azure/cli/command_modules/monitor/_help.py @@ -318,6 +318,10 @@ text: | az monitor activity-log alert update --enabled true --name MyActivityLogAlerts --resource-group MyResourceGroup --subscription MySubscription crafted: true + - name: Update the details of this activity log alert. (autogenerated) + text: | + az monitor activity-log alert update --name MyActivityLogAlerts --resource-group MyResourceGroup --tags key=value + crafted: true """ helps['monitor activity-log list'] = """ @@ -1004,7 +1008,7 @@ examples: - name: Delete a workspace instance. (autogenerated) text: | - az monitor log-analytics workspace delete --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace delete --force true --resource-group MyResourceGroup --workspace-name MyWorkspace crafted: true """ @@ -1060,7 +1064,7 @@ examples: - name: Get a list of management groups connected to a workspace. (autogenerated) text: | - az monitor log-analytics workspace list-management-groups --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace list-management-groups --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace crafted: true """ @@ -1122,7 +1126,7 @@ 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 + az monitor log-analytics workspace pack enable --name MyIntelligencePack --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace crafted: true """ @@ -1149,6 +1153,11 @@ helps['monitor log-analytics workspace update'] = """ type: command short-summary: Update a workspace instance +examples: + - name: Update a workspace instance. (autogenerated) + text: | + az monitor log-analytics workspace update --resource-group myresourcegroup --retention-time 30 --workspace-name myworkspace + crafted: true """ helps['monitor log-analytics workspace linked-service'] = """ @@ -1226,6 +1235,10 @@ text: az monitor log-analytics workspace linked-storage create --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace --storage-accounts StorageAccount1 StorageAccount2 - name: Create one linked storage accounts for a log analytics workspace using the resource id of the storage account. text: az monitor log-analytics workspace linked-storage create --type AzureWatson -g MyResourceGroup --workspace-name MyWorkspace --storage-accounts /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.Storage/storageAccounts/cli000001 + - name: Create some linked storage accounts for log analytics workspace. (autogenerated) + text: | + az monitor log-analytics workspace linked-storage create --resource-group MyResourceGroup --storage-accounts /subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.Storage/storageAccounts/cli000001 --subscription mysubscription --type CustomLogs --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace linked-storage delete'] = """ @@ -1260,9 +1273,10 @@ type: command short-summary: List all linked storage accounts for a log analytics workspace. examples: - - name: List all linked storage accounts for a log analytics workspace - text: az monitor log-analytics workspace linked-storage list -g MyResourceGroup --workspace-name MyWorkspace - + - name: List all linked storage accounts for a log analytics workspace. (autogenerated) + text: | + az monitor log-analytics workspace linked-storage list --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace linked-storage show'] = """ @@ -1511,10 +1525,6 @@ - name: --remove-actions short-summary: Space-separated list of action group names to remove. examples: - - name: Update a metric-based alert rule. (autogenerated) - text: | - az monitor metrics alert update --enabled true --name MyAlertRule --resource-group MyResourceGroup - crafted: true - name: Disable/Enable a metric-based alert rule. text: | az monitor metrics alert update --enabled false --name MyAlertRule --resource-group MyResourceGroup @@ -1617,9 +1627,11 @@ helps['monitor private-link-scope create'] = """ type: command short-summary: Create a private link scope resource. -example: - - name: Create a private link scope resource - text: az monitor private-link-scope create -g MyRG -n MyScope +examples: + - name: Create a private link scope resource (autogenerated) + text: | + az monitor private-link-scope create --name MyAzureMonitorPrivateLinkScope --resource-group MyResourceRroup + crafted: true """ helps['monitor private-link-scope update'] = """ 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 dfca9a3367d..7e4b064e938 100644 --- a/src/azure-cli/azure/cli/command_modules/network/_help.py +++ b/src/azure-cli/azure/cli/command_modules/network/_help.py @@ -369,7 +369,7 @@ -n MyHttpSettings --port 80 --protocol Http --cookie-based-affinity Disabled --timeout 30 - name: Create HTTP settings. (autogenerated) text: | - az network application-gateway http-settings create --affinity-cookie-name MyAffinityCookie --cookie-based-affinity Enabled --gateway-name MyAppGateway --host-name MyHost --name MyHttpSettings --port 80 --probe MyNewProbe --protocol Http --resource-group MyResourceGroup --timeout 30 + az network application-gateway http-settings create --gateway-name MyAppGateway --host-name MyHost --name MyHttpSettings --port 80 --probe MyNewProbe --protocol Http --resource-group MyResourceGroup crafted: true """ @@ -409,6 +409,10 @@ text: | az network application-gateway http-settings update --enable-probe true --gateway-name MyAppGateway --name MyHttpSettings --probe MyNewProbe --resource-group MyResourceGroup crafted: true + - name: Update HTTP settings. (autogenerated) + text: | + az network application-gateway http-settings update --gateway-name MyAppGateway --host-name-from-backend-pool true --name MyHttpSettings --port 80 --probe MyNewProbe --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway identity'] = """ @@ -712,7 +716,7 @@ examples: - name: Update a rewrite rule. (autogenerated) text: | - az network application-gateway rewrite-rule update --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet + az network application-gateway rewrite-rule update --gateway-name MyGateway --name MyRewriteRule --remove tags.no_80 --resource-group MyResourceGroup --rule-set-name MyRuleSet crafted: true """ @@ -1102,11 +1106,7 @@ -n MyUrlPathMap --default-http-settings MyNewHttpSettings - name: Update a URL path map. (autogenerated) text: | - az network application-gateway url-path-map update --default-address-pool MyAddressPool --default-http-settings MyNewHttpSettings --gateway-name MyAppGateway --name MyUrlPathMap --resource-group MyResourceGroup - crafted: true - - name: Update a URL path map. (autogenerated) - text: | - az network application-gateway url-path-map update --gateway-name MyAppGateway --name MyUrlPathMap --resource-group MyResourceGroup --set useRemoteGateways=true + az network application-gateway url-path-map update --default-address-pool MyAddressPool --default-http-settings MyNewHttpSettings --gateway-name MyAppGateway --name MyUrlPathMap --remove tags.no_80 --resource-group MyResourceGroup crafted: true """ @@ -1243,7 +1243,7 @@ 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 + az network application-gateway waf-policy policy-setting update --mode Prevention --policy-name MyPolicy --resource-group MyResourceGroup --state Disabled crafted: true """ @@ -1265,11 +1265,21 @@ helps['network application-gateway waf-policy custom-rule create'] = """ type: command short-summary: Create an application gateway WAF policy custom rule. +examples: + - name: Create an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule create --action Allow --name MyWafPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule + crafted: true """ helps['network application-gateway waf-policy custom-rule delete'] = """ type: command short-summary: Delete an application gateway WAF policy custom rule. +examples: + - name: Delete an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule delete --name MyWafPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network application-gateway waf-policy custom-rule list'] = """ @@ -1325,6 +1335,10 @@ text: | az network application-gateway waf-policy custom-rule update --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --set useRemoteGateways=true crafted: true + - name: Update an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule update --action Allow --name MyWAFPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule + crafted: true """ helps['network application-gateway waf-policy managed-rule'] = """ @@ -1348,6 +1362,10 @@ - name: Disable an attack protection rule text: | az network application-gateway waf-policy managed-rule rule-set add --policy-name MyPolicy -g MyResourceGroup --type OWASP --version 3.1 --group-name REQUEST-921-PROTOCOL-ATTACK --rules 921110 + - name: Add managed rule set to the WAF policy managed rules (autogenerated) + text: | + az network application-gateway waf-policy managed-rule rule-set add --policy-name MyPolicy --resource-group MyResourceGroup --type Microsoft_BotManagerRuleSet --version 0.1 + crafted: true """ helps['network application-gateway waf-policy managed-rule rule-set update'] = """ @@ -2064,6 +2082,10 @@ examples: - name: Create an empty PTR record set. text: az network dns record-set ptr create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty PTR record set. (autogenerated) + text: | + az network dns record-set ptr create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network dns record-set ptr delete'] = """ @@ -2072,6 +2094,10 @@ examples: - name: Delete a PTR record set and all associated records. text: az network dns record-set ptr delete -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Delete a PTR record set and all associated records. (autogenerated) + text: | + az network dns record-set ptr delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com + crafted: true """ helps['network dns record-set ptr list'] = """ @@ -2142,6 +2168,10 @@ text: | az network dns record-set soa update -g MyResourceGroup -z www.mysite.com \\ -e myhostmaster.mysite.com + - name: Update properties of an SOA record. (autogenerated) + text: | + az network dns record-set soa update --email myhostmaster.mysite.com --only-show-errors --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network dns record-set srv'] = """ @@ -2468,6 +2498,10 @@ - name: Delete an ExpressRoute circuit. text: > az network express-route delete -n MyCircuit -g MyResourceGroup + - name: Delete an ExpressRoute circuit. (autogenerated) + text: | + az network express-route delete --name MyCircuit --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network express-route gateway'] = """ @@ -2487,6 +2521,10 @@ - name: Create an ExpressRoute gateway connection. text: | az network express-route gateway connection create --gateway-name MyGateway -n MyExpressRouteConnection -g MyResourceGroup --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --associated-route-table /MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables /MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 /MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2 --labels label1 label2 + - name: Create an ExpressRoute gateway connection. (autogenerated) + text: | + az network express-route gateway connection create --gateway-name MyGateway --name MyExpressRouteConnection --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --resource-group MyResourceGroup + crafted: true """ helps['network express-route gateway connection delete'] = """ @@ -2660,6 +2698,10 @@ --peering-type MicrosoftPeering --peer-asn 10002 --vlan-id 103 \\ --primary-peer-subnet 101.0.0.0/30 --secondary-peer-subnet 102.0.0.0/30 \\ --advertised-public-prefixes 101.0.0.0/30 + - name: Create peering settings for an ExpressRoute circuit. (autogenerated) + text: | + az network express-route peering create --circuit-name MyCircuit --peer-asn 10002 --peering-type AzurePublicPeering --primary-peer-subnet 101.0.0.0/30 --resource-group MyResourceGroup --secondary-peer-subnet 102.0.0.0/30 --shared-key Abc123 --vlan-id 103 + crafted: true """ helps['network express-route peering delete'] = """ @@ -2786,6 +2828,11 @@ helps['network express-route port list'] = """ type: command short-summary: List ExpressRoute ports. +examples: + - name: List ExpressRoute ports. (autogenerated) + text: | + az network express-route port list --resource-group myresourcegroup + crafted: true """ helps['network express-route port location'] = """ @@ -3138,7 +3185,7 @@ crafted: true - name: Update an inbound NAT address pool. (autogenerated) text: | - az network lb inbound-nat-pool update --backend-port 8080 --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup + az network lb inbound-nat-pool update --backend-port 8080 --floating-ip true --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup crafted: true """ @@ -3262,7 +3309,7 @@ examples: - name: Update an outbound-rule. (autogenerated) text: | - az network lb outbound-rule update --enable-tcp-reset true --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup + az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup crafted: true """ @@ -3317,7 +3364,7 @@ text: az network lb probe update -g MyResourceGroup --lb-name MyLb -n MyProbe --port 81 --interval 10 - name: Update a probe. (autogenerated) text: | - az network lb probe update --lb-name MyLb --name MyProbe --port 81 --resource-group MyResourceGroup --subscription MySubscription + az network lb probe update --lb-name MyLb --name MyProbe --port 81 --protocol Http --resource-group MyResourceGroup crafted: true """ @@ -3387,6 +3434,10 @@ text: | az network lb rule update --disable-outbound-snat true --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup crafted: true + - name: Update a load balancing rule. (autogenerated) + text: | + az network lb rule update --idle-timeout 5 --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup + crafted: true """ helps['network lb show'] = """ @@ -3725,6 +3776,10 @@ examples: - name: Pause CLI until the network interface is created. text: az network nic wait -g MyResourceGroup -n MyNic --created + - name: Place the CLI in a waiting state until a condition of the network interface is met. (autogenerated) + text: | + az network nic wait --deleted --name MyNic --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network nsg'] = """ @@ -4467,7 +4522,7 @@ text: az network route-table route update -g MyResourceGroup --route-table-name MyRouteTable \\ -n MyRoute --next-hop-ip-address 10.0.100.5 - name: Update a route in a route table. (autogenerated) text: | - az network route-table route update --address-prefix 10.0.0.0/16 --name MyRoute --next-hop-ip-address 10.0.100.5 --next-hop-type VirtualNetworkGateway --route-table-name MyRouteTable + az network route-table route update --address-prefix 10.0.0.0/16 --name MyRoute --next-hop-ip-address 10.0.100.5 --next-hop-type VirtualNetworkGateway --resource-group MyResourceGroup --route-table-name MyRouteTable crafted: true """ @@ -4554,6 +4609,11 @@ helps['network service-endpoint policy-definition delete'] = """ type: command short-summary: Delete a service endpoint policy definition. +examples: + - name: Delete a service endpoint policy definition (autogenerated) + text: | + az network service-endpoint policy-definition delete --name myserviceendpointpolicydefinition --policy-name mypolicy --resource-group myresourcegroup + crafted: true """ helps['network service-endpoint policy-definition list'] = """ @@ -4562,13 +4622,18 @@ examples: - name: List service endpoint policy definitions. (autogenerated) text: | - az network service-endpoint policy-definition list --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription + az network service-endpoint policy-definition list --policy-name MyPolicy --resource-group MyResourceGroup crafted: true """ helps['network service-endpoint policy-definition show'] = """ type: command short-summary: Get the details of a service endpoint policy definition. +examples: + - name: Get the details of a service endpoint policy definition. (autogenerated) + text: | + az network service-endpoint policy-definition show --name myserviceendpointpolicydefinition --policy-name mypolicy --resource-group myresourcegroup + crafted: true """ helps['network service-endpoint policy-definition update'] = """ @@ -4721,10 +4786,6 @@ text: | az network traffic-manager profile update --name MyTmProfile --resource-group MyResourceGroup --status Enabled crafted: true - - name: Update a traffic manager profile. (autogenerated) - text: | - az network traffic-manager profile update --name MyTmProfile --path "/" --routing-method Performance - crafted: true """ helps['network vnet'] = """ @@ -5150,10 +5211,6 @@ text: | az network vnet-gateway update --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 --name MyVnetGateway --resource-group MyResourceGroup crafted: true - - name: Update a virtual network gateway. (autogenerated) - text: | - az network vnet-gateway update --name MyVnetGateway --remove tags.no_80 --resource-group MyResourceGroup - crafted: true """ helps['network vnet-gateway vpn-client'] = """ @@ -5335,6 +5392,10 @@ examples: - name: Reset the shared key on a connection. text: az network vpn-connection shared-key reset -g MyResourceGroup --connection-name MyConnection --key-length 128 + - name: Reset a VPN connection shared key. (autogenerated) + text: | + az network vpn-connection shared-key reset --connection-name MyConnection --key-length 128 --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network vpn-connection shared-key show'] = """ @@ -5394,6 +5455,11 @@ helps['network vrouter update'] = """ type: command short-summary: Update a virtual router. +examples: + - name: Update a virtual router. (autogenerated) + text: | + az network vrouter update --name myvirtualrouter --resource-group myresourcegroup --tags super_secure no_80 no_22 + crafted: true """ helps['network vrouter show'] = """ @@ -5626,11 +5692,21 @@ helps['network watcher connection-monitor endpoint show'] = """ type: command short-summary: Show an endpoint from a connection monitor +examples: + - name: Show an endpoint from a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor endpoint show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitorendpoint --subscription MySubscription + crafted: true """ helps['network watcher connection-monitor endpoint list'] = """ type: command short-summary: List all endpoints form a connection monitor +examples: + - name: List all endpoints form a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor endpoint list --connection-monitor MyConnectionMonitor --location westus2 + crafted: true """ @@ -5686,11 +5762,21 @@ helps['network watcher connection-monitor test-configuration show'] = """ type: command short-summary: Show a test configuration from a connection monitor +examples: + - name: Show a test configuration from a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-configuration show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestConfiguration + crafted: true """ helps['network watcher connection-monitor test-configuration list'] = """ type: command short-summary: List all test configurations of a connection monitor +examples: + - name: List all test configurations of a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-configuration list --connection-monitor MyConnectionMonitor --location westus2 + crafted: true """ helps['network watcher connection-monitor test-group'] = """ @@ -5739,16 +5825,31 @@ helps['network watcher connection-monitor test-group remove'] = """ type: command short-summary: Remove test group from a connection monitor +examples: + - name: Remove test group from a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-group remove --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup + crafted: true """ helps['network watcher connection-monitor test-group show'] = """ type: command short-summary: Show a test group of a connection monitor +examples: + - name: Show a test group of a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-group show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup --subscription MySubscription + crafted: true """ helps['network watcher connection-monitor test-group list'] = """ type: command short-summary: List all test groups of a connection monitor +examples: + - name: List all test groups of a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-group list --connection-monitor MyConnectionMonitor --location westus2 + crafted: true """ helps['network watcher connection-monitor output'] = """ @@ -5834,7 +5935,7 @@ examples: - name: Delete the specified flow log resource. (autogenerated) text: | - az network watcher flow-log delete --location westus2 --name MyFlowLogger --subscription MySubscription + az network watcher flow-log delete --location westus2 --name MyFlowLogger crafted: true """ @@ -6196,7 +6297,7 @@ type: command short-summary: Show a Azure bastion host machine. examples: - - name: Show a Azure bastion host machine (autogenerated) + - name: Show a Azure bastion host machine. (autogenerated) text: | az network bastion show --name MyBastionHost --resource-group MyResourceGroup crafted: true 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 90b2495676e..a7914c7934c 100644 --- a/src/azure-cli/azure/cli/command_modules/privatedns/_help.py +++ b/src/azure-cli/azure/cli/command_modules/privatedns/_help.py @@ -254,6 +254,10 @@ examples: - name: Create an empty CNAME record set. text: az network private-dns record-set cname create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty CNAME record set (autogenerated) + text: | + az network private-dns record-set cname create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --ttl 300 --zone-name www.mysite.com + crafted: true """ helps['network private-dns record-set cname delete'] = """ @@ -305,6 +309,10 @@ examples: - name: Get the details of a CNAME record set. text: az network private-dns record-set cname show -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Get the details of a CNAME record set (autogenerated) + text: | + az network private-dns record-set cname show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network private-dns record-set cname update'] = """ 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 1dedc34d16a..a93228ea995 100644 --- a/src/azure-cli/azure/cli/command_modules/resource/_help.py +++ b/src/azure-cli/azure/cli/command_modules/resource/_help.py @@ -493,7 +493,7 @@ examples: - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) text: | - az deployment sub wait --name MyDeployment --created + az deployment sub wait --created --name MyDeployment crafted: true """ @@ -505,6 +505,11 @@ helps['deployment operation sub list'] = """ type: command short-summary: List deployment operations at subscription scope. +examples: + - name: List deployment operations at subscription scope. (autogenerated) + text: | + az deployment operation sub list --name mydeployment + crafted: true """ helps['deployment operation sub show'] = """ @@ -759,6 +764,10 @@ examples: - name: Validate whether a template is valid at management group. text: az deployment mg validate --management-group-id testmg --location WestUS --template-file {template-file} + - name: Validate whether a template is valid at management group. (autogenerated) + text: | + az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json + crafted: true """ helps['deployment mg what-if'] = """ @@ -923,6 +932,10 @@ examples: - name: Validate whether a template is valid at tenant scope. text: az deployment tenant validate --location WestUS --template-file {template-file} + - name: Validate whether a template is valid at tenant scope. (autogenerated) + text: | + az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json + crafted: true """ helps['deployment tenant what-if'] = """ @@ -1434,7 +1447,7 @@ examples: - name: Delete a managed application. (autogenerated) text: | - az managedapp delete --name MyManagedApplication --resource-group MyResourceGroup + az managedapp delete --name MyManagedApplication --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -2046,13 +2059,17 @@ type: command short-summary: Update a resource. examples: - - name: Update a webapp. (autogenerated) - text: | - az resource update --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --set tags.key=value - crafted: true - name: Update a webapp by using the latest api-version whether this version is a preview version. text: > az resource update --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --set tags.key=value --latest-include-preview + - name: Update a resource. (autogenerated) + text: | + az resource update --ids $id --set properties.connectionType=Proxy + crafted: true + - name: Update a resource. (autogenerated) + text: | + az resource update --name myresource --resource-group myresourcegroup --resource-type subnets --set tags.key=value + crafted: true """ helps['resource wait'] = """ 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 0dd14419a53..fc00b8dc483 100644 --- a/src/azure-cli/azure/cli/command_modules/storage/_help.py +++ b/src/azure-cli/azure/cli/command_modules/storage/_help.py @@ -103,6 +103,10 @@ - name: Create an encryption scope within storage account based on Micosoft.KeyVault key source. text: | az storage account encryption-scope create --name myencryption -s Microsoft.KeyVault -u "https://vaultname.vault.azure.net/keys/keyname/1f7fa7edc99f4cdf82b5b5f32f2a50a7" --account-name mystorageaccount -g MyResourceGroup + - name: Create an encryption scope within storage account. (autogenerated) + text: | + az storage account encryption-scope create --account-name mystorageaccount --key-source Microsoft.Storage --name myencryption --resource-group MyResourceGroup --subscription mysubscription + crafted: true """ helps['storage account encryption-scope list'] = """ @@ -262,6 +266,11 @@ helps['storage account management-policy create'] = """ type: command short-summary: Create the data policy rules associated with the specified storage account. +examples: + - name: Create the data policy rules associated with the specified storage account. (autogenerated) + text: | + az storage account management-policy create --account-name myaccount --policy @policy.json --resource-group myresourcegroup + crafted: true """ helps['storage account management-policy update'] = """ @@ -790,6 +799,10 @@ text: | az storage blob incremental-copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-blob MyBlob --source-container MySourceContainer --source-snapshot MySnapshot crafted: true + - name: Copy an incremental copy of a blob asynchronously. (autogenerated) + text: | + az storage blob incremental-copy start --connection-string myconnectionstring --destination-blob mydestinationblob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos + crafted: true """ helps['storage blob lease'] = """ @@ -872,6 +885,10 @@ text: | az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 crafted: true + - name: Show the storage blob delete-policy. (autogenerated) + text: | + az storage blob service-properties delete-policy show --account-name mystorageccount --auth-mode login + crafted: true """ helps['storage blob service-properties delete-policy update'] = """ @@ -1569,6 +1586,10 @@ text: | az storage file generate-sas --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --path path/file.txt --permissions rcdw --share-name MyShare --start 2019-01-01T12:20Z crafted: true + - name: Generate a shared access signature for the file. (autogenerated) + text: | + az storage file generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2037-12-31T23:59:00Z --https-only --path path/file.txt --permissions rcdw --share-name myshare + crafted: true """ helps['storage file list'] = """ @@ -1646,7 +1667,7 @@ examples: - name: Create the url to access a file. (autogenerated) text: | - az storage file url --account-name MyAccount --path path/file.txt --share-name MyShare + az storage file url --account-key 00000000 --account-name mystorageaccount --path path/file.txt --share-name myshare crafted: true """ @@ -1753,6 +1774,10 @@ - name: Create file system for Azure Data Lake Storage Gen2 account and enable public access. text: | az storage fs create -n fsname --public-access file --account-name mystorageaccount --account-key 0000-0000 + - name: Create file system for Azure Data Lake Storage Gen2 account. (autogenerated) + text: | + az storage fs create --account-name mystorageaccount --auth-mode login --name fsname + crafted: true """ helps['storage fs delete'] = """ @@ -1785,6 +1810,10 @@ examples: - name: Show properties of file system in ADLS Gen2 account. text: az storage fs show -n myfilesystem --account-name myadlsaccount --account-key 0000-0000 + - name: Show properties of file system in ADLS Gen2 account. (autogenerated) + text: | + az storage fs show --account-name myadlsaccount --auth-mode login --name myfilesystem + crafted: true """ helps['storage fs directory'] = """ @@ -1808,6 +1837,10 @@ examples: - name: Delete a directory in ADLS Gen2 file system. text: az storage fs directory delete -n dir -f myfilesystem --account-name myadlsaccount --account-key 0000-0000 + - name: Delete a directory in ADLS Gen2 file system. (autogenerated) + text: | + az storage fs directory delete --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --yes + crafted: true """ helps['storage fs directory exists'] = """ @@ -1816,6 +1849,10 @@ examples: - name: Check for the existence of a directory in ADLS Gen2 file system. text: az storage fs directory exists -n dir -f myfilesystem --account-name myadlsaccount --account-key 0000-0000 + - name: Check for the existence of a directory in ADLS Gen2 file system. (autogenerated) + text: | + az storage fs directory exists --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + crafted: true """ helps['storage fs directory list'] = """ @@ -1847,6 +1884,10 @@ examples: - name: Move a directory a directory in ADLS Gen2 file system. text: az storage fs directory move --new-directory newfs/dir -n dir -f myfilesystem --account-name myadlsaccount --account-key 0000-0000 + - name: Move a directory in ADLS Gen2 file system. (autogenerated) + text: | + az storage fs directory move --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --new-directory newfs/dir + crafted: true """ helps['storage fs directory show'] = """ @@ -1857,6 +1898,10 @@ text: az storage fs directory show -n dir -f myfilesystem --account-name myadlsaccount --account-key 0000-0000 - name: Show properties of a subdirectory in ADLS Gen2 file system. text: az storage fs directory show -n dir/subdir -f myfilesystem --account-name myadlsaccount --account-key 0000-0000 + - name: Show properties of a directory in ADLS Gen2 file system. (autogenerated) + text: | + az storage fs directory show --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + crafted: true """ helps['storage fs file'] = """ @@ -1962,6 +2007,10 @@ - name: Show properties of file in ADLS Gen2 file system. text: | az storage fs file show -p dir/a.txt -f fsname --account-name myadlsaccount --account-key 0000-0000 + - name: Show properties of file in ADLS Gen2 file system. (autogenerated) + text: | + az storage fs file show --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt + crafted: true """ helps['storage fs file upload'] = """ @@ -2078,7 +2127,7 @@ text: | az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt crafted: true - - name: Update metrics settings for a storage account. (autogenerated) + - name: Update metrics settings for a storage account by connection string. (autogenerated) text: | az storage metrics update --api true --connection-string $connectionString --hour true --minute true --retention 10 --services bfqt crafted: true 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 789ab9a0b07..84652a50f80 100644 --- a/src/azure-cli/azure/cli/command_modules/vm/_help.py +++ b/src/azure-cli/azure/cli/command_modules/vm/_help.py @@ -105,13 +105,13 @@ type: command short-summary: Update a managed disk. examples: + - name: Update a managed disk and associate it with a disk access resource. + text: | + az disk update --name MyManagedDisk --resource-group MyResourceGroup --network-access-policy AllowPrivate --disk-access MyDiskAccessID - name: Update a managed disk. (autogenerated) text: | az disk update --name MyManagedDisk --resource-group MyResourceGroup --size-gb 20 crafted: true - - name: Update a managed disk and associate it with a disk access resource. - text: | - az disk update --name MyManagedDisk --resource-group MyResourceGroup --network-access-policy AllowPrivate --disk-access MyDiskAccessID """ helps['disk wait'] = """ @@ -122,6 +122,10 @@ text: | az disk wait --created --name MyManagedDisk --resource-group MyResourceGroup crafted: true + - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) + text: | + az disk wait --deleted --name MyManagedDisk --resource-group MyResourceGroup --subscription mysubscription + crafted: true """ helps['disk-access'] = """ @@ -597,7 +601,7 @@ examples: - name: update a share image defintiion. (autogenerated) text: | - az sig image-definition update --gallery-image-definition MyImage --gallery-name MyGallery --resource-group MyResourceGroup + az sig image-definition update --gallery-image-definition MyImage --gallery-name MyGallery --resource-group MyResourceGroup --set publishingProfile.excludeFromLatest=true crafted: true """ @@ -649,6 +653,10 @@ - name: Update --exclude-from-latest. If it is set to true, people deploying VMs with version omitted will not use this version. text: | az sig image-version update -g MyResourceGroup --gallery-name MyGallery --gallery-image-definition MyImage --gallery-image-version 1.0.0 --set publishingProfile.excludeFromLatest=true + - name: update a share image version. (autogenerated) + text: | + az sig image-version update --gallery-image-definition MyImage --gallery-image-version 1.0.0 --gallery-name MyGallery --resource-group MyResourceGroup --set publishingProfile.excludeFromLatest=true + crafted: true """ helps['sig image-version wait'] = """ @@ -658,6 +666,10 @@ - name: wait for an image version gets updated text: | az sig image-version wait --updated -g MyResourceGroup --gallery-name MyGallery --gallery-image-definition MyImage --gallery-image-version 1.0.0 + - name: wait for image version related operation. (autogenerated) + text: | + az sig image-version wait --created --gallery-image-definition MyImage --gallery-image-version 1.0.0 --gallery-name MyGallery --resource-group MyResourceGroup + crafted: true """ helps['sig list'] = """ @@ -668,6 +680,11 @@ helps['sig update'] = """ type: command short-summary: update a share image gallery. +examples: + - name: update a share image gallery. (autogenerated) + text: | + az sig update --gallery-name mygallery --resource-group myresourcegroup --set publishingProfile.excludeFromLatest=true + crafted: true """ helps['snapshot'] = """ @@ -720,13 +737,13 @@ type: command short-summary: Update a snapshot. examples: + - name: Update a snapshot and associate it with a disk access resource. + text: | + az snapshot update --name MySnapshot --resource-group MyResourceGroup --network-access-policy AllowPrivate --disk-access MyDiskAccessID - name: Update a snapshot. (autogenerated) text: | az snapshot update --name MySnapshot --resource-group MyResourceGroup --subscription MySubscription crafted: true - - name: Update a snapshot and associate it with a disk access resource. - text: | - az snapshot update --name MySnapshot --resource-group MyResourceGroup --network-access-policy AllowPrivate --disk-access MyDiskAccessID """ helps['snapshot wait'] = """ @@ -1429,6 +1446,10 @@ text: |- az vm host create --host-group my-host-group --name my-host --platform-fault-domain 0 \\ --auto-replace false --resource-group my-resource-group --sku ESv3-Type1 --location eastasia + - name: Create a dedicated host (autogenerated) + text: | + az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1 + crafted: true """ helps['vm host get-instance-view'] = """ @@ -2611,9 +2632,9 @@ populator-commands: - az vmss run-command list examples: - - name: vmss run-command show (autogenerated) + - name: Gets specific run command for a subscription in a location. (autogenerated) text: | - az vmss run-command show --command-id RunShellScript --location westus2 + az vmss run-command show --command-id RunShellScript --location westus2 --subscription mysubscription crafted: true """ @@ -2799,6 +2820,6 @@ examples: - name: List the metric definitions for a VM. (autogenerated) text: | - az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup --subscription MySubscription + az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup crafted: true """