diff --git a/src/azure-cli/azure/cli/command_modules/cloud/_help.py b/src/azure-cli/azure/cli/command_modules/cloud/_help.py index 877929544db..8d0750caa33 100644 --- a/src/azure-cli/azure/cli/command_modules/cloud/_help.py +++ b/src/azure-cli/azure/cli/command_modules/cloud/_help.py @@ -33,7 +33,8 @@ short-summary: Set the active cloud. examples: - name: Set the active cloud. (autogenerated) - text: az cloud set --name MyRegisteredCloud + text: | + az cloud set --name MyRegisteredCloud crafted: true """ @@ -47,7 +48,8 @@ short-summary: Unregister a cloud. examples: - name: Unregister a cloud. (autogenerated) - text: az cloud unregister --name MyRegisteredCloud + text: | + az cloud unregister --name MyRegisteredCloud crafted: true """ @@ -56,6 +58,7 @@ short-summary: Update the configuration of a cloud. examples: - name: Update the configuration of a cloud. (autogenerated) - text: az cloud update --profile latest + text: | + az cloud update --profile latest crafted: true """ 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 9bd14c00d09..d61fa1647ba 100644 --- a/src/azure-cli/azure/cli/command_modules/keyvault/_help.py +++ b/src/azure-cli/azure/cli/command_modules/keyvault/_help.py @@ -116,7 +116,8 @@ long-summary: Default permissions are created for the current user or service principal unless the `--no-self-perms` flag is specified. examples: - name: Create a key vault. (autogenerated) - text: az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup + text: | + az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup crafted: true """ @@ -125,7 +126,8 @@ short-summary: Delete a key vault. examples: - name: Delete a key vault. (autogenerated) - text: az keyvault delete --name MyKeyVault --resource-group MyResourceGroup + text: | + az keyvault delete --name MyKeyVault --resource-group MyResourceGroup crafted: true """ @@ -175,7 +177,8 @@ long-summary: Recovers a previously deleted key vault for which soft delete was enabled. examples: - name: Recover a key vault. (autogenerated) - text: az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup + text: | + az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup crafted: true """ @@ -194,7 +197,8 @@ short-summary: Show details of a key vault. examples: - name: Show details of a key vault. (autogenerated) - text: az keyvault show --name MyKeyVault + text: | + az keyvault show --name MyKeyVault crafted: true """ @@ -257,6 +261,7 @@ short-summary: Update the properties of a key vault. examples: - name: Update the properties of a key vault. (autogenerated) - text: az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup + text: | + az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup crafted: true """ 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 f5fd21e44e1..c1c55bf28b9 100644 --- a/src/azure-cli/azure/cli/command_modules/monitor/_help.py +++ b/src/azure-cli/azure/cli/command_modules/monitor/_help.py @@ -62,7 +62,8 @@ short-summary: The short name of the action group examples: - name: Create a new action group (autogenerated) - text: az monitor action-group create --action webhook https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup + text: | + az monitor action-group create --action webhook https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup crafted: true """ @@ -82,7 +83,8 @@ short-summary: Show the details of an action group examples: - name: Show the details of an action group (commonly used with --output and --query). (autogenerated) - text: az monitor action-group show --name MyActionGroup --resource-group MyResourceGroup + text: | + az monitor action-group show --name MyActionGroup --resource-group MyResourceGroup crafted: true """ @@ -133,7 +135,8 @@ short-summary: Remove receivers from the action group. Accept space-separated list of receiver names. examples: - name: Update an action group (autogenerated) - text: az monitor action-group update --name MyActionGroup --resource-group MyResourceGroup --set retentionPolicy.days=365 --subscription MySubscription + text: | + az monitor action-group update --name MyActionGroup --resource-group MyResourceGroup --set retentionPolicy.days=365 --subscription MySubscription crafted: true """ @@ -313,7 +316,8 @@ text: > az monitor activity-log alert update -n {AlertName} -g {ResourceGroup} --enable false - name: Update the details of this activity log alert (autogenerated) - text: az monitor activity-log alert update --enabled true --name MyActivityLogAlerts --resource-group MyResourceGroup --subscription MySubscription + text: | + az monitor activity-log alert update --enabled true --name MyActivityLogAlerts --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -405,7 +409,8 @@ short-summary: Delete an alert rule. examples: - name: Delete an alert rule. (autogenerated) - text: az monitor alert delete --name MyAlertRule --resource-group MyResourceGroup + text: | + az monitor alert delete --name MyAlertRule --resource-group MyResourceGroup crafted: true """ @@ -414,7 +419,8 @@ short-summary: List alert rules in a resource group. examples: - name: List alert rules in a resource group. (autogenerated) - text: az monitor alert list --resource-group MyResourceGroup + text: | + az monitor alert list --resource-group MyResourceGroup crafted: true """ @@ -423,7 +429,8 @@ short-summary: List all incidents for an alert rule. examples: - name: List all incidents for an alert rule. (autogenerated) - text: az monitor alert list-incidents --resource-group MyResourceGroup --rule-name MyRule + text: | + az monitor alert list-incidents --resource-group MyResourceGroup --rule-name MyRule crafted: true """ @@ -432,7 +439,8 @@ short-summary: Show an alert rule. examples: - name: Show an alert rule. (autogenerated) - text: az monitor alert show --name MyAlertRule --resource-group MyResourceGroup + text: | + az monitor alert show --name MyAlertRule --resource-group MyResourceGroup crafted: true """ @@ -484,10 +492,12 @@ Time span over which to apply --aggregation, in nDnHnMnS shorthand or full ISO8601 format. examples: - name: Update a classic metric-based alert rule. (autogenerated) - text: az monitor alert update --email-service-owners true --name MyAlertRule --resource-group MyResourceGroup + text: | + az monitor alert update --email-service-owners true --name MyAlertRule --resource-group MyResourceGroup crafted: true - name: Update a classic metric-based alert rule. (autogenerated) - text: az monitor alert update --name MyAlertRule --remove-action email bob@contoso.com --resource-group MyResourceGroup + text: | + az monitor alert update --name MyAlertRule --remove-action email bob@contoso.com --resource-group MyResourceGroup crafted: true """ @@ -527,7 +537,8 @@ text: > az monitor autoscale create -g {myrg} --resource {resource-id} --count 4 - name: Create new autoscale settings. (autogenerated) - text: az monitor autoscale create --count 3 --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource myScaleSet --resource-group MyResourceGroup --resource-type Microsoft.Compute/virtualMachineScaleSets + text: | + az monitor autoscale create --count 3 --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource myScaleSet --resource-group MyResourceGroup --resource-type Microsoft.Compute/virtualMachineScaleSets crafted: true """ @@ -592,6 +603,10 @@ az monitor autoscale profile create -g {myrg} --autoscale-name {name} -n weeekend \\ --copy-rules default --min-count 1 --count 2 --max-count 2 \\ --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" + crafted: true """ helps['monitor autoscale profile delete'] = """ @@ -599,7 +614,8 @@ short-summary: Delete an autoscale profile. examples: - name: Delete an autoscale profile. (autogenerated) - text: az monitor autoscale profile delete --autoscale-name MyAutoscale --name MyAutoscaleProfile --resource-group MyResourceGroup + text: | + az monitor autoscale profile delete --autoscale-name MyAutoscale --name MyAutoscaleProfile --resource-group MyResourceGroup crafted: true """ @@ -608,7 +624,8 @@ short-summary: List autoscale profiles. examples: - name: List autoscale profiles. (autogenerated) - text: az monitor autoscale profile list --autoscale-name MyAutoscale --resource-group MyResourceGroup + text: | + az monitor autoscale profile list --autoscale-name MyAutoscale --resource-group MyResourceGroup crafted: true """ @@ -684,7 +701,8 @@ short-summary: List autoscale rules for a profile. examples: - name: List autoscale rules for a profile. (autogenerated) - text: az monitor autoscale rule list --autoscale-name MyAutoscale --profile-name MyProfile --resource-group MyResourceGroup + text: | + az monitor autoscale rule list --autoscale-name MyAutoscale --profile-name MyProfile --resource-group MyResourceGroup crafted: true """ @@ -693,7 +711,8 @@ short-summary: Show autoscale setting details. examples: - name: Show autoscale setting details. (autogenerated) - text: az monitor autoscale show --name MyAutoscaleSettings --resource-group MyResourceGroup + text: | + az monitor autoscale show --name MyAutoscaleSettings --resource-group MyResourceGroup crafted: true """ @@ -726,7 +745,8 @@ az monitor autoscale update -g {myrg} -n {autoscale-name} \\ --remove-action email bob@contoso.com - name: Update autoscale settings. (autogenerated) - text: az monitor autoscale update --count 3 --email-administrator true --enabled true --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource-group MyResourceGroup --tags key[=value] + text: | + az monitor autoscale update --count 3 --email-administrator true --enabled true --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource-group MyResourceGroup --tags key[=value] crafted: true """ @@ -740,7 +760,8 @@ short-summary: Updates an autoscale setting. examples: - name: Updates an autoscale setting. (autogenerated) - text: az monitor autoscale-settings update --name MyAutoscaleSetting --resource-group MyResourceGroup --set retentionPolicy.days=365 + text: | + az monitor autoscale-settings update --name MyAutoscaleSetting --resource-group MyResourceGroup --set retentionPolicy.days=365 crafted: true """ @@ -826,7 +847,8 @@ short-summary: Update diagnostic settings. examples: - name: Update diagnostic settings. (autogenerated) - text: az monitor diagnostic-settings update --name MyDiagnosticSetting --resource myScaleSet --set retentionPolicy.days=365 + text: | + az monitor diagnostic-settings update --name MyDiagnosticSetting --resource myScaleSet --set retentionPolicy.days=365 crafted: true """ @@ -851,6 +873,11 @@ helps['monitor log-analytics workspace delete'] = """ type: command short-summary: Delete a workspace instance. +examples: + - name: Delete a workspace instance. (autogenerated) + text: | + az monitor log-analytics workspace delete --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace get-schema'] = """ @@ -859,11 +886,21 @@ long-summary: > Schema represents the internal structure of the workspace, which can be used during the query. For more information, visit: https://docs.microsoft.com/en-us/rest/api/loganalytics/workspaces%202015-03-20/getschema +examples: + - name: Get the schema for a given workspace. (autogenerated) + text: | + az monitor log-analytics workspace get-schema --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace get-shared-keys'] = """ type: command short-summary: Get the shared keys for a workspace. +examples: + - name: Get the shared keys for a workspace. (autogenerated) + text: | + az monitor log-analytics workspace get-shared-keys --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace list'] = """ @@ -874,11 +911,21 @@ helps['monitor log-analytics workspace list-management-groups'] = """ type: command short-summary: Get a list of management groups connected to a workspace. +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 + crafted: true """ helps['monitor log-analytics workspace list-usages'] = """ type: command short-summary: Get a list of usage metrics for a workspace. +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 + crafted: true """ helps['monitor log-analytics workspace pack'] = """ @@ -904,6 +951,11 @@ helps['monitor log-analytics workspace show'] = """ type: command short-summary: Show a workspace instance. +examples: + - name: Show a workspace instance. (autogenerated) + text: | + az monitor log-analytics workspace show --resource-group MyResourceGroup --workspace-name MyWorkspace + crafted: true """ helps['monitor log-analytics workspace update'] = """ @@ -946,7 +998,8 @@ short-summary: Update a log profile. examples: - name: Update a log profile. (autogenerated) - text: az monitor log-profiles update --name MyLogProfile --set retentionPolicy.days=365 + text: | + az monitor log-profiles update --name MyLogProfile --set retentionPolicy.days=365 crafted: true """ @@ -1006,7 +1059,8 @@ short-summary: Delete a metrics-based alert rule. examples: - name: Delete a metrics-based alert rule. (autogenerated) - text: az monitor metrics alert delete --name MyAlertRule --resource-group MyResourceGroup + text: | + az monitor metrics alert delete --name MyAlertRule --resource-group MyResourceGroup crafted: true """ @@ -1015,7 +1069,8 @@ short-summary: List metric-based alert rules. examples: - name: List metric-based alert rules. (autogenerated) - text: az monitor metrics alert list --resource-group MyResourceGroup + text: | + az monitor metrics alert list --resource-group MyResourceGroup crafted: true """ @@ -1024,7 +1079,8 @@ short-summary: Show a metrics-based alert rule. examples: - name: Show a metrics-based alert rule. (autogenerated) - text: az monitor metrics alert show --name MyAlertRule --resource-group MyResourceGroup + text: | + az monitor metrics alert show --name MyAlertRule --resource-group MyResourceGroup crafted: true """ @@ -1056,7 +1112,8 @@ 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 + text: | + az monitor metrics alert update --enabled true --name MyAlertRule --resource-group MyResourceGroup crafted: true """ @@ -1135,6 +1192,7 @@ short-summary: Lists the metric definitions for the resource. examples: - name: Lists the metric definitions for the resource. (autogenerated) - text: az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/Space1999/providers/Microsoft.Network/networkSecurityGroups/ADDS-NSG + text: | + az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/Space1999/providers/Microsoft.Network/networkSecurityGroups/ADDS-NSG crafted: true """ 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 61582f2a529..a9832230fd3 100644 --- a/src/azure-cli/azure/cli/command_modules/network/_help.py +++ b/src/azure-cli/azure/cli/command_modules/network/_help.py @@ -122,7 +122,8 @@ --vnet-name MyVNet --subnet MySubnet --http-settings-cookie-based-affinity Enabled \\ --public-ip-address MyAppGatewayPublicIp --servers 10.0.0.4 10.0.0.5 - name: Create an application gateway. (autogenerated) - text: az network application-gateway create --capacity 2 --frontend-port MyFrontendPort --http-settings-cookie-based-affinity Enabled --http-settings-port 80 --http-settings-protocol Http --location westus2 --name MyAppGateway --public-ip-address MyAppGatewayPublicIp --resource-group MyResourceGroup --sku Standard_Small --subnet MySubnet --vnet-name MyVNet + text: | + az network application-gateway create --capacity 2 --frontend-port MyFrontendPort --http-settings-cookie-based-affinity Enabled --http-settings-port 80 --http-settings-protocol Http --location westus2 --name MyAppGateway --public-ip-address MyAppGatewayPublicIp --resource-group MyResourceGroup --sku Standard_Small --subnet MySubnet --vnet-name MyVNet crafted: true """ @@ -147,6 +148,10 @@ text: | az network application-gateway frontend-ip create -g MyResourceGroup --gateway-name MyAppGateway \\ -n MyFrontendIp --public-ip-address MyPublicIpAddress + - name: Create a frontend IP address. (autogenerated) + text: | + az network application-gateway frontend-ip create --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup --subnet MySubnet --vnet-name MyVnet + crafted: true """ helps['network application-gateway frontend-ip delete'] = """ @@ -179,6 +184,10 @@ examples: - name: Update a frontend IP address to use a new IP address. 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 + crafted: true """ helps['network application-gateway frontend-port'] = """ @@ -292,6 +301,10 @@ text: | az network application-gateway http-settings create -g MyResourceGroup --gateway-name MyAppGateway \\ -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 --gateway-name MyAppGateway --host-name MyHost --name MyHttpSettings --port 80 --probe MyNewProbe --protocol Http --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway http-settings delete'] = """ @@ -327,7 +340,8 @@ az network application-gateway http-settings update -g MyResourceGroup --gateway-name MyAppGateway \\ -n MyHttpSettings --probe MyNewProbe - name: Update HTTP settings. (autogenerated) - text: az network application-gateway http-settings update --enable-probe true --gateway-name MyAppGateway --name MyHttpSettings --probe MyNewProbe --resource-group MyResourceGroup + text: | + az network application-gateway http-settings update --enable-probe true --gateway-name MyAppGateway --name MyHttpSettings --probe MyNewProbe --resource-group MyResourceGroup crafted: true """ @@ -466,7 +480,8 @@ az network application-gateway redirect-config update -g MyResourceGroup --gateway-name MyAppGateway \\ -n MyRedirectConfig --type Permanent --target-listener MyNewBackendListener - name: Update a redirect configuration. (autogenerated) - text: az network application-gateway redirect-config update --gateway-name MyAppGateway --include-path true --include-query-string true --name MyRedirectConfig --resource-group MyResourceGroup --target-listener MyNewBackendListener --type Permanent + text: | + az network application-gateway redirect-config update --gateway-name MyAppGateway --include-path true --include-query-string true --name MyRedirectConfig --resource-group MyResourceGroup --target-listener MyNewBackendListener --type Permanent crafted: true """ @@ -497,6 +512,11 @@ helps['network application-gateway rewrite-rule condition list'] = """ short-summary: List rewrite rule conditions. type: command +examples: + - name: List rewrite rule conditions. (autogenerated) + text: | + az network application-gateway rewrite-rule condition list --gateway-name MyGateway --resource-group MyResourceGroup --rule-name MyRule --rule-set-name MyRuleSet + crafted: true """ helps['network application-gateway rewrite-rule condition show'] = """ @@ -535,7 +555,8 @@ type: command examples: - name: List rewrite rules. (autogenerated) - text: az network application-gateway rewrite-rule list --gateway-name MyGateway --resource-group MyResourceGroup --rule-set-name MyRuleSet + text: | + az network application-gateway rewrite-rule list --gateway-name MyGateway --resource-group MyResourceGroup --rule-set-name MyRuleSet crafted: true """ @@ -547,6 +568,11 @@ helps['network application-gateway rewrite-rule set create'] = """ short-summary: Create a rewrite rule set. type: command +examples: + - name: Create a rewrite rule set. (autogenerated) + text: | + az network application-gateway rewrite-rule set create --gateway-name MyGateway --name MyRewriteRuleSet --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway rewrite-rule set delete'] = """ @@ -559,7 +585,8 @@ type: command examples: - name: List rewrite rule sets. (autogenerated) - text: az network application-gateway rewrite-rule set list --gateway-name MyGateway --resource-group MyResourceGroup + text: | + az network application-gateway rewrite-rule set list --gateway-name MyGateway --resource-group MyResourceGroup crafted: true """ @@ -568,7 +595,8 @@ type: command examples: - name: Get the details of a rewrite rule set. (autogenerated) - text: az network application-gateway rewrite-rule set show --gateway-name MyGateway --name MyRewriteRuleSet --resource-group MyResourceGroup + text: | + az network application-gateway rewrite-rule set show --gateway-name MyGateway --name MyRewriteRuleSet --resource-group MyResourceGroup crafted: true """ @@ -580,6 +608,11 @@ helps['network application-gateway rewrite-rule show'] = """ short-summary: Get the details of a rewrite rule. type: command +examples: + - name: Get the details of a rewrite rule. (autogenerated) + text: | + az network application-gateway rewrite-rule show --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet + crafted: true """ helps['network application-gateway rewrite-rule update'] = """ @@ -604,7 +637,8 @@ short-summary: Upload a trusted root certificate. examples: - name: Upload a trusted root certificate. (autogenerated) - text: az network application-gateway root-cert create --cert-file /path/to/cert/file --gateway-name MyGateway --name MyTrustedRootCertificate --resource-group MyResourceGroup + text: | + az network application-gateway root-cert create --cert-file /path/to/cert/file --gateway-name MyGateway --name MyTrustedRootCertificate --resource-group MyResourceGroup crafted: true """ @@ -688,7 +722,8 @@ az network application-gateway rule update -g MyResourceGroup --gateway-name MyAppGateway \\ -n MyRule --http-listener MyNewBackendListener - name: Update a rule. (autogenerated) - text: az network application-gateway rule update --address-pool MyAddressPool --gateway-name MyAppGateway --name MyRule --resource-group MyResourceGroup + text: | + az network application-gateway rule update --address-pool MyAddressPool --gateway-name MyAppGateway --name MyRule --resource-group MyResourceGroup crafted: true """ @@ -883,7 +918,8 @@ short-summary: Update an application gateway. examples: - name: Update an application gateway. (autogenerated) - text: az network application-gateway update --name MyApplicationGateway --resource-group MyResourceGroup --set useRemoteGateways=true + text: | + az network application-gateway update --name MyApplicationGateway --resource-group MyResourceGroup --set useRemoteGateways=true crafted: true """ @@ -966,7 +1002,8 @@ az network application-gateway url-path-map update -g MyResourceGroup --gateway-name MyAppGateway \\ -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 + 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 """ @@ -1065,11 +1102,21 @@ helps['network application-gateway waf-policy create'] = """ type: command short-summary: Create an application gateway WAF policy. +examples: + - name: Create an application gateway WAF policy. (autogenerated) + text: | + az network application-gateway waf-policy create --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy delete'] = """ type: command short-summary: Delete an application gateway WAF policy. +examples: + - name: Delete an application gateway WAF policy. (autogenerated) + text: | + az network application-gateway waf-policy delete --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy list'] = """ @@ -1090,6 +1137,11 @@ helps['network application-gateway waf-policy policy-setting list'] = """ type: command short-summary: List properties of a web application firewall global configuration. +examples: + - name: List properties of a web application firewall global configuration. (autogenerated) + text: | + az network application-gateway waf-policy policy-setting list --policy-name MyPolicy --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy custom-rule'] = """ @@ -1112,7 +1164,8 @@ short-summary: List application gateway WAF policy custom rules. examples: - name: List application gateway WAF policy custom rules. (autogenerated) - text: az network application-gateway waf-policy custom-rule list --policy-name MyPolicy --resource-group MyResourceGroup + text: | + az network application-gateway waf-policy custom-rule list --policy-name MyPolicy --resource-group MyResourceGroup crafted: true """ @@ -1131,7 +1184,8 @@ short-summary: List application gateway WAF policy custom rule match conditions. examples: - name: List application gateway WAF policy custom rule match conditions. (autogenerated) - text: az network application-gateway waf-policy custom-rule match-condition list --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription + text: | + az network application-gateway waf-policy custom-rule match-condition list --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -1143,6 +1197,11 @@ helps['network application-gateway waf-policy custom-rule show'] = """ type: command short-summary: Get the details of an application gateway WAF policy custom rule. +examples: + - name: Get the details of an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule show --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup + crafted: true """ helps['network application-gateway waf-policy custom-rule update'] = """ @@ -1180,6 +1239,11 @@ type: command short-summary: > Remove a managed rule set by rule set group name if rule_group_name is specified. Otherwise, remove all rule set. +examples: + - 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'] = """ @@ -1212,7 +1276,8 @@ short-summary: Get the details of an application gateway WAF policy. examples: - name: Get the details of an application gateway WAF policy. (autogenerated) - text: az network application-gateway waf-policy show --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup + text: | + az network application-gateway waf-policy show --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup crafted: true """ @@ -1221,7 +1286,12 @@ short-summary: Update an application gateway WAF policy. examples: - name: Update an application gateway WAF policy. (autogenerated) - text: az network application-gateway waf-policy update --add communities='12076:5010' --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup + 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 """ @@ -1312,7 +1382,8 @@ - name: Create a DDoS protection plan. text: az network ddos-protection create -g MyResourceGroup -n MyDdosPlan - name: Create a DDoS protection plan. (autogenerated) - text: az network ddos-protection create --location westus2 --name MyDdosPlan --resource-group MyResourceGroup + text: | + az network ddos-protection create --location westus2 --name MyDdosPlan --resource-group MyResourceGroup crafted: true """ @@ -1386,7 +1457,8 @@ - name: Create an empty A record set. text: az network dns record-set a create -g MyResourceGroup -z www.mysite.com -n MyRecordSet - name: Create an empty A record set. (autogenerated) - text: az network dns record-set a create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + text: | + az network dns record-set a create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com crafted: true """ @@ -1436,7 +1508,8 @@ az network dns record-set a update -g MyResourceGroup -n MyRecordSet \\ -z www.mysite.com --metadata owner=WebTeam - name: Update an A record set. (autogenerated) - text: az network dns record-set a update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com + text: | + az network dns record-set a update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com crafted: true """ @@ -1478,7 +1551,8 @@ - name: List all AAAA record sets in a zone. text: az network dns record-set aaaa list -g MyResourceGroup -z www.mysite.com - name: List all AAAA record sets in a zone. (autogenerated) - text: az network dns record-set aaaa list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + text: | + az network dns record-set aaaa list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ @@ -1534,6 +1608,10 @@ examples: - name: Create an empty CAA record set. text: az network dns record-set caa create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty CAA record set. (autogenerated) + text: | + az network dns record-set caa create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network dns record-set caa delete'] = """ @@ -1542,6 +1620,10 @@ examples: - name: Delete a CAA record set and all associated records. text: az network dns record-set caa delete -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Delete a CAA record set and all associated records. (autogenerated) + text: | + az network dns record-set caa delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network dns record-set caa list'] = """ @@ -1594,6 +1676,10 @@ examples: - name: Create an empty CNAME record set. text: az network dns record-set cname create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty CNAME record set. (autogenerated) + text: | + az network dns record-set cname create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + crafted: true """ helps['network dns record-set cname delete'] = """ @@ -1720,7 +1806,8 @@ az network dns record-set mx update -g MyResourceGroup -z www.mysite.com \\ -n MyRecordSet --metadata owner=WebTeam - name: Update an MX record set. (autogenerated) - text: az network dns record-set mx update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com + text: | + az network dns record-set mx update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com crafted: true """ @@ -1745,6 +1832,10 @@ examples: - name: Create an empty NS record set. text: az network dns record-set ns create -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Create an empty NS record set. (autogenerated) + text: | + az network dns record-set ns create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + crafted: true """ helps['network dns record-set ns delete'] = """ @@ -1793,7 +1884,8 @@ az network dns record-set ns update -g MyResourceGroup -z www.mysite.com \\ -n MyRecordSet --metadata owner=WebTeam - name: Update an NS record set. (autogenerated) - text: az network dns record-set ns update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com + text: | + az network dns record-set ns update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com crafted: true """ @@ -1835,7 +1927,8 @@ - name: List all PTR record sets in a zone. text: az network dns record-set ptr list -g MyResourceGroup -z www.mysite.com - name: List all PTR record sets in a zone. (autogenerated) - text: az network dns record-set ptr list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + text: | + az network dns record-set ptr list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ @@ -1987,7 +2080,8 @@ - name: Create an empty TXT record set. text: az network dns record-set txt create -g MyResourceGroup -z www.mysite.com -n MyRecordSet - name: Create an empty TXT record set. (autogenerated) - text: az network dns record-set txt create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + text: | + az network dns record-set txt create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com crafted: true """ @@ -2026,6 +2120,10 @@ examples: - name: Get the details of a TXT record set. text: az network dns record-set txt show -g MyResourceGroup -z www.mysite.com -n MyRecordSet + - name: Get the details of a TXT record set. (autogenerated) + text: | + az network dns record-set txt show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true """ helps['network dns record-set txt update'] = """ @@ -2037,7 +2135,8 @@ az network dns record-set txt update -g MyResourceGroup -z www.mysite.com \\ -n MyRecordSet --metadata owner=WebTeam - name: Update a TXT record set. (autogenerated) - text: az network dns record-set txt update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com + text: | + az network dns record-set txt update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com crafted: true """ @@ -2163,7 +2262,8 @@ text: > az network express-route auth list -g MyResourceGroup --circuit-name MyCircuit - name: List link authorizations of an ExpressRoute circuit. (autogenerated) - text: az network express-route auth list --circuit-name MyCircuit --resource-group MyResourceGroup --subscription MySubscription + text: | + az network express-route auth list --circuit-name MyCircuit --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -2224,7 +2324,8 @@ short-summary: Delete an ExpressRoute gateway connection. examples: - name: Delete an ExpressRoute gateway connection. (autogenerated) - text: az network express-route gateway connection delete --gateway-name MyGateway --name MyExpressRouteConnection --resource-group MyResourceGroup + text: | + az network express-route gateway connection delete --gateway-name MyGateway --name MyExpressRouteConnection --resource-group MyResourceGroup crafted: true """ @@ -2233,7 +2334,8 @@ short-summary: List ExpressRoute gateway connections. examples: - name: List ExpressRoute gateway connections. (autogenerated) - text: az network express-route gateway connection list --gateway-name MyGateway --resource-group MyResourceGroup + text: | + az network express-route gateway connection list --gateway-name MyGateway --resource-group MyResourceGroup crafted: true """ @@ -2242,7 +2344,8 @@ short-summary: Get the details of an ExpressRoute gateway connection. examples: - name: Get the details of an ExpressRoute gateway connection. (autogenerated) - text: az network express-route gateway connection show --gateway-name MyGateway --name MyExpressRouteConnection --resource-group MyResourceGroup + text: | + az network express-route gateway connection show --gateway-name MyGateway --name MyExpressRouteConnection --resource-group MyResourceGroup crafted: true """ @@ -2261,7 +2364,8 @@ short-summary: Delete an ExpressRoute gateway. examples: - name: Delete an ExpressRoute gateway. (autogenerated) - text: az network express-route gateway delete --name MyExpressRouteGateway --resource-group MyResourceGroup + text: | + az network express-route gateway delete --name MyExpressRouteGateway --resource-group MyResourceGroup crafted: true """ @@ -2275,7 +2379,8 @@ short-summary: Get the details of an ExpressRoute gateway. examples: - name: Get the details of an ExpressRoute gateway. (autogenerated) - text: az network express-route gateway show --name MyExpressRouteGateway --resource-group MyResourceGroup + text: | + az network express-route gateway show --name MyExpressRouteGateway --resource-group MyResourceGroup crafted: true """ @@ -2356,7 +2461,8 @@ short-summary: Delete an ExpressRoute circuit connection. examples: - name: Delete an ExpressRoute circuit connection. (autogenerated) - text: az network express-route peering connection delete --circuit-name MyCircuit --name MyPeeringConnection --peering-name MyPeering --resource-group MyResourceGroup + text: | + az network express-route peering connection delete --circuit-name MyCircuit --name MyPeeringConnection --peering-name MyPeering --resource-group MyResourceGroup crafted: true """ @@ -2431,7 +2537,8 @@ short-summary: Create an ExpressRoute port. examples: - name: Create an ExpressRoute port. (autogenerated) - text: az network express-route port create --bandwidth 200 --encapsulation Dot1Q --location westus2 --name MyExpressRoutePort --peering-location westus --resource-group MyResourceGroup + text: | + az network express-route port create --bandwidth 200 --encapsulation Dot1Q --location westus2 --name MyExpressRoutePort --peering-location westus --resource-group MyResourceGroup crafted: true """ @@ -2440,7 +2547,8 @@ short-summary: Delete an ExpressRoute port. examples: - name: Delete an ExpressRoute port. (autogenerated) - text: az network express-route port delete --name MyExpressRoutePort --resource-group MyResourceGroup + text: | + az network express-route port delete --name MyExpressRoutePort --resource-group MyResourceGroup crafted: true """ @@ -2452,11 +2560,21 @@ helps['network express-route port link list'] = """ type: command short-summary: List ExpressRoute links. +examples: + - name: List ExpressRoute links. (autogenerated) + text: | + az network express-route port link list --port-name MyPort --resource-group MyResourceGroup + crafted: true """ helps['network express-route port link show'] = """ type: command short-summary: Get the details of an ExpressRoute link. +examples: + - name: Get the details of an ExpressRoute link. (autogenerated) + text: | + az network express-route port link show --name MyLinkExpressRoutePort --port-name MyPort --resource-group MyResourceGroup + crafted: true """ @@ -2502,13 +2620,19 @@ short-summary: Get the details of an ExpressRoute port location. examples: - name: Get the details of an ExpressRoute port location. (autogenerated) - text: az network express-route port location show --location westus2 + text: | + az network express-route port location show --location westus2 crafted: true """ helps['network express-route port show'] = """ type: command short-summary: Get the details of an ExpressRoute port. +examples: + - name: Get the details of an ExpressRoute port. (autogenerated) + text: | + az network express-route port show --name MyExpressRoutePort --resource-group MyResourceGroup + crafted: true """ helps['network express-route port update'] = """ @@ -2688,7 +2812,8 @@ - name: Get the details of a frontend IP address. text: az network lb frontend-ip show -g MyResourceGroup --lb-name MyLb -n MyFrontendIp - name: Get the details of a frontend IP address (autogenerated) - text: az network lb frontend-ip show --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --subscription MySubscription + text: | + az network lb frontend-ip show --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -2701,7 +2826,8 @@ - name: Update the frontend IP address of an internal load balancer. text: az network lb frontend-ip update -g MyResourceGroup --lb-name MyLb -n MyFrontendIp --private-ip-address 10.10.10.50 - name: Update a frontend IP address. (autogenerated) - text: az network lb frontend-ip update --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup + text: | + az network lb frontend-ip update --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup crafted: true """ @@ -2754,7 +2880,8 @@ az network lb inbound-nat-pool update -g MyResourceGroup --lb-name MyLb -n MyNatPool \\ --protocol Tcp --backend-port 8080 - name: Update an inbound NAT address pool. (autogenerated) - 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 + 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 """ @@ -2810,7 +2937,12 @@ az network lb inbound-nat-rule update -g MyResourceGroup --lb-name MyLb -n MyNatRule \\ --floating-ip false --idle-timeout 5 - name: Update an inbound NAT rule. (autogenerated) - text: az network lb inbound-nat-rule update --backend-port 3389 --frontend-port 5432 --lb-name MyLb --name MyNatRule --protocol Udp --resource-group MyResourceGroup + text: | + az network lb inbound-nat-rule update --backend-port 3389 --frontend-port 5432 --lb-name MyLb --name MyNatRule --protocol Udp --resource-group MyResourceGroup + crafted: true + - name: Update an inbound NAT rule. (autogenerated) + text: | + az network lb inbound-nat-rule update --lb-name MyLb --name MyNatRule --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup crafted: true """ @@ -2832,7 +2964,8 @@ short-summary: Create an outbound-rule. examples: - name: Create an outbound-rule. (autogenerated) - text: az network lb outbound-rule create --address-pool MyAddressPool --frontend-ip-configs myfrontendoutbound --idle-timeout 5 --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --protocol Udp --resource-group MyResourceGroup + text: | + az network lb outbound-rule create --address-pool MyAddressPool --frontend-ip-configs myfrontendoutbound --idle-timeout 5 --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --protocol Udp --resource-group MyResourceGroup crafted: true """ @@ -2841,7 +2974,8 @@ short-summary: Delete an outbound-rule. examples: - name: Delete an outbound-rule. (autogenerated) - text: az network lb outbound-rule delete --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup + text: | + az network lb outbound-rule delete --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup crafted: true """ @@ -2850,7 +2984,8 @@ short-summary: List outbound rules. examples: - name: List outbound rules. (autogenerated) - text: az network lb outbound-rule list --lb-name MyLb --resource-group MyResourceGroup + text: | + az network lb outbound-rule list --lb-name MyLb --resource-group MyResourceGroup crafted: true """ @@ -2859,7 +2994,8 @@ short-summary: Get the details of an outbound rule. examples: - name: Get the details of an outbound rule. (autogenerated) - text: az network lb outbound-rule show --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup + text: | + az network lb outbound-rule show --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup crafted: true """ @@ -2868,7 +3004,12 @@ short-summary: Update an outbound-rule. examples: - name: Update an outbound-rule. (autogenerated) - text: az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup + 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 """ @@ -2986,7 +3127,8 @@ - name: Update a load balancing rule to support HA ports. text: az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule \\ --protocol All --frontend-port 0 --backend-port 0 - name: Update a load balancing rule. (autogenerated) - text: az network lb rule update --disable-outbound-snat true --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup + text: | + az network lb rule update --disable-outbound-snat true --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup crafted: true """ @@ -3016,7 +3158,8 @@ To learn more about list-service-tags, visit https://docs.microsoft.com/en-us/azure/virtual-network/security-overview#service-tags examples: - name: Gets a list of service tag information resources. (autogenerated) - text: az network list-service-tags --location westus2 + text: | + az network list-service-tags --location westus2 crafted: true """ @@ -3056,7 +3199,8 @@ - name: Create a Local Network Gateway to represent your on-premises site. text: az network local-gateway delete -g MyResourceGroup -n MyLocalGateway - name: Delete a local VPN gateway. (autogenerated) - text: az network local-gateway delete --name MyLocalGateway --resource-group MyResourceGroup --subscription MySubscription + text: | + az network local-gateway delete --name MyLocalGateway --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -3085,7 +3229,8 @@ az network local-gateway update -g MyResourceGroup -n MyLocalGateway \\ --local-address-prefixes 10.0.0.0/24 20.0.0.0/24 30.0.0.0/24 - name: Update a local VPN gateway. (autogenerated) - text: az network local-gateway update --gateway-ip-address 23.99.221.164 --name MyLocalGateway --resource-group MyResourceGroup + text: | + az network local-gateway update --gateway-ip-address 23.99.221.164 --name MyLocalGateway --resource-group MyResourceGroup crafted: true """ @@ -3153,7 +3298,8 @@ az network nic ip-config address-pool add -g MyResourceGroup --nic-name MyNic \\ -n MyIpConfig --address-pool MyAddressPool - name: Add an address pool to an IP configuration. (autogenerated) - text: az network nic ip-config address-pool add --address-pool MyAddressPool --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup + text: | + az network nic ip-config address-pool add --address-pool MyAddressPool --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup crafted: true """ @@ -3166,7 +3312,8 @@ az network nic ip-config address-pool remove -g MyResourceGroup --nic-name MyNic \\ -n MyIpConfig --address-pool MyAddressPool - name: Remove an address pool of an IP configuration. (autogenerated) - text: az network nic ip-config address-pool remove --address-pool MyAddressPool --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup + text: | + az network nic ip-config address-pool remove --address-pool MyAddressPool --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup crafted: true """ @@ -3180,7 +3327,8 @@ - name: Create a primary IP configuration for a NIC. text: az network nic ip-config create -g MyResourceGroup -n MyIpConfig --nic-name MyNic --make-primary - name: Create an IP configuration. (autogenerated) - text: az network nic ip-config create --name MyIpConfig --nic-name MyNic --private-ip-address 10.0.0.9 --resource-group MyResourceGroup + text: | + az network nic ip-config create --name MyIpConfig --nic-name MyNic --private-ip-address 10.0.0.9 --resource-group MyResourceGroup crafted: true """ @@ -3207,7 +3355,8 @@ az network nic ip-config inbound-nat-rule add -g MyResourceGroup --nic-name MyNic \\ -n MyIpConfig --inbound-nat-rule MyNatRule - name: Add an inbound NAT rule to an IP configuration. (autogenerated) - text: az network nic ip-config inbound-nat-rule add --inbound-nat-rule MyNatRule --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup + text: | + az network nic ip-config inbound-nat-rule add --inbound-nat-rule MyNatRule --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup crafted: true """ @@ -3220,7 +3369,8 @@ az network nic ip-config inbound-nat-rule remove -g MyResourceGroup --nic-name MyNic \\ -n MyIpConfig --inbound-nat-rule MyNatRule - name: Remove an inbound NAT rule of an IP configuration. (autogenerated) - text: az network nic ip-config inbound-nat-rule remove --inbound-nat-rule MyNatRule --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup + text: | + az network nic ip-config inbound-nat-rule remove --inbound-nat-rule MyNatRule --ip-config-name MyIpConfig --lb-name MyLb --nic-name MyNic --resource-group MyResourceGroup crafted: true """ @@ -3253,7 +3403,8 @@ az network nic ip-config update -g MyResourceGroup --nic-name MyNic \\ -n MyIpConfig --make-primary - name: Update an IP configuration. (autogenerated) - text: az network nic ip-config update --name MyIpConfig --nic-name MyNic --public-ip-address MyAppGatewayPublicIp --resource-group MyResourceGroup + text: | + az network nic ip-config update --name MyIpConfig --nic-name MyNic --public-ip-address MyAppGatewayPublicIp --resource-group MyResourceGroup crafted: true """ @@ -3304,7 +3455,8 @@ - name: Update a network interface to use a different network security group. text: az network nic update -g MyResourceGroup -n MyNic --network-security-group MyNewNsg - name: Update a network interface. (autogenerated) - text: az network nic update --accelerated-networking true --name MyNic --resource-group MyResourceGroup + text: | + az network nic update --accelerated-networking true --name MyNic --resource-group MyResourceGroup crafted: true """ @@ -3411,7 +3563,8 @@ - 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 '*' - name: Update a network security group rule. (autogenerated) - text: az network nsg rule update --name MyNsgRule --nsg-name MyNsg --resource-group MyResourceGroup --source-address-prefixes 208.130.28/24 + text: | + az network nsg rule update --name MyNsgRule --nsg-name MyNsg --resource-group MyResourceGroup --source-address-prefixes 208.130.28/24 crafted: true """ @@ -3436,7 +3589,8 @@ - name: Remove a tag of an NSG. text: az network nsg update -g MyResourceGroup -n MyNsg --remove tags.no_80 - name: Update a network security group. (autogenerated) - text: az network nsg update --name MyNsg --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup + text: | + az network nsg update --name MyNsg --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup crafted: true """ @@ -3456,6 +3610,11 @@ helps['network private-endpoint delete'] = """ type: command short-summary: Delete a private endpoint. +examples: + - name: Delete a private endpoint. (autogenerated) + text: | + az network private-endpoint delete --name MyPrivateEndpoint --resource-group MyResourceGroup + crafted: true """ helps['network private-endpoint list'] = """ @@ -3466,6 +3625,11 @@ helps['network private-endpoint show'] = """ type: command short-summary: Get the details of a private endpoint. +examples: + - name: Get the details of a private endpoint (autogenerated) + text: | + az network private-endpoint show --name MyPrivateEndpoint --resource-group MyResourceGroup + crafted: true """ helps['network private-endpoint update'] = """ @@ -3489,6 +3653,11 @@ helps['network private-link-service connection delete'] = """ type: command short-summary: Delete a private link service endpoint connection. +examples: + - name: Delete a private link service endpoint connection. (autogenerated) + text: | + az network private-link-service connection delete --name MyPrivateEndpointConnection --resource-group MyResourceGroup --service-name MyService + crafted: true """ helps['network private-link-service connection update'] = """ @@ -3524,6 +3693,11 @@ helps['network private-link-service show'] = """ type: command short-summary: Get the details of a private link service. +examples: + - name: Get the details of a private link service. (autogenerated) + text: | + az network private-link-service show --name MyPrivateLinkService --resource-group MyResourceGroup + crafted: true """ helps['network private-link-service update'] = """ @@ -3547,7 +3721,8 @@ short-summary: Delete a network profile. examples: - name: Delete a network profile. (autogenerated) - text: az network profile delete --name MyNetworkProfile --resource-group MyResourceGroup + text: | + az network profile delete --name MyNetworkProfile --resource-group MyResourceGroup crafted: true """ @@ -3556,7 +3731,8 @@ short-summary: List network profiles. examples: - name: List network profiles (autogenerated) - text: az network profile list --resource-group MyResourceGroup + text: | + az network profile list --resource-group MyResourceGroup crafted: true """ @@ -3565,7 +3741,8 @@ short-summary: Get the details of a network profile. examples: - name: Get the details of a network profile. (autogenerated) - text: az network profile show --name MyNetworkProfile --resource-group MyResourceGroup + text: | + az network profile show --name MyNetworkProfile --resource-group MyResourceGroup crafted: true """ @@ -3618,7 +3795,8 @@ short-summary: Create a public IP prefix resource. examples: - name: Create a public IP prefix resource. (autogenerated) - text: az network public-ip prefix create --length 28 --location westus2 --name MyPublicIPPrefix --resource-group MyResourceGroup + text: | + az network public-ip prefix create --length 28 --location westus2 --name MyPublicIPPrefix --resource-group MyResourceGroup crafted: true """ @@ -3627,7 +3805,8 @@ short-summary: Delete a public IP prefix resource. examples: - name: Delete a public IP prefix resource. (autogenerated) - text: az network public-ip prefix delete --name MyPublicIPPrefix --resource-group MyResourceGroup + text: | + az network public-ip prefix delete --name MyPublicIPPrefix --resource-group MyResourceGroup crafted: true """ @@ -3641,7 +3820,8 @@ short-summary: Get the details of a public IP prefix resource. examples: - name: Get the details of a public IP prefix resource. (autogenerated) - text: az network public-ip prefix show --name MyPublicIPPrefix --resource-group MyResourceGroup --subscription MySubscription + text: | + az network public-ip prefix show --name MyPublicIPPrefix --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -3650,7 +3830,8 @@ short-summary: Update a public IP prefix resource. examples: - name: Update a public IP prefix resource. (autogenerated) - text: az network public-ip prefix update --name MyPublicIPPrefix --resource-group MyResourceGroup + text: | + az network public-ip prefix update --name MyPublicIPPrefix --resource-group MyResourceGroup --set useRemoteGateways=true crafted: true """ @@ -3686,6 +3867,10 @@ examples: - name: Create a route filter. text: az network route-filter create -g MyResourceGroup -n MyRouteFilter + - name: Create a route filter. (autogenerated) + text: | + az network route-filter create --location westus2 --name MyRouteFilter --resource-group MyResourceGroup + crafted: true """ helps['network route-filter delete'] = """ @@ -3779,7 +3964,8 @@ - name: Get the details of a route filter. text: az network route-filter show -g MyResourceGroup -n MyRouteFilter - name: Get the details of a route filter. (autogenerated) - text: az network route-filter show --expand peerings --name MyRouteFilter --resource-group MyResourceGroup + text: | + az network route-filter show --expand peerings --name MyRouteFilter --resource-group MyResourceGroup crafted: true """ @@ -3868,7 +4054,8 @@ - name: Update a route in a route table to change the next hop ip address. 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 + 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 crafted: true """ @@ -3901,6 +4088,11 @@ helps['network service-endpoint policy create'] = """ type: command short-summary: Create a service endpoint policy. +examples: + - name: Create a service endpoint policy. (autogenerated) + text: | + az network service-endpoint policy create --name MyServiceEndpointPolicy --resource-group MyResourceGroup + crafted: true """ helps['network service-endpoint policy delete'] = """ @@ -3913,7 +4105,8 @@ short-summary: List service endpoint policies. examples: - name: List service endpoint policies. (autogenerated) - text: az network service-endpoint policy list --resource-group MyResourceGroup + text: | + az network service-endpoint policy list --resource-group MyResourceGroup crafted: true """ @@ -3922,7 +4115,8 @@ short-summary: Get the details of a service endpoint policy. examples: - name: Get the details of a service endpoint policy. (autogenerated) - text: az network service-endpoint policy show --name MyServiceEndpointPolicy --resource-group MyResourceGroup + text: | + az network service-endpoint policy show --name MyServiceEndpointPolicy --resource-group MyResourceGroup crafted: true """ @@ -3963,6 +4157,11 @@ helps['network service-endpoint policy-definition update'] = """ type: command short-summary: Update a service endpoint policy definition. +examples: + - name: Update a service endpoint policy definition. (autogenerated) + text: | + az network service-endpoint policy-definition update --add communities='12076:5010' --name MyServiceEndpointPolicyDefinition --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network traffic-manager'] = """ @@ -3996,7 +4195,8 @@ - name: Delete a traffic manager endpoint. text: az network traffic-manager endpoint delete -g MyResourceGroup \\ --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints - name: Delete a traffic manager endpoint. (autogenerated) - text: az network traffic-manager endpoint delete --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription --type azureEndpoints + text: | + az network traffic-manager endpoint delete --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription --type azureEndpoints crafted: true """ @@ -4033,10 +4233,12 @@ - name: Update a traffic manager endpoint to change its weight. text: az network traffic-manager endpoint update -g MyResourceGroup --profile-name MyTmProfile \\ -n MyEndpoint --weight 20 --type azureEndpoints - name: Update a traffic manager endpoint. (autogenerated) - text: az network traffic-manager endpoint update --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --target webserver.mysite.com --type azureEndpoints + text: | + az network traffic-manager endpoint update --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --target webserver.mysite.com --type azureEndpoints crafted: true - name: Update a traffic manager endpoint. (autogenerated) - text: az network traffic-manager endpoint update --endpoint-status Enabled --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --type azureEndpoints + text: | + az network traffic-manager endpoint update --endpoint-status Enabled --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --type azureEndpoints crafted: true """ @@ -4070,6 +4272,10 @@ examples: - name: Delete a traffic manager profile. text: az network traffic-manager profile delete -g MyResourceGroup -n MyTmProfile + - name: Delete a traffic manager profile. (autogenerated) + text: | + az network traffic-manager profile delete --name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network traffic-manager profile list'] = """ @@ -4123,6 +4329,10 @@ text: | az network vnet create -g MyResourceGroup -n MyVnet --address-prefix 10.0.0.0/16 \\ --subnet-name MySubnet --subnet-prefix 10.0.0.0/24 + - name: Create a virtual network. (autogenerated) + text: | + az network vnet create --address-prefixes 10.0.0.0/16 --name MyVirtualNetwork --resource-group MyResourceGroup --subnet-name MyAseSubnet --subnet-prefixes 10.0.0.0/24 + crafted: true """ helps['network vnet delete'] = """ @@ -4255,7 +4465,8 @@ - name: Delete a subnet. text: az network vnet subnet delete -g MyResourceGroup -n MySubnet - name: Delete a subnet. (autogenerated) - text: az network vnet subnet delete --name MySubnet --resource-group MyResourceGroup --vnet-name MyVnet + text: | + az network vnet subnet delete --name MySubnet --resource-group MyResourceGroup --vnet-name MyVnet crafted: true """ @@ -4274,7 +4485,8 @@ - name: Retrieve the service names for available delegations in the West US region. text: az network vnet subnet list-available-delegations -l westus --query [].serviceName - name: List the services available for subnet delegation. (autogenerated) - text: az network vnet subnet list-available-delegations --resource-group MyResourceGroup + text: | + az network vnet subnet list-available-delegations --resource-group MyResourceGroup crafted: true """ @@ -4311,6 +4523,10 @@ examples: - name: Update a virtual network with the IP address of a DNS server. text: az network vnet update -g MyResourceGroup -n MyVNet --dns-servers 10.2.0.8 + - name: Update a virtual network. (autogenerated) + text: | + az network vnet update --address-prefixes 40.1.0.0/24 --name MyVNet --resource-group MyResourceGroup + crafted: true """ helps['network vnet-gateway'] = """ @@ -4335,7 +4551,8 @@ --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 \\ --client-protocol IkeV2 SSTP --radius-secret 111_aaa --radius-server 30.1.1.15 - name: Create a virtual network gateway. (autogenerated) - text: az network vnet-gateway create --gateway-type Vpn --location westus2 --name MyVnetGateway --no-wait --public-ip-addresses myVGPublicIPAddress --resource-group MyResourceGroup --sku Basic --vnet MyVnet --vpn-type PolicyBased + text: | + az network vnet-gateway create --gateway-type Vpn --location westus2 --name MyVnetGateway --no-wait --public-ip-addresses myVGPublicIPAddress --resource-group MyResourceGroup --sku Basic --vnet MyVnet --vpn-type PolicyBased crafted: true """ @@ -4449,6 +4666,10 @@ examples: - name: Delete a revoked certificate. text: az network vnet-gateway revoked-cert delete -g MyResourceGroup -n MyRootCertificate --gateway-name MyVnetGateway + - name: Delete a revoked certificate. (autogenerated) + text: | + az network vnet-gateway revoked-cert delete --gateway-name MyVnetGateway --name MyRootCertificate --resource-group MyResourceGroup --subscription MySubscription + crafted: true """ helps['network vnet-gateway root-cert'] = """ @@ -4473,7 +4694,8 @@ - name: Remove a certificate from the list of Root Certificates whose children are allowed to access this Gateway. text: az network vnet-gateway root-cert delete -g MyResourceGroup -n MyRootCertificate --gateway-name MyVnetGateway - name: Delete a root certificate. (autogenerated) - text: az network vnet-gateway root-cert delete --gateway-name MyVnetGateway --name MyRootCertificate --resource-group MyResourceGroup --subscription MySubscription + text: | + az network vnet-gateway root-cert delete --gateway-name MyVnetGateway --name MyRootCertificate --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -4492,7 +4714,8 @@ - name: Change the SKU of a virtual network gateway. text: az network vnet-gateway update -g MyResourceGroup -n MyVnetGateway --sku VpnGw2 - name: Update a virtual network gateway. (autogenerated) - text: az network vnet-gateway update --address-prefixes 40.1.0.0/24 --name MyVnetGateway --resource-group MyResourceGroup + text: | + az network vnet-gateway update --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 --name MyVnetGateway --resource-group MyResourceGroup crafted: true """ @@ -4511,7 +4734,8 @@ - name: Create the VPN client configuration for AMD64 architecture. text: az network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --processor-architecture Amd64 - name: Generate VPN client configuration. (autogenerated) - text: az network vnet-gateway vpn-client generate --name MyVnetGateway --processor-architecture Amd64 --resource-group MyResourceGroup --subscription MySubscription + text: | + az network vnet-gateway vpn-client generate --name MyVnetGateway --processor-architecture Amd64 --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -4530,6 +4754,10 @@ examples: - name: Pause CLI until the virtual network gateway is created. text: az network vnet-gateway wait -g MyResourceGroup -n MyVnetGateway --created + - name: Place the CLI in a waiting state until a condition of the virtual network gateway is met. (autogenerated) + text: | + az network vnet-gateway wait --name MyVnetGateway --resource-group MyResourceGroup --updated + crafted: true """ helps['network vnet-gateway aad'] = """ @@ -4601,7 +4829,12 @@ text: > az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 - name: Create a VPN connection. (autogenerated) - text: az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW + text: | + az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW + crafted: true + - name: Create a VPN connection. (autogenerated) + text: | + az network vpn-connection create --local-gateway2 MyLocalGateway --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway crafted: true """ @@ -4674,7 +4907,8 @@ - name: View the shared key of a connection. text: az network vpn-connection shared-key show -g MyResourceGroup --connection-name MyConnection - name: Retrieve a VPN connection shared key. (autogenerated) - text: az network vpn-connection shared-key show --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription + text: | + az network vpn-connection shared-key show --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -4685,7 +4919,8 @@ - name: Change the shared key for the connection to "Abc123". text: az network vpn-connection shared-key update -g MyResourceGroup --connection-name MyConnection --value Abc123 - name: Update a VPN connection shared key. (autogenerated) - text: az network vpn-connection shared-key update --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription --value Abc123 + text: | + az network vpn-connection shared-key update --connection-name MyConnection --resource-group MyResourceGroup --subscription MySubscription --value Abc123 crafted: true """ @@ -4704,7 +4939,8 @@ - name: Add BGP to an existing connection. text: az network vpn-connection update -g MyResourceGroup -n MyConnection --enable-bgp True - name: Update a VPN connection. (autogenerated) - text: az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true + text: | + az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true crafted: true """ @@ -4808,6 +5044,10 @@ examples: - name: List a connection monitor for the given region. text: az network watcher connection-monitor list -l westus + - name: List connection monitors for the given region. (autogenerated) + text: | + az network watcher connection-monitor list --location westus --subscription MySubscription + crafted: true """ helps['network watcher connection-monitor query'] = """ 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 8dfdea9dc06..5dbdcfcb7fd 100644 --- a/src/azure-cli/azure/cli/command_modules/privatedns/_help.py +++ b/src/azure-cli/azure/cli/command_modules/privatedns/_help.py @@ -34,7 +34,8 @@ az network private-dns link vnet create -g MyResourceGroup -n MyLinkName -z www.mysite.com \\ -v MyVirtualNetworkId -e False - name: Create a virtual network link to the specified Private DNS zone. (autogenerated) - text: az network private-dns link vnet create --name MyLinkName --registration-enabled true --resource-group MyResourceGroup --subscription MySubscription --tags CostCenter=Marketing --virtual-network MyVirtualNetworkId --zone-name www.mysite.com + text: | + az network private-dns link vnet create --name MyLinkName --registration-enabled true --resource-group MyResourceGroup --subscription MySubscription --tags CostCenter=Marketing --virtual-network MyVirtualNetworkId --zone-name www.mysite.com crafted: true """ @@ -79,6 +80,10 @@ - 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) + 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 """ helps['network private-dns link vnet wait'] = """ @@ -163,7 +168,8 @@ az network private-dns record-set a update -g MyResourceGroup -n MyRecordSet \\ -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 + text: | + az network private-dns record-set a update --name MyRecordSet --resource-group MyResourceGroup --set useRemoteGateways=true --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 90c60ab87ac..953b8b73d28 100644 --- a/src/azure-cli/azure/cli/command_modules/resource/_help.py +++ b/src/azure-cli/azure/cli/command_modules/resource/_help.py @@ -250,7 +250,8 @@ short-summary: Export the template used for a deployment. examples: - name: Export the template used for a deployment. (autogenerated) - text: az deployment export --name MyDeployment + text: | + az deployment export --name MyDeployment crafted: true """ @@ -286,13 +287,19 @@ It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. examples: - name: Validate whether a template is syntactically correct. (autogenerated) - text: az deployment validate --location westus2 --template-file {template-file} + text: | + az deployment validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json crafted: true """ helps['deployment wait'] = """ type: command short-summary: Place the CLI in a waiting state until a deployment condition is met. +examples: + - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) + text: | + az deployment wait --deleted --name MyDeployment --subscription MySubscription + crafted: true """ helps['feature'] = """ @@ -306,7 +313,6 @@ examples: - name: List preview features text: az feature list - crafted: true """ helps['feature register'] = """ @@ -376,7 +382,8 @@ short-summary: Export the template used for a deployment. examples: - name: Export the template used for a deployment. (autogenerated) - text: az group deployment export --name MyDeployment --resource-group MyResourceGroup + text: | + az group deployment export --name MyDeployment --resource-group MyResourceGroup crafted: true """ @@ -396,12 +403,8 @@ It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. examples: - name: Validate whether a template is syntactically correct. (autogenerated) - text: |- - az group deployment validate --parameters '{ - "location": { - "value": "westus" - } - }' --resource-group MyResourceGroup --template-file storage.json + text: | + az group deployment validate --parameters '{ "location": { "value": "westus" } }' --resource-group MyResourceGroup --template-file storage.json crafted: true """ @@ -410,10 +413,12 @@ short-summary: Place the CLI in a waiting state until a deployment condition is met. examples: - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) - text: az group deployment wait --name MyDeployment --resource-group MyResourceGroup --updated + text: | + az group deployment wait --name MyDeployment --resource-group MyResourceGroup --updated crafted: true - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) - text: az group deployment wait --created --name MyDeployment --resource-group MyResourceGroup + text: | + az group deployment wait --created --name MyDeployment --resource-group MyResourceGroup crafted: true """ @@ -490,7 +495,7 @@ short-summary: Update a resource group. examples: - name: Update a resource group. (autogenerated) - text: |- + text: | az group update --resource-group MyResourceGroup --set tags.CostCenter='{"Dept":"IT","Environment":"Test"}' crafted: true """ @@ -500,10 +505,12 @@ short-summary: Place the CLI in a waiting state until a condition of the resource group is met. examples: - name: Place the CLI in a waiting state until a condition of the resource group is met. (autogenerated) - text: az group wait --created --resource-group MyResourceGroup + text: | + az group wait --created --resource-group MyResourceGroup crafted: true - name: Place the CLI in a waiting state until a condition of the resource group is met. (autogenerated) - text: az group wait --deleted --resource-group MyResourceGroup + text: | + az group wait --deleted --resource-group MyResourceGroup crafted: true """ @@ -551,7 +558,8 @@ text: > az lock show -n lockname - name: Show the properties of a lock (autogenerated) - text: az lock show --name lockname --resource-group MyResourceGroup --resource-name MyResource --resource-type Microsoft.Network/virtualNetworks + text: | + az lock show --name lockname --resource-group MyResourceGroup --resource-name MyResource --resource-type Microsoft.Network/virtualNetworks crafted: true """ @@ -611,7 +619,8 @@ short-summary: Delete a managed application definition. examples: - name: Delete a managed application definition. (autogenerated) - text: az managedapp definition delete --name MyManagedApplicationDefinition --resource-group MyResourceGroup + text: | + az managedapp definition delete --name MyManagedApplicationDefinition --resource-group MyResourceGroup crafted: true """ @@ -620,7 +629,8 @@ short-summary: List managed application definitions. examples: - name: List managed application definitions. (autogenerated) - text: az managedapp definition list --resource-group MyResourceGroup + text: | + az managedapp definition list --resource-group MyResourceGroup crafted: true """ @@ -629,7 +639,8 @@ short-summary: Delete a managed application. examples: - name: Delete a managed application. (autogenerated) - text: az managedapp delete --name MyManagedApplication --resource-group MyResourceGroup + text: | + az managedapp delete --name MyManagedApplication --resource-group MyResourceGroup crafted: true """ @@ -638,7 +649,8 @@ short-summary: List managed applications. examples: - name: List managed applications. (autogenerated) - text: az managedapp list --resource-group MyResourceGroup + text: | + az managedapp list --resource-group MyResourceGroup crafted: true """ @@ -703,7 +715,8 @@ short-summary: Delete a resource policy assignment. examples: - name: Delete a resource policy assignment. (autogenerated) - text: az policy assignment delete --name MyPolicyAssignment + text: | + az policy assignment delete --name MyPolicyAssignment crafted: true """ @@ -732,6 +745,11 @@ helps['policy assignment identity show'] = """ type: command short-summary: Show a policy assignment's managed identity. +examples: + - name: Show a policy assignment's managed identity. (autogenerated) + text: | + az policy assignment identity show --name MyPolicyAssignment + crafted: true """ helps['policy assignment list'] = """ @@ -744,7 +762,8 @@ short-summary: Show a resource policy assignment. examples: - name: Show a resource policy assignment. (autogenerated) - text: az policy assignment show --name MyPolicyAssignment + text: | + az policy assignment show --name MyPolicyAssignment crafted: true """ @@ -846,7 +865,8 @@ short-summary: Delete a policy definition. examples: - name: Delete a policy definition. (autogenerated) - text: az policy definition delete --name MyPolicyDefinition + text: | + az policy definition delete --name MyPolicyDefinition crafted: true """ @@ -860,7 +880,8 @@ short-summary: Show a policy definition. examples: - name: Show a policy definition. (autogenerated) - text: az policy definition show --name MyPolicyDefinition + text: | + az policy definition show --name MyPolicyDefinition crafted: true """ @@ -869,7 +890,8 @@ short-summary: Update a policy definition. examples: - name: Update a policy definition. (autogenerated) - text: az policy definition update --name MyPolicyDefinition + text: | + az policy definition update --name MyPolicyDefinition crafted: true """ @@ -931,7 +953,8 @@ short-summary: Delete a policy set definition. examples: - name: Delete a policy set definition. (autogenerated) - text: az policy set-definition delete --name MyPolicySetDefinition + text: | + az policy set-definition delete --management-group myMg --name MyPolicySetDefinition crafted: true """ @@ -945,7 +968,8 @@ short-summary: Show a policy set definition. examples: - name: Show a policy set definition. (autogenerated) - text: az policy set-definition show --name MyPolicySetDefinition + text: | + az policy set-definition show --name MyPolicySetDefinition crafted: true """ @@ -1001,7 +1025,8 @@ short-summary: Get an individual provider's operations. examples: - name: Get an individual provider's operations. (autogenerated) - text: az provider operation show --namespace Microsoft.Storage + text: | + az provider operation show --namespace Microsoft.Storage crafted: true """ @@ -1010,7 +1035,8 @@ short-summary: Register a provider. examples: - name: Register a provider. (autogenerated) - text: az provider register --namespace 'Microsoft.PolicyInsights' + text: | + az provider register --namespace 'Microsoft.PolicyInsights' crafted: true """ @@ -1019,7 +1045,8 @@ short-summary: Unregister a provider. examples: - name: Unregister a provider. (autogenerated) - text: az provider unregister --namespace Microsoft.Automation + text: | + az provider unregister --namespace Microsoft.Automation crafted: true """ @@ -1088,7 +1115,8 @@ "overwriteVhds": true }' - name: Invoke an action on the resource. (autogenerated) - text: az resource invoke-action --action capture --name MyResource --resource-group MyResourceGroup --resource-type Microsoft.web/sites + text: | + az resource invoke-action --action capture --name MyResource --resource-group MyResourceGroup --resource-type Microsoft.web/sites crafted: true """ @@ -1260,7 +1288,8 @@ text: > az resource tag --tags vmlist=vm1 --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} - name: Tag a resource. (autogenerated) - text: az resource tag --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --tags vmlist=vm1 + text: | + az resource tag --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --tags vmlist=vm1 crafted: true """ @@ -1269,7 +1298,8 @@ short-summary: Update a resource. examples: - name: Update a resource. (autogenerated) - text: az resource update --ids $id --set properties.connectionType=Proxy + text: | + az resource update --ids $id --set properties.connectionType=Proxy crafted: true """ @@ -1278,10 +1308,16 @@ short-summary: Place the CLI in a waiting state until a condition of a resources is met. examples: - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) - text: az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} + text: | + az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} crafted: true - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) - text: az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --include-response-body true + text: | + az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --include-response-body true + crafted: true + - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) + text: | + az resource wait --exists --name MyResource --resource-group MyResourceGroup --resource-type subnets crafted: true """ 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 2648429b64d..a23b813af78 100644 --- a/src/azure-cli/azure/cli/command_modules/storage/_help.py +++ b/src/azure-cli/azure/cli/command_modules/storage/_help.py @@ -103,8 +103,9 @@ text: | end=`date -v+30M '+%Y-%m-%dT%H:%MZ'` az storage account generate-sas --permissions cdlruwap --account-name MyStorageAccount --services qt --resource-types sco --expiry $end -o tsv - - name: Generates a shared access signature for the account (autogenerated) - text: az storage account generate-sas --account-key 00000000 --account-name MyStorageAccount --expiry 2020-01-01 --https-only --permissions acuw --resource-types co --services bfqt + - name: Generate a shared access signature for the account (autogenerated) + text: | + az storage account generate-sas --account-key 00000000 --account-name MyStorageAccount --expiry 2020-01-01 --https-only --permissions acuw --resource-types co --services bfqt crafted: true """ @@ -186,7 +187,8 @@ short-summary: List network rules. examples: - name: List network rules. (autogenerated) - text: az storage account network-rule list --account-name MyAccount --resource-group MyResourceGroup + text: | + az storage account network-rule list --account-name MyAccount --resource-group MyResourceGroup crafted: true """ @@ -195,10 +197,12 @@ short-summary: Remove a network rule. examples: - name: Remove a network rule. (autogenerated) - text: az storage account network-rule remove --account-name MyAccount --resource-group MyResourceGroup --subnet mysubnet + text: | + az storage account network-rule remove --account-name MyAccount --resource-group MyResourceGroup --subnet MySubnetID crafted: true - name: Remove a network rule. (autogenerated) - text: az storage account network-rule remove --account-name MyAccount --ip-address 23.45.1.0/24 --resource-group MyResourceGroup + text: | + az storage account network-rule remove --account-name MyAccount --ip-address 23.45.1.0/24 --resource-group MyResourceGroup crafted: true """ @@ -229,7 +233,8 @@ - name: Get a connection string for a storage account. text: az storage account show-connection-string -g MyResourceGroup -n MyStorageAccount - name: Get the connection string for a storage account. (autogenerated) - text: az storage account show-connection-string --name MyStorageAccount --resource-group MyResourceGroup --subscription MySubscription + text: | + az storage account show-connection-string --name MyStorageAccount --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -238,7 +243,8 @@ short-summary: Show the current count and limit of the storage accounts under the subscription. examples: - name: Show the current count and limit of the storage accounts under the subscription. (autogenerated) - text: az storage account show-usage --location westus2 + text: | + az storage account show-usage --location westus2 crafted: true """ @@ -247,7 +253,8 @@ short-summary: Update the properties of a storage account. examples: - name: Update the properties of a storage account. (autogenerated) - text: az storage account update --default-action Allow --name MyStorageAccount --resource-group MyResourceGroup + text: | + az storage account update --default-action Allow --name MyStorageAccount --resource-group MyResourceGroup crafted: true """ @@ -270,16 +277,18 @@ short-summary: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs. examples: - name: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs. (autogenerated) - text: az storage blob copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos + text: | + az storage blob copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos crafted: true - name: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs (autogenerated) - text: az storage blob copy start --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --sas-token $sas --source-uri https://storage.blob.core.windows.net/photos + text: | + az storage blob copy start --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --sas-token $sas --source-uri https://storage.blob.core.windows.net/photos crafted: true """ helps['storage blob copy start-batch'] = """ type: command -short-summary: Copy multiple blobs or files to a blob container. Use `az storage blob show` to check the status of the blobs. +short-summary: Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs. parameters: - name: --destination-container -c type: string @@ -311,8 +320,9 @@ type: string short-summary: The shared access signature for the source storage account. examples: - - name: Copy multiple blobs or files to a blob container. Use `az storage blob show` to check the status of the blobs. (autogenerated) - text: az storage blob copy start-batch --account-key 00000000 --account-name MyAccount --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-container MySourceContainer + - name: Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs. (autogenerated) + text: | + az storage blob copy start-batch --account-key 00000000 --account-name MyAccount --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-container MySourceContainer crafted: true """ @@ -409,20 +419,22 @@ short-summary: The blob name. examples: - name: Check for the existence of a blob in a container. (autogenerated) - text: az storage blob exists --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob + text: | + az storage blob exists --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob crafted: true """ helps['storage blob generate-sas'] = """ type: command -short-summary: Generates a shared access signature for the blob. +short-summary: Generate a shared access signature for the blob. examples: - name: Generate a sas token for a blob with read-only permissions. text: | end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'` az storage blob generate-sas -c myycontainer -n MyBlob --permissions r --expiry $end --https-only - - name: Generates a shared access signature for the blob. (autogenerated) - text: az storage blob generate-sas --account-key 00000000 --account-name MyStorageAccount --container-name MyContainer --expiry 2018-01-01T00:00:00Z --name MyBlob --permissions r + - name: Generate a shared access signature for the blob. (autogenerated) + text: | + az storage blob generate-sas --account-key 00000000 --account-name MyStorageAccount --container-name MyContainer --expiry 2018-01-01T00:00:00Z --name MyBlob --permissions r crafted: true """ @@ -439,7 +451,8 @@ - name: Upload all files that end with .py unless blob exists and has been modified since given date. text: az storage blob incremental-copy start --source-container MySourceContainer --source-blob MyBlob --source-account-name MySourceAccount --source-account-key MySourceKey --source-snapshot MySnapshot --destination-container MyDestinationContainer --destination-blob MyDestinationBlob - name: Copies an incremental copy of a blob asynchronously. (autogenerated) - 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 + 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 """ @@ -479,7 +492,8 @@ short-summary: Show the storage blob delete-policy. examples: - name: Show the storage blob delete-policy. (autogenerated) - text: az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 + text: | + az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 crafted: true """ @@ -488,7 +502,8 @@ short-summary: Update the storage blob delete-policy. examples: - name: Update the storage blob delete-policy. (autogenerated) - text: az storage blob service-properties delete-policy update --account-name mystorageccount --account-key 00000000 --days-retained 7 --enable true + text: | + az storage blob service-properties delete-policy update --account-name mystorageccount --account-key 00000000 --days-retained 7 --enable true crafted: true """ @@ -497,7 +512,8 @@ short-summary: Update storage blob service properties. examples: - name: Update storage blob service properties. (autogenerated) - text: az storage blob service-properties update --404-document error.html --account-name mystorageccount --account-key 00000000 --index-document index.html --static-website true + text: | + az storage blob service-properties update --404-document error.html --account-name mystorageccount --account-key 00000000 --index-document index.html --static-website true crafted: true """ @@ -516,7 +532,8 @@ For page blob, this command only supports for page blobs on premium accounts. examples: - name: Set the block or page tiers on the blob. (autogenerated) - text: az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob --tier P10 + text: | + az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob --tier P10 crafted: true """ @@ -527,7 +544,8 @@ - name: Show all properties of a blob. text: az storage blob show -c MyContainer -n MyBlob - name: Get the details of a blob (autogenerated) - text: az storage blob show --account-name mystorageccount --account-key 00000000 --container-name MyContainer --name MyBlob + text: | + az storage blob show --account-name mystorageccount --account-key 00000000 --container-name MyContainer --name MyBlob crafted: true """ @@ -612,10 +630,12 @@ short-summary: Create the url to access a blob. examples: - name: Create the url to access a blob (autogenerated) - text: az storage blob url --connection-string $connectionString --container-name container1 --name blob1 + text: | + az storage blob url --connection-string $connectionString --container-name container1 --name blob1 crafted: true - name: Create the url to access a blob (autogenerated) - text: az storage blob url --account-name storageacct --account-key 00000000 --container-name container1 --name blob1 + text: | + az storage blob url --account-name storageacct --account-key 00000000 --container-name container1 --name blob1 crafted: true """ @@ -651,7 +671,8 @@ The container and any blobs contained within it are later deleted during garbage collection. examples: - name: Marks the specified container for deletion. (autogenerated) - text: az storage container delete --account-key 00000000 --account-name MyAccount --name MyContainer + text: | + az storage container delete --account-key 00000000 --account-name MyAccount --name MyContainer crafted: true """ @@ -660,7 +681,8 @@ short-summary: Check for the existence of a storage container. examples: - name: Check for the existence of a storage container. (autogenerated) - text: az storage container exists --account-name mystorageccount --account-key 00000000 --name mycontainer + text: | + az storage container exists --account-name mystorageccount --account-key 00000000 --name mycontainer crafted: true """ @@ -674,7 +696,8 @@ 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) - text: az storage container generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2020-01-01 --name mycontainer --permissions dlrw + text: | + az storage container generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2020-01-01 --name mycontainer --permissions dlrw crafted: true """ @@ -698,7 +721,8 @@ short-summary: Get the legal hold properties of a container. examples: - name: Get the legal hold properties of a container. (autogenerated) - text: az storage container legal-hold show --account-name mystorageccount --container-name MyContainer + text: | + az storage container legal-hold show --account-name mystorageccount --container-name MyContainer crafted: true """ @@ -816,7 +840,8 @@ (q)ueue, (t)able. Can be combined. examples: - name: Remove all CORS rules from a storage account. (autogenerated) - text: az storage cors clear --account-name MyAccount --services bfqt + text: | + az storage cors clear --account-name MyAccount --services bfqt crafted: true """ @@ -828,6 +853,11 @@ short-summary: > The storage service(s) to list rules for. Allowed options are: (b)lob, (f)ile, (q)ueue, (t)able. Can be combined. +examples: + - name: List all CORS rules for a storage account. (autogenerated) + text: | + az storage cors list --account-name MyAccount + crafted: true """ helps['storage directory'] = """ @@ -840,7 +870,8 @@ short-summary: Check for the existence of a storage directory. examples: - name: Check for the existence of a storage directory. (autogenerated) - text: az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare + text: | + az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare crafted: true """ @@ -849,7 +880,8 @@ short-summary: List directories in a share. examples: - name: List directories in a share. (autogenerated) - text: az storage directory list --share-name MyShare + text: | + az storage directory list --account-name MyAccount --share-name MyShare crafted: true """ @@ -881,7 +913,8 @@ short-summary: The server timeout, expressed in seconds. examples: - name: Insert an entity into a table. (autogenerated) - text: az storage entity insert --connection-string $connectionString --entity PartitionKey=AAA RowKey=BBB Content=ASDF2 --table-name MyTable + text: | + az storage entity insert --connection-string $connectionString --entity PartitionKey=AAA RowKey=BBB Content=ASDF2 --if-exists fail --table-name MyTable crafted: true """ @@ -895,7 +928,8 @@ long-summary: This value can be retrieved from the next_marker field of a previous generator object if max_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped. examples: - name: List entities which satisfy a query. (autogenerated) - text: az storage entity query --table-name MyTable + text: | + az storage entity query --table-name MyTable crafted: true """ @@ -982,10 +1016,12 @@ short-summary: List the files and blobs to be deleted. No actual data deletion will occur. examples: - name: Delete files from an Azure Storage File Share. (autogenerated) - text: az storage file delete-batch --account-key 00000000 --account-name MyAccount --source /path/to/file + text: | + az storage file delete-batch --account-key 00000000 --account-name MyAccount --source /path/to/file crafted: true - name: Delete files from an Azure Storage File Share. (autogenerated) - text: az storage file delete-batch --account-key 00000000 --account-name MyAccount --pattern *.py --source /path/to/file + text: | + az storage file delete-batch --account-key 00000000 --account-name MyAccount --pattern *.py --source /path/to/file crafted: true """ @@ -1020,7 +1056,12 @@ This is mostly valuable for detecting bitflips during transfer if using HTTP instead of HTTPS. This hash is not stored. examples: - name: Download files from an Azure Storage File Share to a local directory in a batch operation. (autogenerated) - text: az storage file download-batch --account-key 00000000 --account-name MyAccount --destination . --no-progress --source /path/to/file + 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 """ @@ -1029,7 +1070,12 @@ short-summary: Check for the existence of a file. examples: - name: Check for the existence of a file. (autogenerated) - text: az storage file exists --account-key 00000000 --account-name MyAccount --path path/file.txt --share-name MyShare + text: | + az storage file exists --account-key 00000000 --account-name MyAccount --path path/file.txt --share-name MyShare + crafted: true + - name: Check for the existence of a file. (autogenerated) + text: | + az storage file exists --connection-string $connectionString --path path/file.txt --share-name MyShare crafted: true """ @@ -1040,8 +1086,9 @@ text: | end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'` az storage file generate-sas -p path/file.txt -s MyShare --account-name MyStorageAccount --permissions rcdw --https-only --expiry $end - - name: Generates a shared access signature for the file. (autogenerated) - 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 + - name: Generate a shared access signature for the file. (autogenerated) + 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 """ @@ -1054,7 +1101,8 @@ short-summary: List only files in the given share. examples: - name: List files and directories in a share. (autogenerated) - text: az storage file list --share-name MyShare + text: | + az storage file list --share-name MyShare crafted: true """ @@ -1071,7 +1119,8 @@ - name: Upload to a local file to a share. text: az storage file upload -s MyShare --source /path/to/file - name: Upload a file to a share that uses the SMB 3.0 protocol. (autogenerated) - text: az storage file upload --account-key 00000000 --account-name MyStorageAccount --path path/file.txt --share-name MyShare --source /path/to/file + text: | + az storage file upload --account-key 00000000 --account-name MyStorageAccount --path path/file.txt --share-name MyShare --source /path/to/file crafted: true """ @@ -1107,7 +1156,8 @@ This is mostly valuable for detecting bitflips during transfer if using HTTP instead of HTTPS. This hash is not stored. examples: - name: Upload files from a local directory to an Azure Storage File Share in a batch operation. (autogenerated) - text: az storage file upload-batch --account-key 00000000 --account-name MyAccount --destination . --source /path/to/file + text: | + az storage file upload-batch --account-key 00000000 --account-name MyAccount --destination . --source /path/to/file crafted: true """ @@ -1116,7 +1166,8 @@ short-summary: Create the url to access a file. 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 + text: | + az storage file url --account-name MyAccount --path path/file.txt --share-name MyShare crafted: true """ @@ -1131,6 +1182,11 @@ parameters: - name: --services short-summary: 'The storage services from which to retrieve logging info: (b)lob (q)ueue (t)able. Can be combined.' +examples: + - name: Show logging settings for a storage account. (autogenerated) + text: | + az storage logging show --account-name MyAccount --services qt + crafted: true """ helps['storage logging update'] = """ @@ -1171,7 +1227,8 @@ short-summary: Filter the set of metrics to retrieve by time interval examples: - name: Show metrics settings for a storage account. (autogenerated) - text: az storage metrics show --account-key 00000000 --account-name MyAccount + text: | + az storage metrics show --account-key 00000000 --account-name MyAccount crafted: true """ @@ -1191,7 +1248,8 @@ short-summary: Number of days for which to retain metrics. 0 to disable. Applies to both hour and minute metrics if both are specified. examples: - name: Update metrics settings for a storage account. (autogenerated) - text: az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt + text: | + az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt crafted: true """ @@ -1326,7 +1384,8 @@ short-summary: Creates a new share under the specified account. examples: - name: Creates a new share under the specified account. (autogenerated) - text: az storage share create --name MyFileShare + text: | + az storage share create --account-name MyAccount --name MyFileShare crafted: true """ @@ -1335,7 +1394,12 @@ short-summary: Check for the existence of a file share. examples: - name: Check for the existence of a file share. (autogenerated) - text: az storage share exists --account-key 00000000 --account-name MyAccount --name MyFileShare + text: | + az storage share exists --account-key 00000000 --account-name MyAccount --name MyFileShare + crafted: true + - name: Check for the existence of a file share (autogenerated) + text: | + az storage share exists --connection-string $connectionString --name MyFileShare crafted: true """ @@ -1347,11 +1411,13 @@ end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'` sas=`az storage share generate-sas -n MyShare --account-name MyStorageAccount --https-only --permissions dlrw --expiry $end -o tsv` az storage file upload -s MyShare --account-name MyStorageAccount --source file.txt --sas-token $sas - - name: Generates a shared access signature for the share. (autogenerated) - text: az storage share generate-sas --account-key 00000000 --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --name MyShare --permissions dlrw + - name: Generate a shared access signature for the share. (autogenerated) + text: | + az storage share generate-sas --account-key 00000000 --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --name MyShare --permissions dlrw crafted: true - - name: Generates a shared access signature for the share. (autogenerated) - text: az storage share generate-sas --connection-string $connectionString --expiry 2019-02-01T12:20Z --name MyShare --permissions dlrw + - name: Generate a shared access signature for the share. (autogenerated) + text: | + az storage share generate-sas --connection-string $connectionString --expiry 2019-02-01T12:20Z --name MyShare --permissions dlrw crafted: true """ @@ -1375,7 +1441,12 @@ short-summary: Create a URI to access a file share. examples: - name: Create a URI to access a file share. (autogenerated) - text: az storage share url --account-key 00000000 --account-name MyAccount --name MyFileShare + 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 """ 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 882969620b1..cd7b6c3f225 100644 --- a/src/azure-cli/azure/cli/command_modules/vm/_help.py +++ b/src/azure-cli/azure/cli/command_modules/vm/_help.py @@ -52,7 +52,8 @@ short-summary: Delete a managed disk. examples: - name: Delete a managed disk. (autogenerated) - text: az disk delete --name MyManagedDisk --resource-group MyResourceGroup + text: | + az disk delete --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ @@ -61,7 +62,8 @@ short-summary: Grant a resource access to a managed disk. 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 + text: | + az disk grant-access --duration-in-seconds 3600 --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ @@ -75,10 +77,12 @@ short-summary: Revoke a resource's read access to a managed disk. examples: - name: Revoke a resource's read access to a managed disk. (autogenerated) - text: az disk revoke-access --ids $id + text: | + az disk revoke-access --ids $id crafted: true - name: Revoke a resource's read access to a managed disk. (autogenerated) - text: az disk revoke-access --name MyManagedDisk --resource-group MyResourceGroup + text: | + az disk revoke-access --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ @@ -87,7 +91,8 @@ short-summary: Update a managed disk. examples: - name: Update a managed disk. (autogenerated) - text: az disk update --name MyManagedDisk --resource-group MyResourceGroup --size-gb 20 + text: | + az disk update --name MyManagedDisk --resource-group MyResourceGroup --size-gb 20 crafted: true """ @@ -96,7 +101,8 @@ short-summary: Place the CLI in a waiting state until a condition of a managed disk is met. examples: - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) - text: az disk wait --created --name MyManagedDisk --resource-group MyResourceGroup + text: | + az disk wait --created --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ @@ -331,7 +337,8 @@ short-summary: Show an image builder template. examples: - name: Show an image builder template (autogenerated) - text: az image template show --name mytemplate --resource-group my-group + text: | + az image template show --name mytemplate --resource-group my-group crafted: true """ @@ -409,7 +416,8 @@ short-summary: Create a proximity placement group examples: - name: Create a proximity placement group (autogenerated) - text: az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup + text: | + az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup crafted: true """ @@ -418,7 +426,8 @@ short-summary: List proximity placement groups examples: - name: List proximity placement groups (autogenerated) - text: az ppg list --resource-group MyResourceGroup + text: | + az ppg list --resource-group MyResourceGroup crafted: true """ @@ -427,7 +436,8 @@ short-summary: Get a proximity placement group examples: - name: Get a proximity placement group (commonly used with --output). (autogenerated) - text: az ppg show --name MyProximityPlacementGroup --resource-group MyResourceGroup + text: | + az ppg show --name MyProximityPlacementGroup --resource-group MyResourceGroup crafted: true """ @@ -446,7 +456,8 @@ short-summary: create a share image gallery. examples: - name: create a share image gallery. (autogenerated) - text: az sig create --gallery-name MyGallery --resource-group MyResourceGroup + text: | + az sig create --gallery-name MyGallery --resource-group MyResourceGroup crafted: true """ @@ -469,7 +480,8 @@ short-summary: update a share image defintiion. examples: - name: update a share image defintiion. (autogenerated) - text: az sig image-definition update --gallery-image-definition MyImage --gallery-name MyGallery --resource-group MyResourceGroup + text: | + az sig image-definition update --gallery-image-definition MyImage --gallery-name MyGallery --resource-group MyResourceGroup crafted: true """ @@ -561,7 +573,8 @@ short-summary: Grant read access to a snapshot. examples: - name: Grant read access to a snapshot. (autogenerated) - text: az snapshot grant-access --duration-in-seconds 3600 --name MySnapshot --resource-group MyResourceGroup + text: | + az snapshot grant-access --duration-in-seconds 3600 --name MySnapshot --resource-group MyResourceGroup crafted: true """ @@ -575,7 +588,8 @@ short-summary: Revoke read access to a snapshot. examples: - name: Revoke read access to a snapshot. (autogenerated) - text: az snapshot revoke-access --name MySnapshot --resource-group MyResourceGroup + text: | + az snapshot revoke-access --name MySnapshot --resource-group MyResourceGroup crafted: true """ @@ -584,7 +598,8 @@ short-summary: Update a snapshot. examples: - name: Update a snapshot. (autogenerated) - text: az snapshot update --name MySnapshot --resource-group MyResourceGroup + text: | + az snapshot update --name MySnapshot --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -593,7 +608,12 @@ short-summary: Place the CLI in a waiting state until a condition of a snapshot is met. examples: - name: Place the CLI in a waiting state until a condition of a snapshot is met. (autogenerated) - text: az snapshot wait --exists --name MySnapshot --resource-group MyResourceGroup + text: | + az snapshot wait --exists --name MySnapshot --resource-group MyResourceGroup + crafted: true + - name: Place the CLI in a waiting state until a condition of a snapshot is met. (autogenerated) + text: | + az snapshot wait --created --name MySnapshot --resource-group MyResourceGroup crafted: true """ @@ -692,7 +712,6 @@ - name: Disable the boot diagnostics on a VM text: |- az vm boot-diagnostics disable --ids $(az vm list --resource-group MyResourceGroup --query "[].id" -o tsv) --name MyVirtualMachine --resource-group MyResourceGroup - crafted: true """ helps['vm boot-diagnostics enable'] = """ @@ -707,7 +726,8 @@ az vm boot-diagnostics enable --storage https://mystor.blob.core.windows.net/ --ids $(az vm list -g MyResourceGroup --query "[].id" -o tsv) - name: Enable the boot diagnostics on a VM. (autogenerated) - text: az vm boot-diagnostics enable --name MyVirtualMachine --resource-group MyResourceGroup --storage https://mystor.blob.core.windows.net/ + text: | + az vm boot-diagnostics enable --name MyVirtualMachine --resource-group MyResourceGroup --storage https://mystor.blob.core.windows.net/ crafted: true """ @@ -720,7 +740,8 @@ az vm boot-diagnostics get-boot-log --ids $(az vm list -g MyResourceGroup --query "[].id" -o tsv) - name: Get the boot diagnostics log from a VM. (autogenerated) - text: az vm boot-diagnostics get-boot-log --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vm boot-diagnostics get-boot-log --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -858,7 +879,8 @@ az vm capture --ids {vms_ids} --vhd-name-prefix MyPrefix - name: Deallocate a VM. (autogenerated) - text: az vm deallocate --name MyVm --no-wait --resource-group MyResourceGroup + text: | + az vm deallocate --name MyVm --no-wait --resource-group MyResourceGroup crafted: true """ @@ -989,7 +1011,8 @@ - name: Attach a new default sized (1023 GB) managed data disk to a VM. text: az vm disk attach -g MyResourceGroup --vm-name MyVm --name disk_name --new - name: Attach a managed persistent disk to a VM. (autogenerated) - text: az vm disk attach --disk $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm + text: | + az vm disk attach --disk $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm crafted: true """ @@ -1018,7 +1041,8 @@ For Windows VMS, disabling encryption is permitted on both OS and data volumes. examples: - name: Disable disk encryption on the OS disk and/or data disks. (autogenerated) - text: az vm encryption disable --name MyVirtualMachine --resource-group MyResourceGroup --volume-type DATA + text: | + az vm encryption disable --name MyVirtualMachine --resource-group MyResourceGroup --volume-type DATA crafted: true """ @@ -1041,7 +1065,8 @@ text: > az vm encryption enable -g MyResourceGroup -n MyVm --disk-encryption-keyvault MyVault - name: Enable disk encryption on the OS disk and/or data disks. Encrypt mounted disks. (autogenerated) - text: az vm encryption enable --disk-encryption-keyvault MyVault --name MyVm --resource-group MyResourceGroup --volume-type DATA + text: | + az vm encryption enable --disk-encryption-keyvault MyVault --name MyVm --resource-group MyResourceGroup --volume-type DATA crafted: true """ @@ -1050,7 +1075,8 @@ short-summary: Show encryption status. examples: - name: Show encryption status. (autogenerated) - text: az vm encryption show --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vm encryption show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -1184,13 +1210,16 @@ short-summary: Place the CLI in a waiting state until a condition of a virtual machine extension is met. examples: - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) - text: az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm + text: | + az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm crafted: true - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) - text: az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm + text: | + az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm crafted: true - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) - text: az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm + text: | + az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm crafted: true """ @@ -1264,6 +1293,11 @@ helps['vm host group create'] = """ type: command short-summary: Create a dedicated host group. +examples: + - name: Create a dedicated host group. (autogenerated) + text: | + az vm host group create --name MyDedicatedHostGroup --platform-fault-domain-count 2 --resource-group MyResourceGroup + crafted: true """ helps['vm host group list'] = """ @@ -1277,7 +1311,8 @@ short-summary: Get the details of a dedicated host group. examples: - name: Get the details of a dedicated host group (autogenerated) - text: az vm host group show --name MyDedicatedHostGroup --resource-group MyResourceGroup + text: | + az vm host group show --name MyDedicatedHostGroup --resource-group MyResourceGroup crafted: true """ @@ -1291,7 +1326,8 @@ short-summary: List dedicated hosts. examples: - name: List dedicated hosts. (autogenerated) - text: az vm host list --host-group my-host-group --resource-group my-rg + text: | + az vm host list --host-group my-host-group --resource-group my-rg crafted: true """ @@ -1300,7 +1336,8 @@ short-summary: Get the details of a dedicated host. examples: - name: Get the details of a dedicated host (autogenerated) - text: az vm host show --host-group my-host-group --name MyDedicatedHost --resource-group MyResourceGroup + text: | + az vm host show --host-group my-host-group --name MyDedicatedHost --resource-group MyResourceGroup crafted: true """ @@ -1349,7 +1386,8 @@ short-summary: display VM's managed identity info. examples: - name: display VM's managed identity info. (autogenerated) - text: az vm identity show --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vm identity show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -1363,7 +1401,8 @@ short-summary: Accept Azure Marketplace term so that the image can be used to create VMs examples: - name: Accept Azure Marketplace term so that the image can be used to create VMs. (autogenerated) - text: az vm image accept-terms --urn publisher:offer:sku:version + text: | + az vm image accept-terms --urn publisher:offer:sku:version crafted: true """ @@ -1434,7 +1473,8 @@ "[?offer=='CentOS'].version" -o tsv | sort -u | tail -n 1) az vm image show -l westus -f CentOS -p OpenLogic --sku 7.3 --version {latest} - name: Get the details for a VM image available in the Azure Marketplace. (autogenerated) - text: az vm image show --location westus --urn publisher:offer:sku:version + text: | + az vm image show --location westus --urn publisher:offer:sku:version crafted: true """ @@ -1457,6 +1497,10 @@ examples: - name: Cancel Azure Marketplace image terms. text: az vm image terms cancel --urn publisher:offer:sku:version + - name: Cancel Azure Marketplace image terms. (autogenerated) + text: | + az vm image terms cancel --subscription MySubscription --urn publisher:offer:sku:version + crafted: true """ helps['vm image terms show'] = """ @@ -1574,7 +1618,8 @@ - name: Set a NIC on a VM to be the primary interface. text: az vm nic set -g MyResourceGroup --vm-name MyVm --nic nic_name1 nic_name2 --primary-nic nic_name2 - name: Configure settings of a NIC attached to a VM. (autogenerated) - text: az vm nic set --nics nic_name1 nic_name2 --primary-nic nic_name2 --resource-group MyResourceGroup --vm-name MyVm + text: | + az vm nic set --nics nic_name1 nic_name2 --primary-nic nic_name2 --resource-group MyResourceGroup --vm-name MyVm crafted: true """ @@ -1712,7 +1757,8 @@ - az vm run-command list examples: - name: vm run-command show (autogenerated) - text: az vm run-command show --command-id RunShellScript --location westus2 + text: | + az vm run-command show --command-id RunShellScript --location westus2 crafted: true """ @@ -1726,7 +1772,8 @@ short-summary: Add a secret to a VM. examples: - name: Add a secret to a VM. (autogenerated) - text: az vm secret add --certificate {certificate} --keyvault {keyvault} --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vm secret add --certificate {certificate} --keyvault {keyvault} --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -1758,7 +1805,8 @@ short-summary: List secrets on a VM. examples: - name: List secrets on a VM. (autogenerated) - text: az vm secret list --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vm secret list --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -1790,7 +1838,8 @@ az vm start --ids $(az vm list -g MyResourceGroup --query "[].id" -o tsv) - name: Start a stopped VM. (autogenerated) - text: az vm start --name MyVm --no-wait --resource-group MyResourceGroup + text: | + az vm start --name MyVm --no-wait --resource-group MyResourceGroup crafted: true """ @@ -1846,7 +1895,8 @@ az vm unmanaged-disk attach -g MyResourceGroup --vm-name MyVm \\ --vhd-uri https://mystorage.blob.core.windows.net/vhds/d1.vhd - name: Attach an unmanaged persistent disk to a VM. (autogenerated) - text: az vm unmanaged-disk attach --name MyDataDisk --new --resource-group MyResourceGroup --size-gb 50 --vm-name MyVm + text: | + az vm unmanaged-disk attach --name MyDataDisk --new --resource-group MyResourceGroup --size-gb 50 --vm-name MyVm crafted: true """ @@ -2020,7 +2070,8 @@ short-summary: Deallocate VMs within a VMSS. examples: - name: Deallocate VMs within a VMSS. (autogenerated) - text: az vmss deallocate --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss deallocate --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2029,7 +2080,8 @@ short-summary: Delete VMs within a VMSS. examples: - name: Delete VMs within a VMSS. (autogenerated) - text: az vmss delete-instances --instance-ids 0 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss delete-instances --instance-ids 0 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2048,7 +2100,7 @@ short-summary: Enable diagnostics on a VMSS. examples: - name: Enable diagnostics on a VMSS. (autogenerated) - text: |- + text: | az vmss diagnostics set --protected-settings {protected-settings} --resource-group MyResourceGroup --settings '{"commandToExecute": "echo testing"}' --vmss-name MyVmss crafted: true """ @@ -2063,10 +2115,12 @@ short-summary: Attach managed data disks to a scale set or its instances. examples: - name: Attach managed data disks to a scale set or its instances. (autogenerated) - text: az vmss disk attach --disk {disk} --instance-id 0 --resource-group MyResourceGroup + text: | + az vmss disk attach --disk {disk} --instance-id 0 --resource-group MyResourceGroup crafted: true - name: Attach managed data disks of a given size to a scale set or its instances. (autogenerated) - text: az vmss disk attach --name MyVmss --resource-group MyResourceGroup --size-gb 50 + text: | + az vmss disk attach --name MyVmss --resource-group MyResourceGroup --size-gb 50 crafted: true """ @@ -2075,7 +2129,8 @@ short-summary: Detach managed data disks from a scale set or its instances. examples: - name: Detach managed data disks from a scale set or its instances. (autogenerated) - text: az vmss disk detach --instance-id 0 --lun {lun} --resource-group MyResourceGroup + text: | + az vmss disk detach --instance-id 0 --lun {lun} --resource-group MyResourceGroup crafted: true """ @@ -2103,7 +2158,8 @@ text: > az vmss encryption enable -g MyResourceGroup -n MyVmss --disk-encryption-keyvault MyVault - name: Encrypt a VMSS with managed disks. (autogenerated) - text: az vmss encryption enable --disk-encryption-keyvault MyVault --name MyVmss --resource-group MyResourceGroup --volume-type DATA + text: | + az vmss encryption enable --disk-encryption-keyvault MyVault --name MyVmss --resource-group MyResourceGroup --volume-type DATA crafted: true """ @@ -2112,7 +2168,8 @@ short-summary: Show encryption status. examples: - name: Show encryption status. (autogenerated) - text: az vmss encryption show --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss encryption show --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2126,7 +2183,8 @@ short-summary: Delete an extension from a VMSS. examples: - name: Delete an extension from a VMSS. (autogenerated) - text: az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss + text: | + az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ @@ -2155,7 +2213,8 @@ short-summary: List extensions associated with a VMSS. examples: - name: List extensions associated with a VMSS. (autogenerated) - text: az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss + text: | + az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ @@ -2182,7 +2241,8 @@ short-summary: Show details on a VMSS extension. examples: - name: Show details on a VMSS extension. (autogenerated) - text: az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss + text: | + az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ @@ -2195,7 +2255,8 @@ examples: - name: View an instance of a VMSS. (autogenerated) - text: az vmss get-instance-view --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss get-instance-view --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2211,6 +2272,10 @@ examples: - name: Enable system assigned identity on a VMSS with the 'Owner' role. text: az vmss identity assign -g MyResourceGroup -n MyVmss --role Owner --scope /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/MyResourceGroup + - name: Enable managed service identity on a VMSS. (autogenerated) + text: | + az vmss identity assign --identities readerId writerId --name MyVmss --resource-group MyResourceGroup + crafted: true """ helps['vmss identity remove'] = """ @@ -2230,7 +2295,8 @@ short-summary: display VM scaleset's managed identity info. examples: - name: display VM scaleset's managed identity info. (autogenerated) - text: az vmss identity show --name MyVirtualMachine --resource-group MyResourceGroup + text: | + az vmss identity show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -2244,7 +2310,8 @@ short-summary: Get the IP address and port number used to connect to individual VM instances within a set. examples: - name: Get the IP address and port number used to connect to individual VM instances within a set. (autogenerated) - text: az vmss list-instance-connection-info --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss list-instance-connection-info --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2253,7 +2320,8 @@ short-summary: List public IP addresses of VM instances within a set. examples: - name: List public IP addresses of VM instances within a set. (autogenerated) - text: az vmss list-instance-public-ips --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss list-instance-public-ips --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2270,7 +2338,8 @@ short-summary: VM instance ID. If missing, reimage all instances. examples: - name: Reimage VMs within a VMSS. (autogenerated) - text: az vmss reimage --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription + text: | + az vmss reimage --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -2279,7 +2348,8 @@ short-summary: Restart VMs within a VMSS. examples: - name: Restart VMs within a VMSS. (autogenerated) - text: az vmss restart --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss restart --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2347,7 +2417,8 @@ - az vmss run-command list examples: - name: vmss run-command show (autogenerated) - text: az vmss run-command show --command-id RunShellScript --location westus2 + text: | + az vmss run-command show --command-id RunShellScript --location westus2 crafted: true """ @@ -2359,7 +2430,8 @@ short-summary: Number of VMs in the VMSS. examples: - name: Change the number of VMs within a VMSS. (autogenerated) - text: az vmss scale --name MyScaleSet --new-capacity 6 --resource-group MyResourceGroup + text: | + az vmss scale --name MyScaleSet --new-capacity 6 --resource-group MyResourceGroup crafted: true """ @@ -2371,7 +2443,8 @@ short-summary: VM instance ID. If missing, show the VMSS. examples: - name: Get details on VMs within a VMSS. (autogenerated) - text: az vmss show --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss show --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2380,7 +2453,8 @@ short-summary: Start VMs within a VMSS. examples: - name: Start VMs within a VMSS. (autogenerated) - text: az vmss start --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss start --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2392,7 +2466,8 @@ - name: Power off VMs within a VMSS without shutting down. text: az vmss stop --name MyScaleSet --resource-group MyResourceGroup --skip-shutdown - name: Power off (stop) VMs within a VMSS. (autogenerated) - text: az vmss stop --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss stop --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2401,7 +2476,8 @@ 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 + 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 @@ -2420,7 +2496,8 @@ short-summary: Upgrade VMs within a VMSS. examples: - name: Upgrade VMs within a VMSS. (autogenerated) - text: az vmss update-instances --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + text: | + az vmss update-instances --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ @@ -2429,7 +2506,8 @@ 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 + 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