diff --git a/scripts/ci/aladdin/aladdin.py b/scripts/ci/aladdin/aladdin.py index 838ea725b0a..2b96bb5fd9b 100644 --- a/scripts/ci/aladdin/aladdin.py +++ b/scripts/ci/aladdin/aladdin.py @@ -55,59 +55,6 @@ crafted: true """ -aladdin_helps['acs browse'] = """ -type: command -short-summary: Show the dashboard for a service container's orchestrator in a web browser. -examples: - - name: Show the dashboard for a service container's orchestrator in a web browser. (autogenerated) - text: az acs browse --name MyContainerService --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['acs delete'] = """ -type: command -short-summary: Delete a container service. -examples: - - name: Delete a container service. (autogenerated) - text: az acs delete --name MyContainerService --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['acs kubernetes get-credentials'] = """ -type: command -short-summary: Download and install credentials to access a cluster. This command requires the same private-key used to create the cluster. -parameters: - - name: --output -o - type: string - long-summary: Credentials are always in YAML format, so this argument is effectively ignored. -examples: - - name: Download and install credentials to access a cluster. This command requires the same private-key used to create the cluster. (autogenerated) - text: az acs kubernetes get-credentials --name MyContainerService --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['acs scale'] = """ -type: command -short-summary: Change the private agent count of a container service. -parameters: - - name: --new-agent-count - type: int - short-summary: The number of agents for the container service. -examples: - - name: Change the private agent count of a container service. (autogenerated) - text: az acs scale --name MyContainerService --new-agent-count 10 --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['acs show'] = """ -type: command -short-summary: Show the details for a container service. -examples: - - name: Show the details for a container service. (autogenerated) - text: az acs show --name MyContainerService --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['aks browse'] = """ type: command short-summary: Show the dashboard for a Kubernetes cluster in a web browser. @@ -134,6 +81,8 @@ parameters: - name: --acr short-summary: The FQDN of the ACR. + - name: --node-name + short-summary: The name of a specific node to perform acr pull test checks. If not specified, it will be checked on a random node. examples: - name: Validate the ACR is accessible from the AKS cluster. text: az aks check-acr --name MyManagedCluster --resource-group MyResourceGroup --acr myacr.azurecr.io @@ -169,12 +118,15 @@ These addons are available: - http_application_routing : configure ingress with automatic public DNS name creation. - monitoring : turn on Log Analytics monitoring. Requires "--workspace-resource-id". + Requires "--enable-msi-auth-for-monitoring" for managed identity auth. + Requires "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled If monitoring addon is enabled --no-wait argument will have no effect - virtual-node : enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. - azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner. Learn more at aka.ms/aks/policy. - ingress-appgw : enable Application Gateway Ingress Controller addon. - open-service-mesh : enable Open Service Mesh addon. + - azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon. parameters: - name: --addons -a type: string @@ -182,6 +134,15 @@ - name: --workspace-resource-id type: string short-summary: The resource ID of an existing Log Analytics Workspace to use for storing monitoring data. + - name: --enable-msi-auth-for-monitoring + type: bool + short-summary: Enable Managed Identity Auth for Monitoring addon. + - name: --enable-syslog + type: bool + short-summary: Enable syslog data collection for Monitoring addon + - name: --data-collection-settings + type: string + short-summary: Path to JSON file containing data collection settings for Monitoring addon. - name: --appgw-name type: string short-summary: Name of the application gateway to create/use in the node resource group. Use with ingress-azure addon. @@ -200,12 +161,18 @@ - name: --enable-sgxquotehelper type: bool short-summary: Enable SGX quote helper for confcom addon. + - name: --enable-secret-rotation + type: bool + short-summary: Enable secret rotation. Use with azure-keyvault-secrets-provider addon. + - name: --rotation-poll-interval + type: string + short-summary: Set interval of rotation poll. Use with azure-keyvault-secrets-provider addon. examples: - name: Enable Kubernetes addons. (autogenerated) text: az aks enable-addons --addons virtual-node --name MyManagedCluster --resource-group MyResourceGroup --subnet MySubnetName crafted: true - name: Enable ingress-appgw addon with subnet prefix. - text: az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons ingress-appgw --appgw-subnet-cidr 10.2.0.0/16 --appgw-name gateway + text: az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons ingress-appgw --appgw-subnet-cidr 10.225.0.0/16 --appgw-name gateway crafted: true - name: Enable open-service-mesh addon. text: az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons open-service-mesh @@ -233,6 +200,9 @@ - name: --public-fqdn type: bool short-summary: Get private cluster credential with server address to be public fqdn. + - name: --format + type: string + short-summary: Specify the format of the returned credential. Available values are ["exec", "azure"]. Only take effect when requesting clusterUser credential of AAD clusters. examples: - name: Get access credentials for a managed Kubernetes cluster. (autogenerated) text: az aks get-credentials --name MyManagedCluster --resource-group MyResourceGroup @@ -264,10 +234,6 @@ - name: Get the available upgrade versions for an agent pool of the managed Kubernetes cluster. text: az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePool crafted: true -parameters: - - name: --nodepool-name - type: string - short-summary: name of the node pool. """ aladdin_helps['aks scale'] = """ @@ -324,40 +290,6 @@ crafted: true """ -aladdin_helps['openshift delete'] = """ -type: command -short-summary: Delete an Azure Red Hat OpenShift 3.11 cluster. -long-summary: The az openshift command is deprecated and has been replaced by az aro for ARO 4 clusters. See http://aka.ms/aro/4 for information on switching to ARO 4. -examples: - - name: Delete an Azure Red Hat OpenShift 3.11 cluster. - text: az openshift delete --name MyManagedOpenShiftCluster --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['openshift scale'] = """ -type: command -short-summary: Scale the compute pool in an Azure Red Hat OpenShift 3.11 cluster. -long-summary: The az openshift command is deprecated and has been replaced by az aro for ARO 4 clusters. See http://aka.ms/aro/4 for information on switching to ARO 4. -parameters: - - name: --compute-count -c - type: int - short-summary: Number of nodes in the OpenShift compute pool. -examples: - - name: Scale the compute pool in an Azure Red Hat OpenShift 3.11 cluster. - text: az openshift scale --compute-count 5 --name MyManagedOpenShiftCluster --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['openshift show'] = """ -type: command -short-summary: Show the details for an Azure Red Hat OpenShift 3.11 cluster. -long-summary: Support for existing ARO 3.11 clusters ends June 2022. Please see aka.ms/aro/4 for information on switching to ARO 4. -examples: - - name: Show the details for an Azure Red Hat OpenShift 3.11 cluster. - text: az openshift show --name MyManagedOpenShiftCluster --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['advisor configuration update'] = """ type: command short-summary: Update Azure Advisor configuration. @@ -378,6 +310,16 @@ +aladdin_helps['apim api schema wait'] = """ +type: command +short-summary: Place the CLI in a waiting state until a condition of an apim api schema is met. +examples: + - name: Place the CLI in a waiting state until a condition of a apim api schema is met. + text: | + az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup + crafted: true +""" + aladdin_helps['apim api wait'] = """ type: command short-summary: Place the CLI in a waiting state until a condition of an apim api is met. @@ -433,7 +375,7 @@ short-summary: Get the app service plans for a resource group or a set of resource groups. examples: - name: Get the app service plans for a resource group or a set of resource groups. (autogenerated) - text: az appservice plan show --name MyAppServicePlan --resource-group MyResourceGroup + text: az appservice plan show --name MyAppServicePlan --resource-group MyResourceGroup crafted: true """ @@ -564,6 +506,15 @@ crafted: true """ +aladdin_helps['functionapp cors credentials'] = """ +type: command +short-summary: Enable or disable access-control-allow-credentials. +examples: + - name: Enable CORS access-control-allow-credentials. + text: az functionapp cors credentials --name MyFunctionApp --resource-group MyResourceGroup --enable true + crafted: true +""" + aladdin_helps['functionapp cors show'] = """ type: command short-summary: show allowed origins @@ -746,7 +697,7 @@ aladdin_helps['functionapp identity remove'] = """ type: command -short-summary: Disable web app's managed service identity +short-summary: Disable web app's managed identity examples: - name: Disable web app's system managed identity text: az functionapp identity remove --name MyFunctionApp --resource-group MyResourceGroup @@ -755,9 +706,9 @@ aladdin_helps['functionapp identity show'] = """ type: command -short-summary: display web app's managed service identity +short-summary: display web app's managed identity examples: - - name: display functionapp's managed service identity (autogenerated) + - name: display functionapp's managed identity (autogenerated) text: az functionapp identity show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ @@ -855,12 +806,39 @@ crafted: true """ +aladdin_helps['logicapp config appsettings delete'] = """ +type: command +short-summary: Delete a logic app's settings. +examples: + - name: Delete a logic app's settings. (autogenerated) + text: az logicapp config appsettings delete --name myLogicApp --resource-group myRG --subscription mySubscription --setting-names setting-names + crafted: true +""" + +aladdin_helps['logicapp config appsettings list'] = """ +type: command +short-summary: Show settings for a logic app. +examples: + - name: Show settings for a logic app. (autogenerated) + text: az logicapp config appsettings list --name myLogicApp --resource-group myRG --subscription mySubscription + crafted: true +""" + aladdin_helps['logicapp restart'] = """ type: command short-summary: Restart a logic app. examples: - name: Restart a logic app. - text: az logicapp restart --name MyLogicApp --resource-group MyResourceGroup + text: az logicapp restart --name myLogicApp --resource-group myRG + crafted: true +""" + +aladdin_helps['logicapp scale'] = """ +type: command +short-summary: Scale a logic app. +examples: + - name: Scale a logic app. + text: az logicapp scale --name myLogicApp --resource-group myRG --subscription mySubscription --min-instances 2 --max-instances 4 crafted: true """ @@ -869,7 +847,7 @@ short-summary: Start a logic app. examples: - name: Start a logic app - text: az logicapp start --name MyLogicApp --resource-group MyResourceGroup + text: az logicapp start --name myLogicApp --resource-group myRG crafted: true """ @@ -878,7 +856,34 @@ short-summary: Stop a logic app. examples: - name: Stop a logic app. - text: az logicapp stop --name MyLogicApp --resource-group MyResourceGroup + text: az logicapp stop --name myLogicApp --resource-group myRG + crafted: true +""" + +aladdin_helps['logicapp update'] = """ +type: command +short-summary: Update a logic app. +examples: + - name: Update a logic app. (autogenerated) + text: az logicapp update --name myLogicApp --resource-group myRG + crafted: true +""" + +aladdin_helps['staticwebapp identity remove'] = """ +type: command +short-summary: Disable static web app's managed identity +examples: + - name: Disable static web app's system managed identity + text: az staticwebapp identity remove --name MyApp --resource-group MyResourceGroup + crafted: true +""" + +aladdin_helps['staticwebapp identity show'] = """ +type: command +short-summary: display static web app's managed identity +examples: + - name: display static web app's managed identity (autogenerated) + text: az staticwebapp identity show --name MyApp --resource-group MyResourceGroup crafted: true """ @@ -1254,18 +1259,18 @@ aladdin_helps['webapp identity remove'] = """ type: command -short-summary: Disable web app's managed service identity +short-summary: Disable web app's managed identity examples: - - name: Disable web app's system managed service identity + - name: Disable web app's system managed identity text: az webapp identity remove --name MyWebApp --resource-group MyResourceGroup crafted: true """ aladdin_helps['webapp identity show'] = """ type: command -short-summary: display web app's managed service identity +short-summary: display web app's managed identity examples: - - name: display webapp's managed service identity (autogenerated) + - name: display webapp's managed identity (autogenerated) text: az webapp identity show --name MyWebapp --resource-group MyResourceGroup crafted: true """ @@ -1578,7 +1583,7 @@ short-summary: Find out whether the virtual machine is protected or not. If protected, it returns the recovery services vault ID, otherwise it returns empty. examples: - name: Find out whether the virtual machine is protected or not. If protected, it returns the recovery services vault ID, otherwise it returns empty. (autogenerated) - text: az backup protection check-vm --vm-id {vm-id} + text: az backup protection check-vm --resource-group MyResourceGroup --vm myVM crafted: true """ @@ -1886,7 +1891,7 @@ aladdin_helps['container attach'] = """ type: command -short-summary: Attach local standard output and error streams to a container in a container group. +short-summary: Attach local standard output and error streams to a container in a container group. This command provides diagnostic information during container startup. Once the container has started, it streams STDOUT and STDERR to your local console. examples: - name: Attach local standard output and error streams to a container in a container group. (autogenerated) text: az container attach --name MyContainerGroup --resource-group MyResourceGroup @@ -2074,8 +2079,8 @@ type: command short-summary: Changes the failover priority for the Azure Cosmos DB database account. examples: - - name: Changes the failover priority for the Azure Cosmos DB database account. (autogenerated) - text: az cosmosdb failover-priority-change --failover-policies regionName=failoverPriority --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup + - name: Changes the failover priority for the Azure Cosmos DB database account. + text: az cosmosdb failover-priority-change --failover-policies southafricanorth=0 westus=8 northeurope=3 --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup crafted: true """ @@ -2539,14 +2544,14 @@ aladdin_helps['dms delete'] = """ type: command -short-summary: Delete an instance of the Data Migration Service. +short-summary: Delete an instance of the Azure Database Migration Service (classic). parameters: - name: --delete-running-tasks type: bool short-summary: > Cancel any running tasks before deleting the service. examples: - - name: Delete an instance of the Data Migration Service. (autogenerated) + - name: Delete an instance of the Azure Database Migration Service (classic). (autogenerated) text: az dms delete --name MyService --resource-group MyResourceGroup crafted: true """ @@ -2614,9 +2619,9 @@ aladdin_helps['dms start'] = """ type: command -short-summary: Start an instance of the Data Migration Service. It can then be used to run data migrations. +short-summary: Start an instance of the Azure Database Migration Service (classic). It can then be used to run data migrations. examples: - - name: Start an instance of the Data Migration Service. It can then be used to run data migrations. (autogenerated) + - name: Start an instance of the Azure Database Migration Service (classic). It can then be used to run data migrations. (autogenerated) text: az dms start --name MyService --resource-group MyResourceGroup crafted: true """ @@ -2722,9 +2727,11 @@ + + aladdin_helps['iot dps certificate show'] = """ type: command -short-summary: Show information about a particular Azure IoT Hub Device Provisioning Service certificate. +short-summary: Show information about a particular certificate in an Azure IoT Hub Device Provisioning Service instance. examples: - name: Show information about a particular Azure IoT Hub Device Provisioning Service certificate. (autogenerated) text: az iot dps certificate show --certificate-name MyCertificate --dps-name MyDps --resource-group MyResourceGroup --subscription MySubscription @@ -3138,6 +3145,9 @@ Azure Function: Format: --action azurefunction NAME FUNCTION_APP_RESOURCE_ID FUNCTION_NAME HTTP_TRIGGER_URL [usecommonalertschema] Example: --action azurefunction test_function test_rsrc test_func http://trigger usecommonalertschema + Event Hub: + Format: --action eventhub NAME SUBSCRIPTION_ID EVENT_HUB_NAME_SPACE EVENT_HUB_NAME [usecommonalertschema] + Example: --action eventhub test_eventhub 5def922a-3ed4-49c1-b9fd-05ec533819a3 eventhubNameSpace testEventHubName usecommonalertschema Multiple actions can be specified by using more than one `--add-action` argument. 'useaadauth', 'isglobalrunbook' and 'usecommonalertschema' are optional arguements that only need to be passed to set the respective parameter to True. If the 'useaadauth' argument is passed, then the OBJECT_ID and IDENTIFIER_URI values are required as well. @@ -3146,7 +3156,7 @@ 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 + az monitor action-group create --action webhook MyActionName https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup crafted: true """ @@ -3200,6 +3210,9 @@ Azure Function: Format: --add-action azurefunction NAME FUNCTION_APP_RESOURCE_ID FUNCTION_NAME HTTP_TRIGGER_URL [usecommonalertschema] Example: --add-action azurefunction test_function test_rsrc test_func http://trigger usecommonalertschema + Event Hub: + Format: --action eventhub NAME SUBSCRIPTION_ID EVENT_HUB_NAME_SPACE EVENT_HUB_NAME [usecommonalertschema] + Example: --action eventhub test_eventhub 5def922a-3ed4-49c1-b9fd-05ec533819a3 eventhubNameSpace testEventHubName usecommonalertschema Multiple actions can be specified by using more than one `--add-action` argument. 'useaadauth', 'isglobalrunbook' and 'usecommonalertschema' are optional arguements that only need to be passed to set the respective parameter to True. If the 'useaadauth' argument is passed, then the OBJECT_ID and IDENTIFIER_URI values are required as well. @@ -3251,102 +3264,6 @@ crafted: true """ -aladdin_helps['monitor alert delete'] = """ -type: command -short-summary: Delete an alert rule. -examples: - - name: Delete an alert rule. (autogenerated) - text: | - az monitor alert delete --name MyAlertRule --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['monitor alert list'] = """ -type: command -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 - crafted: true -""" - -aladdin_helps['monitor alert list-incidents'] = """ -type: command -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 - crafted: true -""" - -aladdin_helps['monitor alert show'] = """ -type: command -short-summary: Show an alert rule. -examples: - - name: Show an alert rule. (autogenerated) - text: | - az monitor alert show --name MyAlertRule --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['monitor alert update'] = """ -type: command -short-summary: Update a classic metric-based alert rule. -parameters: - - name: --description - short-summary: Description of the rule. - - name: --condition - short-summary: The condition which triggers the rule. - long-summary: > - The form of a condition is "METRIC {>,>=,<,<=} THRESHOLD {avg,min,max,total,last} PERIOD". - Values for METRIC and appropriate THRESHOLD values can be obtained from `az monitor metric` commands, - and PERIOD is of the form "##h##m##s". - - name: --add-action -a - short-summary: Add an action to fire when the alert is triggered. - long-summary: | - Usage: --add-action TYPE KEY [ARG ...] - Email: --add-action email bob@contoso.com ann@contoso.com - Webhook: --add-action webhook https://www.contoso.com/alert apiKey=value - Webhook: --add-action webhook https://www.contoso.com/alert?apiKey=value - Multiple actions can be specified by using more than one `--add-action` argument. - - name: --remove-action -r - short-summary: Remove one or more actions. - long-summary: | - Usage: --remove-action TYPE KEY [KEY ...] - Email: --remove-action email bob@contoso.com ann@contoso.com - Webhook: --remove-action webhook https://contoso.com/alert https://alerts.contoso.com - - name: --email-service-owners - short-summary: Email the service owners if an alert is triggered. - - name: --metric - short-summary: Name of the metric to base the rule on. - populator-commands: - - az monitor metrics list-definitions - - name: --operator - short-summary: How to compare the metric against the threshold. - - name: --threshold - short-summary: Numeric threshold at which to trigger the alert. - - name: --aggregation - short-summary: Type of aggregation to apply based on --period. - - name: --period - short-summary: > - 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 - 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 - crafted: true - - name: Update a classic metric-based alert rule. (autogenerated) - text: | - az monitor alert update --name MyAlertRule --resource-group MyResourceGroup --set retentionPolicy.days=365 - crafted: true -""" - aladdin_helps['monitor autoscale create'] = """ type: command short-summary: Create new autoscale settings. @@ -3471,400 +3388,197 @@ crafted: true """ -aladdin_helps['monitor autoscale-settings update'] = """ +aladdin_helps['monitor metrics alert delete'] = """ type: command -short-summary: Updates an autoscale setting. +short-summary: Delete a metrics-based alert rule. examples: - - name: Updates an autoscale setting. (autogenerated) + - name: Delete a metrics-based alert rule. (autogenerated) text: | - az monitor autoscale-settings update --name MyAutoscaleSetting --resource-group MyResourceGroup --set retentionPolicy.days=365 + az monitor metrics alert delete --name MyAlertRule --resource-group MyResourceGroup crafted: true """ -aladdin_helps['monitor diagnostic-settings update'] = """ +aladdin_helps['monitor metrics alert list'] = """ type: command -short-summary: Update diagnostic settings. +short-summary: List metric-based alert rules. examples: - - name: Update diagnostic settings. (autogenerated) + - name: List metric-based alert rules. (autogenerated) text: | - az monitor diagnostic-settings update --name MyDiagnosticSetting --resource myScaleSet --set retentionPolicy.days=365 + az monitor metrics alert list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['monitor log-analytics workspace delete'] = """ +aladdin_helps['monitor metrics alert show'] = """ type: command -short-summary: Delete a workspace instance. +short-summary: Show a metrics-based alert rule. examples: - - name: Delete a workspace instance. (autogenerated) + - name: Show a metrics-based alert rule. (autogenerated) text: | - az monitor log-analytics workspace delete --force true --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor metrics alert show --name MyAlertRule --resource-group MyResourceGroup crafted: true """ -aladdin_helps['monitor log-analytics workspace get-schema'] = """ +aladdin_helps['monitor metrics list-definitions'] = """ type: command -short-summary: Get the schema for a given workspace. -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/rest/api/loganalytics/workspaces%202015-03-20/getschema +short-summary: List the metric definitions for the resource. +parameters: + - name: --namespace + short-summary: Namespace to query metric definitions for. + populator-commands: + - az monitor metrics list-namespaces examples: - - name: Get the schema for a given workspace. (autogenerated) + - name: List the metric definitions for the resource. (autogenerated) text: | - az monitor log-analytics workspace get-schema --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/Microsoft.Network/networkSecurityGroups/{resourceName} crafted: true """ -aladdin_helps['monitor log-analytics workspace get-shared-keys'] = """ +aladdin_helps['monitor private-link-scope create'] = """ type: command -short-summary: Get the shared keys for a workspace. +short-summary: Create a private link scope resource. examples: - - name: Get the shared keys for a workspace. (autogenerated) + - name: Create a private link scope resource (autogenerated) text: | - az monitor log-analytics workspace get-shared-keys --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor private-link-scope create --name MyAzureMonitorPrivateLinkScope --resource-group MyResourceRroup crafted: true """ -aladdin_helps['monitor log-analytics workspace linked-storage create'] = """ +aladdin_helps['monitor private-link-scope private-endpoint-connection approve'] = """ type: command -short-summary: Create some linked storage accounts for log analytics workspace. +short-summary: Approve a private endpoint connection of a private link scope resource. +parameters: + - name: --name -n + short-summary: Name of the private endpoint connection. + populator-commands: + - az monitor private-link-scope show +example: + - name: Approve a private endpoint connection. + text: az monitor private-link-scope private-endpoint-connection approve --scope-name MyScope -g MyRG --name PrivateEndpointConnection examples: - - name: Create some linked storage accounts for log analytics workspace. (autogenerated) + - name: Approve a private endpoint connection of a private link scope resource. (autogenerated) text: | - az monitor log-analytics workspace linked-storage create --resource-group MyResourceGroup --storage-accounts /subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.Storage/storageAccounts/cli000001 --subscription mysubscription --type CustomLogs --workspace-name MyWorkspace + az monitor private-link-scope private-endpoint-connection approve --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope crafted: true """ -aladdin_helps['monitor log-analytics workspace linked-storage list'] = """ +aladdin_helps['monitor private-link-scope private-endpoint-connection reject'] = """ type: command -short-summary: List all linked storage accounts for a log analytics workspace. +parameters: + - name: --name -n + short-summary: Name of the private endpoint connection. + populator-commands: + - az monitor private-link-scope show +short-summary: Reject a private endpoint connection of a private link scope resource. examples: - - name: List all linked storage accounts for a log analytics workspace. (autogenerated) + - name: Reject a private endpoint connection of a private link scope resource. (autogenerated) text: | - az monitor log-analytics workspace linked-storage list --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor private-link-scope private-endpoint-connection reject --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope crafted: true """ -aladdin_helps['monitor log-analytics workspace list-management-groups'] = """ + + + + +aladdin_helps['network application-gateway frontend-ip create'] = """ type: command -short-summary: Get a list of management groups connected to a workspace. +short-summary: Create a frontend IP address. examples: - - name: Get a list of management groups connected to a workspace. (autogenerated) + - name: Create a frontend IP address. (autogenerated) text: | - az monitor log-analytics workspace list-management-groups --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace + 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 """ -aladdin_helps['monitor log-analytics workspace list-usages'] = """ +aladdin_helps['network application-gateway frontend-ip update'] = """ type: command -short-summary: Get a list of usage metrics for a workspace. +short-summary: Update a frontend IP address. examples: - - name: Get a list of usage metrics for a workspace. (autogenerated) + - name: Update a frontend IP address. (autogenerated) text: | - az monitor log-analytics workspace list-usages --resource-group MyResourceGroup --subscription MySubscription --workspace-name MyWorkspace + az network application-gateway frontend-ip update --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup crafted: true """ -aladdin_helps['monitor log-analytics workspace pack enable'] = """ +aladdin_helps['network application-gateway http-settings create'] = """ type: command -short-summary: Enable an intelligence pack for a given workspace. +short-summary: Create HTTP settings. examples: - - name: Enable an intelligence pack for a given workspace. (autogenerated) + - name: Create HTTP settings. (autogenerated) text: | - az monitor log-analytics workspace pack enable --name MyIntelligencePack --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace + 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 """ -aladdin_helps['monitor log-analytics workspace pack list'] = """ +aladdin_helps['network application-gateway http-settings update'] = """ type: command -short-summary: List all the intelligence packs possible and whether they are enabled or disabled for a given workspace. +short-summary: Update HTTP settings. examples: - - name: List all the intelligence packs possible and whether they are enabled or disabled for a given workspace. (autogenerated) + - 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 + crafted: true + - name: Update HTTP settings. (autogenerated) text: | - az monitor log-analytics workspace pack list --resource-group MyResourceGroup --workspace-name MyWorkspace + az network application-gateway http-settings update --gateway-name MyAppGateway --host-name-from-backend-pool true --name MyHttpSettings --port 80 --probe MyNewProbe --resource-group MyResourceGroup crafted: true """ -aladdin_helps['monitor log-analytics workspace show'] = """ +aladdin_helps['network application-gateway probe delete'] = """ type: command -short-summary: Show a workspace instance. +short-summary: Delete a probe. examples: - - name: Show a workspace instance. (autogenerated) + - name: Delete a probe. (autogenerated) text: | - az monitor log-analytics workspace show --resource-group MyResourceGroup --workspace-name MyWorkspace + az network application-gateway probe delete --gateway-name MyAppGateway --name MyProbe --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['monitor log-analytics workspace update'] = """ +aladdin_helps['network application-gateway probe update'] = """ type: command -short-summary: Update a workspace instance +short-summary: Update a probe. examples: - - name: Update a workspace instance. (autogenerated) + - name: Update a probe. (autogenerated) text: | - az monitor log-analytics workspace update --resource-group myresourcegroup --retention-time 30 --workspace-name myworkspace + az network application-gateway probe update --gateway-name MyAppGateway --host 127.0.0.1 --name MyProbe --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['monitor log-profiles create'] = """ +aladdin_helps['network application-gateway redirect-config update'] = """ type: command -short-summary: Create a log profile. -parameters: - - name: --name -n - short-summary: The name of the log profile. - - name: --locations - short-summary: Space-separated list of regions for which Activity Log events should be stored. - - name: --categories - short-summary: Space-separated categories of the logs. These categories are created as is convenient to the user. Some values are Write, Delete, and/or Action. - - name: --storage-account-id - short-summary: The resource id of the storage account to which you would like to send the Activity Log. - - name: --service-bus-rule-id - short-summary: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format '{service bus resource ID}/authorizationrules/{key name}'. - - name: --days - short-summary: The number of days for the retention in days. A value of 0 will retain the events indefinitely - - name: --enabled - short-summary: Whether the retention policy is enabled. +short-summary: Update a redirect configuration. examples: - - name: Create a log profile. (autogenerated) + - name: Update a redirect configuration. (autogenerated) text: | - az monitor log-profiles create --categories "Delete" --days 0 --enabled true --location westus2 --locations westus --name MyLogProfile --service-bus-rule-id "/subscriptions/{YOUR SUBSCRIPTION ID}/resourceGroups/{RESOURCE GROUP NAME}/providers/Microsoft.EventHub/namespaces/{EVENT HUB NAME SPACE}/authorizationrules/RootManageSharedAccessKey" + 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 """ -aladdin_helps['monitor log-profiles update'] = """ +aladdin_helps['network application-gateway rewrite-rule condition list'] = """ +short-summary: List rewrite rule conditions. type: command -short-summary: Update a log profile. examples: - - name: Update a log profile. (autogenerated) + - name: List rewrite rule conditions. (autogenerated) text: | - az monitor log-profiles update --name MyLogProfile --set retentionPolicy.days=365 + az network application-gateway rewrite-rule condition list --gateway-name MyGateway --resource-group MyResourceGroup --rule-name MyRule --rule-set-name MyRuleSet crafted: true """ -aladdin_helps['monitor metrics alert delete'] = """ +aladdin_helps['network application-gateway rewrite-rule delete'] = """ +short-summary: Delete a rewrite rule. type: command -short-summary: Delete a metrics-based alert rule. examples: - - name: Delete a metrics-based alert rule. (autogenerated) + - name: Delete a rewrite rule. (autogenerated) text: | - az monitor metrics alert delete --name MyAlertRule --resource-group MyResourceGroup + az network application-gateway rewrite-rule delete --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet crafted: true """ -aladdin_helps['monitor metrics alert list'] = """ +aladdin_helps['network application-gateway rewrite-rule list'] = """ +short-summary: List rewrite rules. type: command -short-summary: List metric-based alert rules. examples: - - name: List metric-based alert rules. (autogenerated) - text: | - az monitor metrics alert list --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['monitor metrics alert show'] = """ -type: command -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 - crafted: true -""" - -aladdin_helps['monitor metrics list-definitions'] = """ -type: command -short-summary: List the metric definitions for the resource. -parameters: - - name: --namespace - short-summary: Namespace to query metric definitions for. - populator-commands: - - az monitor metrics list-namespaces -examples: - - name: List the metric definitions for the resource. (autogenerated) - text: | - az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/Microsoft.Network/networkSecurityGroups/{resourceName} - crafted: true -""" - -aladdin_helps['monitor private-link-scope create'] = """ -type: command -short-summary: Create a private link scope resource. -examples: - - name: Create a private link scope resource (autogenerated) - text: | - az monitor private-link-scope create --name MyAzureMonitorPrivateLinkScope --resource-group MyResourceRroup - crafted: true -""" - -aladdin_helps['monitor private-link-scope private-endpoint-connection approve'] = """ -type: command -short-summary: Approve a private endpoint connection of a private link scope resource. -parameters: - - name: --name -n - short-summary: Name of the private endpoint connection. - populator-commands: - - az monitor private-link-scope show -example: - - name: Approve a private endpoint connection. - text: az monitor private-link-scope private-endpoint-connection approve --scope-name MyScope -g MyRG --name PrivateEndpointConnection -examples: - - name: Approve a private endpoint connection of a private link scope resource. (autogenerated) - text: | - az monitor private-link-scope private-endpoint-connection approve --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope - crafted: true -""" - -aladdin_helps['monitor private-link-scope private-endpoint-connection reject'] = """ -type: command -parameters: - - name: --name -n - short-summary: Name of the private endpoint connection. - populator-commands: - - az monitor private-link-scope show -short-summary: Reject a private endpoint connection of a private link scope resource. -examples: - - name: Reject a private endpoint connection of a private link scope resource. (autogenerated) - text: | - az monitor private-link-scope private-endpoint-connection reject --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope - crafted: true -""" - - - - - -aladdin_helps['network application-gateway create'] = """ -type: command -short-summary: Create an application gateway. -parameters: - - name: --trusted-client-cert - short-summary: The application gateway trusted client certificate. - long-summary: | - Usage: --trusted-client-certificates name=client1 data=client.cer - - name: Required. Name of the trusted client certificate that is unique within an Application Gateway - data: Required. Certificate public data. - - Multiple trusted client certificates can be specified by using more than one `--trusted-client-certificates` argument. - - name: --ssl-profile - short-summary: The application gateway ssl profiles. - long-summary: | - Usage: --ssl-profile name=MySslProfile client-auth-configuration=True cipher-suites=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 policy-type=Custom min-protocol-version=TLSv1_0 - - name: Required. Name of the SSL profile that is unique within an Application Gateway. - polic-name: Name of Ssl Policy. - policy-type: Type of Ssl Policy. - min-protocol-version: Minimum version of Ssl protocol to be supported on application gateway. - cipher-suites: Ssl cipher suites to be enabled in the specified order to application gateway. - disabled-ssl-protocols: Space-separated list of protocols to disable. - trusted-client-certificates: Array of references to application gateway trusted client certificates. - client-auth-configuration: Client authentication configuration of the application gateway resource. - - Multiple ssl profiles can be specified by using more than one `--ssl-profile` argument. -examples: - - 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 - crafted: true -""" - -aladdin_helps['network application-gateway frontend-ip create'] = """ -type: command -short-summary: Create a frontend IP address. -examples: - - 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 -""" - -aladdin_helps['network application-gateway frontend-ip update'] = """ -type: command -short-summary: Update a frontend IP address. -examples: - - name: Update a frontend IP address. (autogenerated) - text: | - az network application-gateway frontend-ip update --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network application-gateway http-settings create'] = """ -type: command -short-summary: Create HTTP settings. -examples: - - 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 -""" - -aladdin_helps['network application-gateway http-settings update'] = """ -type: command -short-summary: Update HTTP settings. -examples: - - 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 - crafted: true - - name: Update HTTP settings. (autogenerated) - text: | - az network application-gateway http-settings update --gateway-name MyAppGateway --host-name-from-backend-pool true --name MyHttpSettings --port 80 --probe MyNewProbe --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network application-gateway probe delete'] = """ -type: command -short-summary: Delete a probe. -examples: - - name: Delete a probe. (autogenerated) - text: | - az network application-gateway probe delete --gateway-name MyAppGateway --name MyProbe --resource-group MyResourceGroup --subscription MySubscription - crafted: true -""" - -aladdin_helps['network application-gateway probe update'] = """ -type: command -short-summary: Update a probe. -examples: - - name: Update a probe. (autogenerated) - text: | - az network application-gateway probe update --gateway-name MyAppGateway --host 127.0.0.1 --name MyProbe --resource-group MyResourceGroup --subscription MySubscription - crafted: true -""" - -aladdin_helps['network application-gateway redirect-config update'] = """ -type: command -short-summary: Update a redirect configuration. -examples: - - 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 - crafted: true -""" - -aladdin_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 -""" - -aladdin_helps['network application-gateway rewrite-rule delete'] = """ -short-summary: Delete a rewrite rule. -type: command -examples: - - name: Delete a rewrite rule. (autogenerated) - text: | - az network application-gateway rewrite-rule delete --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet - crafted: true -""" - -aladdin_helps['network application-gateway rewrite-rule list'] = """ -short-summary: List rewrite rules. -type: command -examples: - - name: List rewrite rules. (autogenerated) + - name: List rewrite rules. (autogenerated) text: | az network application-gateway rewrite-rule list --gateway-name MyGateway --resource-group MyResourceGroup --rule-set-name MyRuleSet crafted: true @@ -3957,6 +3671,16 @@ crafted: true """ +aladdin_helps['network application-gateway routing-rule update'] = """ +type: command +short-summary: Update a rule. +examples: + - name: Update a rule. + text: | + az network application-gateway routing-rule update --address-pool MyAddressPool --gateway-name MyAppGateway --name MyRule --resource-group MyResourceGroup + crafted: true +""" + aladdin_helps['network application-gateway rule update'] = """ type: command short-summary: Update a rule. @@ -3967,13 +3691,37 @@ crafted: true """ +aladdin_helps['network application-gateway settings create'] = """ +type: command +short-summary: Create settings. +examples: + - name: Create settings. (autogenerated) + text: | + az network application-gateway settings create --gateway-name MyAppGateway --host-name MyHost --name MySettings --port 80 --probe MyNewProbe --protocol Tcp --resource-group MyResourceGroup + crafted: true +""" + +aladdin_helps['network application-gateway settings update'] = """ +type: command +short-summary: Update settings. +examples: + - name: Update settings. + text: | + az network application-gateway settings update --gateway-name MyAppGateway --name MySettings --probe MyNewProbe --resource-group MyResourceGroup + crafted: true + - name: Update settings to use a new port. + text: | + az network application-gateway settings update --gateway-name MyAppGateway --backend-pool-host-name true --name MySettings --port 80 --probe MyNewProbe --resource-group MyResourceGroup + crafted: true +""" + aladdin_helps['network application-gateway update'] = """ type: command 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 + az network application-gateway update --name MyApplicationGateway --resource-group MyResourceGroup --set sku.tier=WAF_v2 crafted: true """ @@ -3991,7 +3739,7 @@ type: command short-summary: Create an application gateway WAF policy. examples: - - name: Create an application gateway WAF policy. (autogenerated) + - name: Create an application gateway WAF policy. text: | az network application-gateway waf-policy create --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup crafted: true @@ -4061,31 +3809,17 @@ crafted: true """ -aladdin_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 -""" - -aladdin_helps['network application-gateway waf-policy list'] = """ -type: command -short-summary: List application gateway WAF policies. -examples: - - name: List application gateway WAF policies. (autogenerated) - text: | - az network application-gateway waf-policy list --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['network application-gateway waf-policy managed-rule rule-set add'] = """ type: command short-summary: > Add managed rule set to the WAF policy managed rules. For rule set and rules, please visit: https://docs.microsoft.com/azure/web-application-firewall/ag/application-gateway-crs-rulegroups-rules +parameters: + - name: --rule + short-summary: The rule that will be disabled. If none specified, all rules in the group will be disabled. If provided, --group-name must be provided too. + long-summary: | + Usage: --rule rule-id=MyID state=MyState action=MyAction + Multiple rules can be specified by using more than one `--rule` argument. examples: - name: Add managed rule set to the WAF policy managed rules (autogenerated) text: | @@ -4107,7 +3841,7 @@ 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) + - name: List properties of a web application firewall global configuration. text: | az network application-gateway waf-policy policy-setting list --policy-name MyPolicy --resource-group MyResourceGroup crafted: true @@ -4123,60 +3857,6 @@ crafted: true """ -aladdin_helps['network application-gateway waf-policy show'] = """ -type: command -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 - crafted: true -""" - -aladdin_helps['network application-gateway waf-policy update'] = """ -type: command -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 - 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 -""" - -aladdin_helps['network bastion create'] = """ -type: command -short-summary: Create a Azure bastion host machine. -examples: - - name: Create a Azure bastion host machine. (autogenerated) - text: | - az network bastion create --location westus2 --name MyBastionHost --public-ip-address MyPublicIpAddress --resource-group MyResourceGroup --vnet-name MyVnet - crafted: true -""" - -aladdin_helps['network bastion delete'] = """ -type: command -short-summary: Delete a Azure bastion host machine. -examples: - - name: Delete a Azure bastion host machine. (autogenerated) - text: | - az network bastion delete --name MyBastionHost --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network bastion show'] = """ -type: command -short-summary: Show a Azure bastion host machine. -examples: - - name: Show a Azure bastion host machine. (autogenerated) - text: | - az network bastion show --name MyBastionHost --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['network ddos-protection create'] = """ type: command short-summary: Create a DDoS protection plan. @@ -4205,7 +3885,7 @@ examples: - name: Update a DDoS protection plan. (autogenerated) text: | - az network ddos-protection update --name MyDdosPlan --remove tags.no_80 --resource-group MyResourceGroup + az network ddos-protection update --name MyDdosPlan --tags foo=boo --resource-group MyResourceGroup crafted: true """ @@ -4771,55 +4451,6 @@ crafted: true """ -aladdin_helps['network list-service-aliases'] = """ -type: command -short-summary: List available service aliases in the region which can be used for Service Endpoint Policies. -examples: - - name: List available service aliases in the region which can be used for Service Endpoint Policies. (autogenerated) - text: | - az network list-service-aliases --location westus2 - crafted: true -""" - -aladdin_helps['network list-service-tags'] = """ -type: command -short-summary: List all service tags which are below to different resources -long-summary: > - A service tag represents a group of IP address prefixes to help minimize complexity for security rule creation. - To learn more about list-service-tags, visit https://docs.microsoft.com/azure/virtual-network/security-overview#service-tags. \ - Note that the location parameter is used as a reference for version (not as a filter based on location). - For example, even if you specify --location eastus2 you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to (i.e. Public, US government, China or Germany). -examples: - - name: Gets a list of service tag information resources. (autogenerated) - text: | - az network list-service-tags --location westus2 - crafted: true -""" - -aladdin_helps['network local-gateway delete'] = """ -type: command -short-summary: Delete a local VPN gateway. -long-summary: > - In order to delete a Local Network Gateway, you must first delete ALL Connection objects in Azure - that are connected to the Gateway. After deleting the Gateway, proceed to delete other resources now not in use. - For more information, follow the order of instructions on this page: https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-delete-vnet-gateway-portal -examples: - - name: Delete a local VPN gateway. (autogenerated) - text: | - az network local-gateway delete --name MyLocalGateway --resource-group MyResourceGroup --subscription MySubscription - crafted: true -""" - -aladdin_helps['network local-gateway update'] = """ -type: command -short-summary: Update a local VPN gateway. -examples: - - 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 - crafted: true -""" - aladdin_helps['network nic ip-config address-pool add'] = """ type: command short-summary: Add an address pool to an IP configuration. @@ -5015,36 +4646,6 @@ crafted: true """ -aladdin_helps['network profile delete'] = """ -type: command -short-summary: Delete a network profile. -examples: - - name: Delete a network profile. (autogenerated) - text: | - az network profile delete --name MyNetworkProfile --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network profile list'] = """ -type: command -short-summary: List network profiles. -examples: - - name: List network profiles (autogenerated) - text: | - az network profile list --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network profile show'] = """ -type: command -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 - crafted: true -""" - aladdin_helps['network public-ip prefix create'] = """ type: command short-summary: Create a public IP prefix resource. @@ -5085,126 +4686,6 @@ crafted: true """ -aladdin_helps['network route-filter create'] = """ -type: command -short-summary: Create a route filter. -examples: - - name: Create a route filter. (autogenerated) - text: | - az network route-filter create --location westus2 --name MyRouteFilter --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network route-filter show'] = """ -type: command -short-summary: Get the details of a route filter. -examples: - - name: Get the details of a route filter. (autogenerated) - text: | - az network route-filter show --expand peerings --name MyRouteFilter --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network route-table route update'] = """ -type: command -short-summary: Update a route in a route table. -examples: - - 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 --resource-group MyResourceGroup --route-table-name MyRouteTable - crafted: true -""" - -aladdin_helps['network routeserver update'] = """ -type: command -short-summary: Update a route server. -examples: - - name: Update a route server. - text: | - az network routeserver update --name myrouteserver --resource-group myresourcegroup --tags super_secure no_80 no_22 - crafted: true -""" - -aladdin_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 -""" - -aladdin_helps['network service-endpoint policy list'] = """ -type: command -short-summary: List service endpoint policies. -examples: - - name: List service endpoint policies. (autogenerated) - text: | - az network service-endpoint policy list --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network service-endpoint policy show'] = """ -type: command -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 - crafted: true -""" - -aladdin_helps['network service-endpoint policy-definition delete'] = """ -type: command -short-summary: Delete a service endpoint policy definition. -examples: - - name: Delete a service endpoint policy definition (autogenerated) - text: | - az network service-endpoint policy-definition delete --name myserviceendpointpolicydefinition --policy-name mypolicy --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['network service-endpoint policy-definition list'] = """ -type: command -short-summary: List service endpoint policy definitions. -examples: - - name: List service endpoint policy definitions. (autogenerated) - text: | - az network service-endpoint policy-definition list --policy-name MyPolicy --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network service-endpoint policy-definition show'] = """ -type: command -short-summary: Get the details of a service endpoint policy definition. -examples: - - name: Get the details of a service endpoint policy definition. (autogenerated) - text: | - az network service-endpoint policy-definition show --name myserviceendpointpolicydefinition --policy-name mypolicy --resource-group myresourcegroup - crafted: true -""" - -aladdin_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 -""" - -aladdin_helps['network traffic-manager endpoint delete'] = """ -type: command -short-summary: Delete a traffic manager endpoint. -examples: - - 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 - crafted: true -""" - aladdin_helps['network traffic-manager endpoint update'] = """ type: command short-summary: Update a traffic manager endpoint. @@ -5219,16 +4700,6 @@ crafted: true """ -aladdin_helps['network traffic-manager profile delete'] = """ -type: command -short-summary: Delete a traffic manager profile. -examples: - - name: Delete a traffic manager profile. (autogenerated) - text: | - az network traffic-manager profile delete --name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription - crafted: true -""" - aladdin_helps['network traffic-manager profile update'] = """ type: command short-summary: Update a traffic manager profile. @@ -5252,26 +4723,6 @@ crafted: true """ -aladdin_helps['network vnet subnet delete'] = """ -type: command -short-summary: Delete a subnet. -examples: - - name: Delete a subnet. (autogenerated) - text: | - az network vnet subnet delete --name MySubnet --resource-group MyResourceGroup --vnet-name MyVnet - crafted: true -""" - -aladdin_helps['network vnet subnet list-available-delegations'] = """ -type: command -short-summary: List the services available for subnet delegation. -examples: - - name: List the services available for subnet delegation. (autogenerated) - text: | - az network vnet subnet list-available-delegations --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['network vnet update'] = """ type: command short-summary: Update a virtual network. @@ -5285,20 +4736,6 @@ aladdin_helps['network vnet-gateway create'] = """ type: command short-summary: Create a virtual network gateway. -parameters: - - name: --nat-rule - short-summary: VirtualNetworkGatewayNatRule Resource. - long-summary: | - Usage: --nat-rule name=rule type=Static mode=EgressSnat internal-mappings=10.4.0.0/24 external-mappings=192.168.21.0/24 ip-config-id=/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default - - name: Required.The name of the resource that is unique within a resource group. This name can be used to access the resource. - internal-mappings: Required.The private IP address internal mapping for NAT. - external-mappings: Required.The private IP address external mapping for NAT. - type: The type of NAT rule for VPN NAT. - mode: The Source NAT direction of a VPN NAT. - ip-config-id: The IP Configuration ID this NAT rule applies to. - - Multiple nat rules can be specified by using more than one `--nat-rule` argument. examples: - name: Create a virtual network gateway. (autogenerated) text: | @@ -5444,17 +4881,6 @@ aladdin_helps['network watcher connection-monitor create'] = """ type: command short-summary: Create a connection monitor. -long-summary: | - This extension allow to create V1 and V2 version of connection monitor. - V1 connection monitor supports single source and destination endpoint which comes with V1 argument groups as usual. - V2 connection monitor supports multiple endpoints and several test protocol which comes with V2 argument groups. -parameters: - - name: --source-resource - short-summary: > - Currently only Virtual Machines are supported. - - name: --dest-resource - short-summary: > - Currently only Virtual Machines are supported. examples: - name: Create a connection monitor. (autogenerated) text: | @@ -5665,37 +5091,6 @@ -aladdin_helps['ad app credential delete'] = """ -type: command -short-summary: delete an application's password or certificate credentials -examples: - - name: delete an application's password or certificate credentials (autogenerated) - text: az ad app credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad app credential list'] = """ -type: command -short-summary: List an application's password or certificate credential metadata. (The content of the password or certificate credential is not retrievable.) -examples: - - name: list an application's password or certificate credentials (autogenerated) - text: az ad app credential list --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - -aladdin_helps['ad app credential reset'] = """ -type: command -short-summary: Append or overwrite an application's password or certificate credentials -long-summary: >- - The output includes credentials that you must protect. Be sure that you do not include these credentials - in your code or check the credentials into your source control. As an alternative, consider using - [managed identities](https://aka.ms/azadsp-managed-identities) if available to avoid the need to use credentials. -examples: - - name: append or overwrite an application's password or certificate credentials (autogenerated) - text: az ad app credential reset --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - aladdin_helps['ad app delete'] = """ type: command short-summary: Delete an application. @@ -5726,22 +5121,13 @@ aladdin_helps['ad app permission admin-consent'] = """ type: command short-summary: Grant Application & Delegated permissions through admin-consent. -long-summary: You must login as a directory administrator +long-summary: You must login as a global administrator examples: - name: Grant Application & Delegated permissions through admin-consent. (autogenerated) text: az ad app permission admin-consent --id 00000000-0000-0000-0000-000000000000 crafted: true """ -aladdin_helps['ad app show'] = """ -type: command -short-summary: Get the details of an application. -examples: - - name: Get the details of an application. (autogenerated) - text: az ad app show --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - aladdin_helps['ad group create'] = """ type: command short-summary: Create a group in the directory. @@ -5796,56 +5182,6 @@ crafted: true """ -aladdin_helps['ad sp credential delete'] = """ -type: command -short-summary: Delete a service principal's credential. -examples: - - name: Delete a service principal's credential. (autogenerated) - text: az ad sp credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad sp credential list'] = """ -type: command -short-summary: List a service principal's credentials. -examples: - - name: List a service principal's credentials. (autogenerated) - text: az ad sp credential list --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - -aladdin_helps['ad sp credential reset'] = """ -type: command -short-summary: Reset a service principal credential. -long-summary: >- - Use upon expiration of the service principal's credentials, or in the event that login credentials are lost. - - - The output includes credentials that you must protect. Be sure that you do not include these credentials - in your code or check the credentials into your source control. As an alternative, consider using - [managed identities](https://aka.ms/azadsp-managed-identities) if available to avoid the need to use credentials. -parameters: - - name: --name -n - short-summary: Name or app ID of the service principal. - - name: --password -p - short-summary: The password used to log in. - long-summary: If not present and `--cert` is not specified, a random password will be generated. - - name: --cert - short-summary: Certificate to use for credentials. - long-summary: When using `--keyvault,` indicates the name of the cert to use or create. Otherwise, supply a PEM or DER formatted public certificate string. Use `@{path}` to load from a file. Do not include private key info. - - name: --create-cert - short-summary: Create a self-signed certificate to use for the credential. - long-summary: Use with `--keyvault` to create the certificate in Key Vault. Otherwise, a certificate will be created locally. - - name: --keyvault - short-summary: Name or ID of a KeyVault to use for creating or retrieving certificates. - - name: --years - short-summary: 'Number of years for which the credentials will be valid. Default: 1 year' -examples: - - name: Reset a service principal credential. (autogenerated) - text: az ad sp credential reset --name MyAppURIForCredential - crafted: true -""" - aladdin_helps['ad sp delete'] = """ type: command short-summary: Delete a service principal and its role assignments. @@ -5864,15 +5200,6 @@ crafted: true """ -aladdin_helps['ad sp show'] = """ -type: command -short-summary: Get the details of a service principal. -examples: - - name: Get the details of a service principal. (autogenerated) - text: az ad sp show --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - aladdin_helps['ad sp update'] = """ type: command short-summary: Update a service principal @@ -5882,24 +5209,6 @@ crafted: true """ -aladdin_helps['ad user get-member-groups'] = """ -type: command -short-summary: Get groups of which the user is a member -examples: - - name: Get groups of which the user is a member (autogenerated) - text: az ad user get-member-groups --upn-or-object-id myuser@contoso.com - crafted: true -""" - -aladdin_helps['ad user update'] = """ -type: command -short-summary: Update Azure Active Directory users. -examples: - - name: Update Azure Active Directory users. (autogenerated) - text: az ad user update --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - aladdin_helps['mariadb server configuration list'] = """ type: command short-summary: List the configuration values for a server. @@ -5975,39 +5284,12 @@ crafted: true """ -aladdin_helps['mysql flexible-server firewall-rule delete'] = """ -type: command -short-summary: Delete a firewall rule. -examples: - - name: Delete a firewall rule. - text: az mysql flexible-server firewall-rule delete --rule-name testRule --resource-group testGroup --name testServer - crafted: true -""" - aladdin_helps['mysql flexible-server firewall-rule show'] = """ type: command short-summary: Get the details of a firewall rule. examples: - name: Get the details of a firewall rule. - text: az mysql flexible-server firewall-rule show --rule-name testRule --resource-group testGroup --name testServer - crafted: true -""" - -aladdin_helps['mysql flexible-server parameter list'] = """ -type: command -short-summary: List the parameter values for a flexible server. -examples: - - name: List the parameter values for a flexible server. - text: az mysql flexible-server parameter list --resource-group testGroup --server-name servername - crafted: true -""" - -aladdin_helps['mysql flexible-server parameter show'] = """ -type: command -short-summary: Get the parameter for a flexible server." -examples: - - name: Get the parameter for a server.W - text: az mysql flexible-server parameter show --name parameterName + text: az mysql flexible-server firewall-rule show --rule-name testRule --resource-group testGroup --name testserver crafted: true """ @@ -6016,7 +5298,7 @@ short-summary: Restart a flexible server. examples: - name: Restart a flexible server. - text: az mysql flexible-server restart --resource-group testGroup --name testServer + text: az mysql flexible-server restart --resource-group testGroup --name testserver crafted: true """ @@ -6025,7 +5307,7 @@ short-summary: Get the details of a flexible server. examples: - name: Get the details of a flexible server - text: az mysql flexible-server show --resource-group testGroup --name testServer + text: az mysql flexible-server show --resource-group testGroup --name testserver crafted: true """ @@ -6034,7 +5316,7 @@ short-summary: Start a flexible server. examples: - name: Start a flexible server. - text: az mysql flexible-server start --resource-group testGroup --name testServer + text: az mysql flexible-server start --resource-group testGroup --name testserver crafted: true """ @@ -6043,7 +5325,7 @@ short-summary: Stop a flexible server. examples: - name: Stop a flexible server. - text: az mysql flexible-server stop --resource-group testGroup --name testServer + text: az mysql flexible-server stop --resource-group testGroup --name testserver crafted: true """ @@ -6052,7 +5334,7 @@ short-summary: Update a flexible server. examples: - name: Update a flexible server's tags. - text: az mysql flexible-server update --resource-group testGroup --name testServer --tags "k1=v1" "k2=v2" + text: az mysql flexible-server update --resource-group testGroup --name testserver --tags "k1=v1" "k2=v2" crafted: true """ @@ -6061,7 +5343,7 @@ short-summary: Wait for the flexible server to satisfy certain conditions. examples: - name: Wait for the flexible server to satisfy certain conditions. - text: az mysql flexible-server wait --exists --resource-group testGroup --name testServer + text: az mysql flexible-server wait --exists --resource-group testGroup --name testserver crafted: true """ @@ -6164,185 +5446,199 @@ crafted: true """ -aladdin_helps['postgres flexible-server firewall-rule delete'] = """ +aladdin_helps['postgres server configuration list'] = """ type: command -short-summary: Delete a firewall rule. +short-summary: List the configuration values for a server. examples: - - name: Delete a firewall rule. - text: az postgres flexible-server firewall-rule delete --rule-name testRule --resource-group testGroup --name testServer + - name: List the configuration values for a server. (autogenerated) + text: az postgres server configuration list --resource-group MyResourceGroup --server-name MyServer crafted: true """ -aladdin_helps['postgres flexible-server firewall-rule show'] = """ +aladdin_helps['postgres server configuration show'] = """ type: command -short-summary: Get the details of a firewall rule. +short-summary: Get the configuration for a server." examples: - - name: Get the details of a firewall rule. - text: az postgres flexible-server firewall-rule show --rule-name testRule --resource-group testGroup --name testServer + - name: Get the configuration for a server." (autogenerated) + text: az postgres server configuration show --name MyServerConfiguration --resource-group MyResourceGroup --server-name MyServer crafted: true """ -aladdin_helps['postgres flexible-server parameter list'] = """ +aladdin_helps['postgres server firewall-rule delete'] = """ type: command -short-summary: List the parameter values for a flexible server. +short-summary: Delete a firewall rule. examples: - - name: List the parameter values for a flexible server. - text: az postgres flexible-server parameter list --resource-group testGroup --server-name servername + - name: Delete a firewall rule. (autogenerated) + text: az postgres server firewall-rule delete --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer crafted: true """ -aladdin_helps['postgres flexible-server parameter show'] = """ +aladdin_helps['postgres server firewall-rule list'] = """ type: command -short-summary: Get the parameter for a flexible server." +short-summary: List all firewall rules for a server. examples: - - name: Get the parameter for a server.W - text: az postgres flexible-server parameter show --name parameterName + - name: List all firewall rules for a server. (autogenerated) + text: az postgres server firewall-rule list --resource-group MyResourceGroup --server-name MyServer crafted: true """ -aladdin_helps['postgres flexible-server restart'] = """ +aladdin_helps['postgres server firewall-rule show'] = """ type: command -short-summary: Restart a flexible server. +short-summary: Get the details of a firewall rule. examples: - - name: Restart a flexible server. - text: az postgres flexible-server restart --resource-group testGroup --name testServer + - name: Get the details of a firewall rule. (autogenerated) + text: az postgres server firewall-rule show --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer crafted: true """ -aladdin_helps['postgres flexible-server show'] = """ +aladdin_helps['postgres server show'] = """ type: command -short-summary: Get the details of a flexible server. +short-summary: Get the details of a server. examples: - - name: Get the details of a flexible server - text: az postgres flexible-server show --resource-group testGroup --name testServer + - name: Get the details of a server. (autogenerated) + text: az postgres server show --name MyServer --resource-group MyResourceGroup crafted: true """ -aladdin_helps['postgres flexible-server start'] = """ +aladdin_helps['postgres server update'] = """ type: command -short-summary: Start a flexible server. +short-summary: Update a server. examples: - - name: Start a flexible server. - text: az postgres flexible-server start --resource-group testGroup --name testServer + - name: Update a server. (autogenerated) + text: az postgres server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled --minimal-tls-version TLS1_0 crafted: true """ -aladdin_helps['postgres flexible-server stop'] = """ +aladdin_helps['role assignment create'] = """ type: command -short-summary: Stop a flexible server. +short-summary: Create a new role assignment for a user, group, or service principal. examples: - - name: Stop a flexible server. - text: az postgres flexible-server stop --resource-group testGroup --name testServer + - name: Create a new role assignment for a user, group, or service principal. (autogenerated) + text: | + az role assignment create --assignee 00000000-0000-0000-0000-000000000000 --role "Storage Account Key Operator Service Role" --scope $id crafted: true """ -aladdin_helps['postgres flexible-server update'] = """ +aladdin_helps['role assignment delete'] = """ type: command -short-summary: Update a flexible server. +short-summary: Delete role assignments. examples: - - name: Reset password - text: az postgres flexible-server update --resource-group testGroup --name testServer -p password123 + - name: Delete role assignments. (autogenerated) + text: | + az role assignment delete --assignee 00000000-0000-0000-0000-000000000000 --role "Storage Account Key Operator Service Role" crafted: true """ -aladdin_helps['postgres server configuration list'] = """ +aladdin_helps['role definition delete'] = """ type: command -short-summary: List the configuration values for a server. +short-summary: Delete a role definition. examples: - - name: List the configuration values for a server. (autogenerated) - text: az postgres server configuration list --resource-group MyResourceGroup --server-name MyServer + - name: Delete a role definition. (autogenerated) + text: az role definition delete --name MyRole crafted: true """ -aladdin_helps['postgres server configuration show'] = """ +aladdin_helps['redis create'] = """ type: command -short-summary: Get the configuration for a server." +short-summary: Create new Redis Cache instance. +parameters: + - name: --redis-configuration + short-summary: A json file used to set redis-configuration settings. You may encounter parse errors if the json file is invalid. + long-summary: | + Usage: --redis-configuration @"{config_file.json}" + + An example json file for configuring max-memory policies + [ + { + "maxmemory-policy": "allkeys-lru" + } + ] + + An example json file for enabling the RDB back up data persistence is + [ + { + "rdb-storage-connection-string": "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=myAccountKey;EndpointSuffix=core.windows.net", + "rdb-backup-enabled": "true", + "rdb-backup-frequency": "15", + "rdb-backup-max-snapshot-count": "1" + } + ] + + An example json file for enabling the AOF back up data persistence is + [ + { + "aof-backup-enabled": "true", + "aof-storage-connection-string-0": "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=myAccountKey;EndpointSuffix=core.windows.net", + "aof-storage-connection-string-1": "DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=myAccountKey;EndpointSuffix=core.windows.net" + } + ] examples: - - name: Get the configuration for a server." (autogenerated) - text: az postgres server configuration show --name MyServerConfiguration --resource-group MyResourceGroup --server-name MyServer + - name: Create new Redis Cache instance. (autogenerated) + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Basic --vm-size c0 crafted: true -""" - -aladdin_helps['postgres server firewall-rule delete'] = """ -type: command -short-summary: Delete a firewall rule. -examples: - - name: Delete a firewall rule. (autogenerated) - text: az postgres server firewall-rule delete --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer + - name: Configure the multiple zones for new Premium Azure Cache for Redis + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Premium --vm-size p1 --zones 1 2 crafted: true -""" - -aladdin_helps['postgres server firewall-rule list'] = """ -type: command -short-summary: List all firewall rules for a server. -examples: - - name: List all firewall rules for a server. (autogenerated) - text: az postgres server firewall-rule list --resource-group MyResourceGroup --server-name MyServer + - name: Configure the memory policies for the cache. + text: az redis create --resource-group resourceGroupName --name cacheName --location westus2 --sku Standard --vm-size c0 --redis-configuration @"config_max-memory.json" crafted: true -""" - -aladdin_helps['postgres server firewall-rule show'] = """ -type: command -short-summary: Get the details of a firewall rule. -examples: - - name: Get the details of a firewall rule. (autogenerated) - text: az postgres server firewall-rule show --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer + - name: Configure and enable the RDB back up data persistence for new Premium Azure Cache for Redis. + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Premium --vm-size p1 --redis-configuration @"config_rdb.json" crafted: true -""" - -aladdin_helps['postgres server show'] = """ -type: command -short-summary: Get the details of a server. -examples: - - name: Get the details of a server. (autogenerated) - text: az postgres server show --name MyServer --resource-group MyResourceGroup + - name: Configure and enable the AOF back up data persistence for new Premium Azure Cache for Redis + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Premium --vm-size p1 --redis-configuration @"config_aof.json" crafted: true -""" - -aladdin_helps['postgres server update'] = """ -type: command -short-summary: Update a server. -examples: - - name: Update a server. (autogenerated) - text: az postgres server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled --minimal-tls-version TLS1_0 + - name: Create a Premium Azure Cache for Redis with clustering enabled + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Premium --vm-size p1 --shard-count 2 crafted: true -""" - -aladdin_helps['role assignment create'] = """ -type: command -short-summary: Create a new role assignment for a user, group, or service principal. -examples: - - name: Create a new role assignment for a user, group, or service principal. (autogenerated) - text: | - az role assignment create --assignee 00000000-0000-0000-0000-000000000000 --role "Storage Account Key Operator Service Role" --scope $id + - name: Deploying a Premium Azure Cache for Redis inside an existing Azure Virtual Network + text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Premium --vm-size p1 --subnet-id "/subscriptions/{subid}/resourceGroups/{resourceGroupName}/providers/Microsoft.{Network|ClassicNetwork}/virtualNetworks/vnet1/subnets/subnet1" crafted: true """ -aladdin_helps['role assignment delete'] = """ +aladdin_helps['redis export'] = """ type: command -short-summary: Delete role assignments. +short-summary: Export data stored in a Redis cache. examples: - - name: Delete role assignments. (autogenerated) - text: | - az role assignment delete --assignee 00000000-0000-0000-0000-000000000000 --role "Storage Account Key Operator Service Role" + - name: Use managed identity to export cache data + text: az redis export -n testCacheName -g testResourceGroup --prefix examplePrefix --container containerUrl --preferred-data-archive-auth-method ManagedIdentity crafted: true """ -aladdin_helps['role definition delete'] = """ +aladdin_helps['redis import'] = """ type: command -short-summary: Delete a role definition. +short-summary: Import data into a Redis cache. examples: - - name: Delete a role definition. (autogenerated) - text: az role definition delete --name MyRole + - name: Use managed identity to import cache data + text: az redis import -n testCacheName -g testResourceGroup --files blobUrl --preferred-data-archive-auth-method ManagedIdentity crafted: true """ -aladdin_helps['redis create'] = """ +aladdin_helps['redis update'] = """ type: command -short-summary: Create new Redis Cache instance. +short-summary: Update a Redis cache. +long-summary: Scale or update settings of a Redis cache. examples: - - name: Create new Redis Cache instance. (autogenerated) - text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Basic --vm-size c0 + - name: Update the maxmemory-policy for your Azure Cache for Redis named MyRedisCache + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set "redisConfiguration.maxmemory-policy"="allkeys-lru" + crafted: true + - name: Disable the RDB back up data persistence for Premium Azure Cache for Redis + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set "redisConfiguration.rdb-backup-enabled"="false" + crafted: true + - name: Configure the RDB back up enabled data persistence for already created Premium Azure Cache for Redis + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set "redisConfiguration.rdb-storage-connection-string"="BlobEndpoint=https//..." "redisConfiguration.rdb-backup-enabled"="true" "redisConfiguration.rdb-backup-frequency"="15" "redisConfiguration.rdb-backup-max-snapshot-count"="1" + crafted: true + - name: Scale an Azure Cache for Redis Instance - Update to different size (An example to scale from c0 to c1). + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set "sku.capacity"="2" + crafted: true + - name: Scale an Azure Cache for Redis Instance - Update to different tier (From Basic to Standard or Standard to Premium). + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set "sku.name"="Premium" "sku.capacity"="1" "sku.family"="P" + crafted: true + - name: Scale an Azure Cache for Redis Instance - Enable Clustering. + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set shardCount=1 + crafted: true + - name: Scale an Azure Cache for Redis Instance in/out using Redis Cluster. + text: az redis update --name MyRedisCache --resource-group MyResourceGroup --set shardCount=2 crafted: true """ @@ -6364,11 +5660,10 @@ crafted: true """ - - aladdin_helps['deployment group validate'] = """ type: command short-summary: Validate whether a template is valid at resource group. +long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template. parameters: - name: --parameters -p short-summary: Supply deployment parameter values. @@ -6407,6 +5702,7 @@ aladdin_helps['deployment mg validate'] = """ type: command short-summary: Validate whether a template is valid at management group. +long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template. parameters: - name: --parameters -p short-summary: Supply deployment parameter values. @@ -6465,6 +5761,7 @@ aladdin_helps['deployment sub validate'] = """ type: command short-summary: Validate whether a template is valid at subscription scope. +long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template. parameters: - name: --parameters -p short-summary: Supply deployment parameter values. @@ -6501,6 +5798,7 @@ aladdin_helps['deployment tenant validate'] = """ type: command short-summary: Validate whether a template is valid at tenant scope. +long-summary: Please specify only one of --template-file FILE | --template-uri URI | --template-spec to input the ARM template. parameters: - name: --parameters -p short-summary: Supply deployment parameter values. @@ -6753,9 +6051,9 @@ type: command short-summary: Show a policy set definition. examples: - - name: Show a policy set definition. (autogenerated) + - name: Show a policy set definition. If the policy set is scoped to a management group, then you must include the `--management-group` parameter and value. text: | - az policy set-definition show --name MyPolicySetDefinition + az policy set-definition show --name MyPolicySetDefinition --management-group MyManagementGroup crafted: true """ @@ -6939,6 +6237,8 @@ + + aladdin_helps['sql db delete'] = """ type: command short-summary: Delete a database. @@ -6950,9 +6250,9 @@ aladdin_helps['sql db list'] = """ type: command -short-summary: List databases a server or elastic pool. +short-summary: List databases on a server or elastic pool. examples: - - name: List databases a server or elastic pool. (autogenerated) + - name: List databases on a server or elastic pool. (autogenerated) text: az sql db list --resource-group MyResourceGroup --server myserver crafted: true """ @@ -7114,1456 +6414,1418 @@ crafted: true """ - - -aladdin_helps['storage account encryption-scope create'] = """ +aladdin_helps['disk delete'] = """ type: command -short-summary: Create an encryption scope within storage account. +short-summary: Delete a managed disk. examples: - - name: Create an encryption scope within storage account. (autogenerated) + - name: Delete a managed disk. (autogenerated) text: | - az storage account encryption-scope create --account-name mystorageaccount --key-source Microsoft.Storage --name myencryption --resource-group MyResourceGroup --subscription mysubscription + az disk delete --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage account generate-sas'] = """ +aladdin_helps['disk grant-access'] = """ type: command -short-summary: Generate a shared access signature for the storage account. -parameters: - - name: --services - short-summary: 'The storage services the SAS is applicable for. Allowed values: (b)lob (f)ile (q)ueue (t)able. Can be combined.' - - name: --resource-types - short-summary: 'The resource types the SAS is applicable for. Allowed values: (s)ervice (c)ontainer (o)bject. Can be combined.' - - name: --expiry - short-summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. - - name: --start - short-summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Defaults to the time of the request. - - name: --account-name - short-summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment Variable: AZURE_STORAGE_ACCOUNT' +short-summary: Grant a resource access to a managed disk. examples: - - name: Generate a shared access signature for the account (autogenerated) + - name: Grant a resource read access to a managed disk. (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 + az disk grant-access --access-level Read --duration-in-seconds 3600 --name MyManagedDisk --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage account management-policy create'] = """ +aladdin_helps['disk revoke-access'] = """ type: command -short-summary: Create the data policy rules associated with the specified storage account. +short-summary: Revoke a resource's read access to a managed disk. examples: - - name: Create the data policy rules associated with the specified storage account. (autogenerated) + - name: Revoke a resource's read access to a managed disk. (autogenerated) text: | - az storage account management-policy create --account-name myaccount --policy @policy.json --resource-group myresourcegroup + 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 crafted: true """ -aladdin_helps['storage account network-rule list'] = """ +aladdin_helps['disk update'] = """ type: command -short-summary: List network rules. +short-summary: Update a managed disk. examples: - - name: List network rules. (autogenerated) + - name: Update a managed disk. (autogenerated) text: | - az storage account network-rule list --account-name MyAccount --resource-group MyResourceGroup + az disk update --name MyManagedDisk --resource-group MyResourceGroup --size-gb 20 crafted: true """ -aladdin_helps['storage account network-rule remove'] = """ +aladdin_helps['disk wait'] = """ type: command -short-summary: Remove a network rule. +short-summary: Place the CLI in a waiting state until a condition of a managed disk is met. examples: - - name: Remove a network rule. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) text: | - az storage account network-rule remove --account-name MyAccount --resource-group MyResourceGroup --subnet MySubnetID + az disk wait --created --name MyManagedDisk --resource-group MyResourceGroup crafted: true - - name: Remove a network rule. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) text: | - az storage account network-rule remove --account-name MyAccount --ip-address 23.45.1.0/24 --resource-group MyResourceGroup + az disk wait --deleted --name MyManagedDisk --resource-group MyResourceGroup --subscription mysubscription crafted: true """ -aladdin_helps['storage account show-connection-string'] = """ +aladdin_helps['disk-encryption-set delete'] = """ type: command -short-summary: Get the connection string for a storage account. +short-summary: Delete a disk encryption set. examples: - - name: Get the connection string for a storage account. (autogenerated) + - name: Delete a disk encryption set. (autogenerated) text: | - az storage account show-connection-string --name MyStorageAccount --resource-group MyResourceGroup --subscription MySubscription + az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage account show-usage'] = """ +aladdin_helps['disk-encryption-set show'] = """ type: command -short-summary: Show the current count and limit of the storage accounts under the subscription. +short-summary: Get information of a disk encryption sets. examples: - - name: Show the current count and limit of the storage accounts under the subscription. (autogenerated) + - name: Get information of a disk encryption sets (autogenerated) text: | - az storage account show-usage --location westus2 + az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage account update'] = """ +aladdin_helps['disk-encryption-set update'] = """ type: command -short-summary: Update the properties of a storage account. +short-summary: Update a disk encryption set. examples: - - name: Update the properties of a storage account. (autogenerated) + - name: Update a disk encryption set. (autogenerated) text: | - az storage account update --default-action Allow --name MyStorageAccount --resource-group MyResourceGroup + az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault crafted: true """ -aladdin_helps['storage blob copy start-batch'] = """ +aladdin_helps['image builder delete'] = """ type: command -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 - short-summary: The blob container where the selected source files or blobs will be copied to. - - name: --pattern - type: string - short-summary: The pattern used for globbing files or blobs in the source. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. - long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. - - name: --dryrun - type: bool - short-summary: List the files or blobs to be uploaded. No actual data transfer will occur. - - name: --source-account-name - type: string - short-summary: The source storage account from which the files or blobs are copied to the destination. If omitted, the source account is used. - - name: --source-account-key - type: string - short-summary: The account key for the source storage account. - - name: --source-container - type: string - short-summary: The source container from which blobs are copied. - - name: --source-share - type: string - short-summary: The source share from which files are copied. - - name: --source-uri - type: string - short-summary: A URI specifying a file share or blob container from which the files or blobs are copied. - long-summary: If the source is in another account, the source must either be public or be authenticated by using a shared access signature. - - name: --source-sas - type: string - short-summary: The shared access signature for the source storage account. +short-summary: Delete image builder template. examples: - - name: Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs. (autogenerated) + - name: Delete image builder template. (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 + az image builder delete --name MyImageTemplate --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob exists'] = """ +aladdin_helps['image builder show'] = """ type: command -short-summary: Check for the existence of a blob in a container. -parameters: - - name: --name -n - short-summary: The blob name. +short-summary: Show an image builder template. examples: - - name: Check for the existence of a blob in a container. (autogenerated) + - name: Show an image builder template (autogenerated) text: | - az storage blob exists --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob + az image builder show --name mytemplate --resource-group my-group crafted: true """ -aladdin_helps['storage blob generate-sas'] = """ +aladdin_helps['ppg create'] = """ type: command -short-summary: Generate a shared access signature for the blob. +short-summary: Create a proximity placement group examples: - - name: Generate a shared access signature for the blob. (autogenerated) + - name: Create a proximity placement group (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 + az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob incremental-copy start'] = """ +aladdin_helps['ppg list'] = """ type: command -short-summary: Copies an incremental copy of a blob asynchronously. -long-summary: This operation returns a copy operation properties object, including a copy ID you can use to check or abort the copy operation. The Blob service copies blobs on a best-effort basis. The source blob for an incremental copy operation must be a page blob. Call get_blob_properties on the destination blob to check the status of the copy operation. The final blob will be committed when the copy completes. -parameters: - - name: --source-uri -u - short-summary: > - A URL of up to 2 KB in length that specifies an Azure page blob. - The value should be URL-encoded as it would appear in a request URI. - The copy source must be a snapshot and include a valid SAS token or be public. - Example: - `https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=&sastoken` +short-summary: List proximity placement groups examples: - - name: Copies an incremental copy of a blob asynchronously. (autogenerated) + - name: List proximity placement groups (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 - crafted: true - - name: Copy an incremental copy of a blob asynchronously. (autogenerated) - text: | - az storage blob incremental-copy start --connection-string myconnectionstring --destination-blob mydestinationblob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos + az ppg list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob service-properties delete-policy show'] = """ +aladdin_helps['ppg show'] = """ type: command -short-summary: Show the storage blob delete-policy. +short-summary: Get a proximity placement group examples: - - name: Show the storage blob delete-policy. (autogenerated) - text: | - az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 - crafted: true - - name: Show the storage blob delete-policy. (autogenerated) + - name: Get a proximity placement group (commonly used with --output). (autogenerated) text: | - az storage blob service-properties delete-policy show --account-name mystorageccount --auth-mode login + az ppg show --name MyProximityPlacementGroup --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob service-properties delete-policy update'] = """ +aladdin_helps['sig image-version wait'] = """ type: command -short-summary: Update the storage blob delete-policy. +short-summary: wait for image version related operation examples: - - name: Update the storage blob delete-policy. (autogenerated) + - name: wait for image version related operation. (autogenerated) text: | - az storage blob service-properties delete-policy update --account-name mystorageccount --account-key 00000000 --days-retained 7 --enable true + az sig image-version wait --created --resource-group MyResourceGroup \\ + --gallery-name MyGallery --gallery-image-definition MyImage \\ + --gallery-image-version 1.0.0 crafted: true """ -aladdin_helps['storage blob service-properties update'] = """ +aladdin_helps['snapshot grant-access'] = """ type: command -short-summary: Update storage blob service properties. +short-summary: Grant read access to a snapshot. examples: - - name: Update storage blob service properties. (autogenerated) + - name: Grant read access to a snapshot. (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 + az snapshot grant-access --duration-in-seconds 3600 --name MySnapshot --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob set-tier'] = """ +aladdin_helps['snapshot revoke-access'] = """ type: command -short-summary: Set the block or page tiers on the blob. -parameters: - - name: --type -t - short-summary: The blob type - - name: --tier - short-summary: The tier value to set the blob to. - - name: --timeout - short-summary: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually. -long-summary: > - For block blob this command only supports block blob on standard storage accounts. - For page blob, this command only supports for page blobs on premium accounts. +short-summary: Revoke read access to a snapshot. examples: - - name: Set the block or page tiers on the blob. (autogenerated) + - name: Revoke read access to a snapshot. (autogenerated) text: | - az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob --tier P10 + az snapshot revoke-access --name MySnapshot --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage blob show'] = """ +aladdin_helps['snapshot update'] = """ type: command -short-summary: Get the details of a blob. +short-summary: Update a snapshot. examples: - - name: Get the details of a blob (autogenerated) + - name: Update a snapshot. (autogenerated) text: | - az storage blob show --account-name mystorageccount --account-key 00000000 --container-name mycontainer --name MyBlob + az snapshot update --name MySnapshot --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['storage blob upload'] = """ +aladdin_helps['snapshot wait'] = """ type: command -short-summary: Upload a file to a storage blob. -long-summary: Creates a new blob from a file path, or updates the content of an existing blob with automatic chunking and progress notifications. -parameters: - - name: --type -t - short-summary: Defaults to 'page' for *.vhd files, or 'block' otherwise. - - name: --maxsize-condition - short-summary: The max length in bytes permitted for an append blob. - - name: --validate-content - short-summary: Specifies that an MD5 hash shall be calculated for each chunk of the blob and verified by the service when the chunk has arrived. - - name: --tier - short-summary: A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts. +short-summary: Place the CLI in a waiting state until a condition of a snapshot is met. examples: - - name: Upload a file to a storage blob. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a snapshot is met. (autogenerated) text: | - az storage blob upload --account-name mystorageaccount --account-key 0000-0000 --container-name mycontainer --file /path/to/file --name myblob + 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 """ -aladdin_helps['storage blob url'] = """ +aladdin_helps['vm boot-diagnostics enable'] = """ type: command -short-summary: Create the url to access a blob. +short-summary: Enable the boot diagnostics on a VM. +parameters: + - name: --storage + short-summary: Name or URI of a storage account (e.g. https://your_storage_account_name.blob.core.windows.net/). If it's not specified, managed storage will be used. examples: - - name: Create the url to access a blob (autogenerated) - text: | - az storage blob url --connection-string $connectionString --container-name container1 --name blob1 - crafted: true - - name: Create the url to access a blob (autogenerated) + - name: Enable the boot diagnostics on a VM. (autogenerated) text: | - az storage blob url --account-name storageacct --account-key 00000000 --container-name container1 --name blob1 + az vm boot-diagnostics enable --name MyVirtualMachine --resource-group MyResourceGroup --storage https://mystor.blob.core.windows.net/ crafted: true """ -aladdin_helps['storage container delete'] = """ +aladdin_helps['vm boot-diagnostics get-boot-log'] = """ type: command -short-summary: Marks the specified container for deletion. -long-summary: > - The container and any blobs contained within it are later deleted during garbage collection. +short-summary: Get the boot diagnostics log from a VM. examples: - - name: Marks the specified container for deletion. (autogenerated) + - name: Get the boot diagnostics log from a VM. (autogenerated) text: | - az storage container delete --account-key 00000000 --account-name MyAccount --name mycontainer + az vm boot-diagnostics get-boot-log --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage container exists'] = """ +aladdin_helps['vm deallocate'] = """ type: command -short-summary: Check for the existence of a storage container. +short-summary: Deallocate a VM so that computing resources are no longer allocated (charges no longer apply). The status will change from 'Stopped' to 'Stopped (Deallocated)'. +long-summary: 'For an end-to-end tutorial, see https://docs.microsoft.com/azure/virtual-machines/linux/capture-image' examples: - - name: Check for the existence of a storage container. (autogenerated) + - name: Deallocate a VM. (autogenerated) text: | - az storage container exists --account-name mystorageccount --account-key 00000000 --name mycontainer + az vm deallocate --name MyVm --no-wait --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage container generate-sas'] = """ +aladdin_helps['vm disk attach'] = """ type: command -short-summary: Generate a SAS token for a storage container. +short-summary: Attach a managed persistent disk to a VM. +long-summary: This allows for the preservation of data, even if the VM is reprovisioned due to maintenance or resizing. examples: - - name: Generate a shared access signature for the container (autogenerated) + - name: Attach a managed persistent disk to a VM. (autogenerated) text: | - az storage container generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2020-01-01 --name mycontainer --permissions dlrw + az vm disk attach --name $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm crafted: true - - name: Generate a SAS token for a storage container. (autogenerated) + - name: Attach multiple managed disks to a VM. text: | - az storage container generate-sas --account-name mystorageaccount --as-user --auth-mode login --expiry 2020-01-01 --name container1 --permissions dlrw + az vm disk attach --vm-name MyVm --resource-group MyResourceGroup --sku Standard_LRS --disks diskId1 diskId2 diskId3 crafted: true """ -aladdin_helps['storage container legal-hold show'] = """ +aladdin_helps['vm encryption disable'] = """ type: command -short-summary: Get the legal hold properties of a container. +short-summary: Disable disk encryption on the OS disk and/or data disks. Decrypt mounted disks. +long-summary: | + For Linux VMs, disabling encryption is only permitted on data volumes. + For Windows VMs, disabling encryption is permitted on both OS and data volumes. examples: - - name: Get the legal hold properties of a container. (autogenerated) + - name: Disable disk encryption on the OS disk and/or data disks. (autogenerated) text: | - az storage container legal-hold show --account-name mystorageccount --container-name mycontainer + az vm encryption disable --name MyVirtualMachine --resource-group MyResourceGroup --volume-type DATA crafted: true """ -aladdin_helps['storage cors clear'] = """ +aladdin_helps['vm encryption enable'] = """ type: command -short-summary: Remove all CORS rules from a storage account. +short-summary: "Enable disk encryption on the OS disk and/or data disks. Encrypt mounted disks." +long-summary: | + Note that Azure Active Directory / service principal arguments are unnecessary for vm encryption. The older version of Azure Disk Encryption required AAD arguments. + For more information, see: + https://docs.microsoft.com/azure/security/fundamentals/azure-disk-encryption-vms-vmss parameters: - - name: --services - short-summary: > - The storage service(s) to remove rules from. Allowed options are: (b)lob, (f)ile, - (q)ueue, (t)able. Can be combined. + - name: --aad-client-id + short-summary: Client ID of an AAD app with permissions to write secrets to the key vault. + - name: --aad-client-secret + short-summary: Client secret of the AAD app with permissions to write secrets to the key vault. + - name: --aad-client-cert-thumbprint + short-summary: Thumbprint of the AAD app certificate with permissions to write secrets to the key vault. examples: - - name: Remove all CORS rules from a storage account. (autogenerated) + - name: Enable disk encryption on the OS disk and/or data disks. Encrypt mounted disks. (autogenerated) text: | - az storage cors clear --account-name MyAccount --services bfqt + az vm encryption enable --disk-encryption-keyvault MyVault --name MyVm --resource-group MyResourceGroup --volume-type DATA crafted: true """ -aladdin_helps['storage cors list'] = """ +aladdin_helps['vm encryption show'] = """ type: command -short-summary: List all CORS rules for a storage account. -parameters: - - name: --services - short-summary: > - The storage service(s) to list rules for. Allowed options are: (b)lob, (f)ile, - (q)ueue, (t)able. Can be combined. +short-summary: Show encryption status. examples: - - name: List all CORS rules for a storage account. (autogenerated) + - name: Show encryption status. (autogenerated) text: | - az storage cors list --account-key 00000000 --account-name mystorageaccount + az vm encryption show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage directory exists'] = """ +aladdin_helps['vm extension wait'] = """ type: command -short-summary: Check for the existence of a storage directory. +short-summary: Place the CLI in a waiting state until a condition of a virtual machine extension is met. examples: - - name: Check for the existence of a storage directory. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) text: | - az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare + az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm crafted: true -""" - -aladdin_helps['storage directory list'] = """ -type: command -short-summary: List directories in a share. -examples: - - name: List directories in a share. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) text: | - az storage directory list --account-key 00000000 --account-name MyAccount --share-name MyShare + az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm crafted: true -""" - -aladdin_helps['storage entity insert'] = """ -type: command -short-summary: Insert an entity into a table. -parameters: - - name: --table-name -t - type: string - short-summary: The name of the table to insert the entity into. - - name: --entity -e - type: list - short-summary: Space-separated list of key=value pairs. Must contain a PartitionKey and a RowKey. - long-summary: The PartitionKey and RowKey must be unique within the table, and may be up to 64Kb in size. If using an integer value as a key, convert it to a fixed-width string which can be canonically sorted. For example, convert the integer value 1 to the string value "0000001" to ensure proper sorting. - - name: --if-exists - type: string - short-summary: Behavior when an entity already exists for the specified PartitionKey and RowKey. - - name: --timeout - short-summary: The server timeout, expressed in seconds. -examples: - - name: Insert an entity into a table. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) text: | - az storage entity insert --connection-string $connectionString --entity PartitionKey=AAA RowKey=BBB Content=ASDF2 --if-exists fail --table-name MyTable + az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm crafted: true """ -aladdin_helps['storage entity query'] = """ +aladdin_helps['vm host create'] = """ type: command -short-summary: List entities which satisfy a query. -parameters: - - name: --marker - type: list - short-summary: Space-separated list of key=value pairs. Must contain a nextpartitionkey and a nextrowkey. - 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. +short-summary: Create a dedicated host. examples: - - name: List entities which satisfy a query. (autogenerated) + - name: Create a dedicated host (autogenerated) text: | - az storage entity query --table-name MyTable + az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1 crafted: true """ -aladdin_helps['storage file delete-batch'] = """ +aladdin_helps['vm host group create'] = """ type: command -short-summary: Delete files from an Azure Storage File Share. -parameters: - - name: --source -s - type: string - short-summary: The source of the file delete operation. The source can be the file share URL or the share name. - - name: --pattern - type: string - short-summary: The pattern used for file globbing. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. - long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. - - name: --dryrun - type: bool - short-summary: List the files and blobs to be deleted. No actual data deletion will occur. +short-summary: Create a dedicated host group. 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 - crafted: true - - name: Delete files from an Azure Storage File Share. (autogenerated) + - name: Create a dedicated host group. (autogenerated) text: | - az storage file delete-batch --account-key 00000000 --account-name MyAccount --pattern *.py --source /path/to/file + az vm host group create --name MyDedicatedHostGroup --platform-fault-domain-count 2 --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage file download-batch'] = """ +aladdin_helps['vm host list'] = """ type: command -short-summary: Download files from an Azure Storage File Share to a local directory in a batch operation. -parameters: - - name: --source -s - type: string - short-summary: The source of the file download operation. The source can be the file share URL or the share name. - - name: --destination -d - type: string - short-summary: The local directory where the files are downloaded to. This directory must already exist. - - name: --pattern - type: string - short-summary: The pattern used for file globbing. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. - long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. - - name: --dryrun - type: bool - short-summary: List the files and blobs to be downloaded. No actual data transfer will occur. - - name: --max-connections - type: integer - short-summary: The maximum number of parallel connections to use. Default value is 1. - - name: --snapshot - type: string - short-summary: A string that represents the snapshot version, if applicable. - - name: --validate-content - type: bool - short-summary: If set, calculates an MD5 hash for each range of the file for validation. - long-summary: > - The storage service checks the hash of the content that has arrived is identical to the hash that was sent. - This is mostly valuable for detecting bitflips during transfer if using HTTP instead of HTTPS. This hash is not stored. +short-summary: List dedicated hosts. examples: - - name: Download files from an Azure Storage File Share to a local directory in a batch operation. (autogenerated) + - name: List dedicated hosts. (autogenerated) text: | - az storage file download-batch --account-key 00000000 --account-name MyAccount --destination . --no-progress --source /path/to/file + az vm host list --host-group my-host-group --resource-group my-rg crafted: true """ -aladdin_helps['storage file exists'] = """ +aladdin_helps['vm host show'] = """ type: command -short-summary: Check for the existence of a file. +short-summary: Get the details of a dedicated host. 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 - crafted: true - - name: Check for the existence of a file. (autogenerated) + - name: Get the details of a dedicated host (autogenerated) text: | - az storage file exists --connection-string $connectionString --path path/file.txt --share-name MyShare + az vm host show --host-group my-host-group --name MyDedicatedHost --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage file generate-sas'] = """ +aladdin_helps['vm identity show'] = """ type: command +short-summary: display VM's managed identity info. examples: - - 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 - - name: Generate a shared access signature for the file. (autogenerated) + - name: display VM's managed identity info. (autogenerated) text: | - az storage file generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2037-12-31T23:59:00Z --https-only --path path/file.txt --permissions rcdw --share-name myshare + az vm identity show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage file list'] = """ +aladdin_helps['vm image accept-terms'] = """ type: command -short-summary: List files and directories in a share. -parameters: - - name: --exclude-dir - type: bool - short-summary: List only files in the given share. +short-summary: Accept Azure Marketplace term so that the image can be used to create VMs examples: - - name: List files and directories in a share. (autogenerated) + - name: Accept Azure Marketplace term so that the image can be used to create VMs. (autogenerated) text: | - az storage file list --share-name MyShare + az vm image accept-terms --urn publisher:offer:sku:version crafted: true """ -aladdin_helps['storage file upload'] = """ +aladdin_helps['vm image show'] = """ type: command -short-summary: Upload a file to a share that uses the SMB 3.0 protocol. -long-summary: Creates or updates an Azure file from a source path with automatic chunking and progress notifications. +short-summary: Get the details for a VM image available in the Azure Marketplace. examples: - - name: Upload a file to a share that uses the SMB 3.0 protocol. (autogenerated) + - name: Get the details for a VM image available in the Azure Marketplace. (autogenerated) text: | - az storage file upload --account-key 00000000 --account-name MyStorageAccount --path path/file.txt --share-name MyShare --source /path/to/file + az vm image show --location westus --urn publisher:offer:sku:version crafted: true """ -aladdin_helps['storage file url'] = """ +aladdin_helps['vm image terms cancel'] = """ type: command -short-summary: Create the url to access a file. +short-summary: Cancel Azure Marketplace image terms. examples: - - name: Create the url to access a file. (autogenerated) + - name: Cancel Azure Marketplace image terms. (autogenerated) text: | - az storage file url --account-key 00000000 --account-name mystorageaccount --path path/file.txt --share-name myshare + az vm image terms cancel --subscription MySubscription --urn publisher:offer:sku:version crafted: true """ -aladdin_helps['storage fs create'] = """ +aladdin_helps['vm monitor metrics list-definitions'] = """ type: command -short-summary: Create file system for Azure Data Lake Storage Gen2 account. +short-summary: List the metric definitions for a VM. examples: - - name: Create file system for Azure Data Lake Storage Gen2 account. (autogenerated) + - name: List the metric definitions for a VM. (autogenerated) text: | - az storage fs create --account-name mystorageaccount --auth-mode login --name fsname + az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage fs directory delete'] = """ +aladdin_helps['vm nic set'] = """ type: command -short-summary: Delete a directory in ADLS Gen2 file system. +short-summary: Configure settings of a NIC attached to a VM. examples: - - name: Delete a directory in ADLS Gen2 file system. (autogenerated) + - name: Configure settings of a NIC attached to a VM. (autogenerated) text: | - az storage fs directory delete --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --yes + az vm nic set --nics nic_name1 nic_name2 --primary-nic nic_name2 --resource-group MyResourceGroup --vm-name MyVm crafted: true """ -aladdin_helps['storage fs directory exists'] = """ +aladdin_helps['vm secret add'] = """ type: command -short-summary: Check for the existence of a directory in ADLS Gen2 file system. +short-summary: Add a secret to a VM. +long-summary: 'To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows) instead of `az vm secret add`.' examples: - - name: Check for the existence of a directory in ADLS Gen2 file system. (autogenerated) + - name: Add a secret to a VM. (autogenerated) text: | - az storage fs directory exists --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + az vm secret add --certificate {certificate} --keyvault {keyvault} --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage fs directory move'] = """ +aladdin_helps['vm secret list'] = """ type: command -short-summary: Move a directory in ADLS Gen2 file system. +short-summary: List secrets on a VM. examples: - - name: Move a directory in ADLS Gen2 file system. (autogenerated) + - name: List secrets on a VM. (autogenerated) text: | - az storage fs directory move --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --new-directory newfs/dir + az vm secret list --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage fs directory show'] = """ +aladdin_helps['vm start'] = """ type: command -short-summary: Show properties of a directory in ADLS Gen2 file system. +short-summary: Start a stopped VM. examples: - - name: Show properties of a directory in ADLS Gen2 file system. (autogenerated) + - name: Start a stopped VM. (autogenerated) text: | - az storage fs directory show --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + az vm start --name MyVm --no-wait --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage fs file show'] = """ +aladdin_helps['vm unmanaged-disk attach'] = """ type: command -short-summary: Show properties of file in ADLS Gen2 file system. +short-summary: Attach an unmanaged persistent disk to a VM. +long-summary: This allows for the preservation of data, even if the VM is reprovisioned due to maintenance or resizing. examples: - - name: Show properties of file in ADLS Gen2 file system. (autogenerated) + - name: Attach an unmanaged persistent disk to a VM. (autogenerated) text: | - az storage fs file show --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt + az vm unmanaged-disk attach --name MyDataDisk --new --resource-group MyResourceGroup --size-gb 50 --vm-name MyVm crafted: true """ -aladdin_helps['storage fs show'] = """ +aladdin_helps['vmss deallocate'] = """ type: command -short-summary: Show properties of file system in ADLS Gen2 account. +short-summary: Deallocate VMs within a VMSS. examples: - - name: Show properties of file system in ADLS Gen2 account. (autogenerated) + - name: Deallocate VMs within a VMSS. (autogenerated) text: | - az storage fs show --account-name myadlsaccount --auth-mode login --name myfilesystem + az vmss deallocate --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage logging show'] = """ +aladdin_helps['vmss delete-instances'] = """ type: command -short-summary: Show logging settings for a storage account. -parameters: - - name: --services - short-summary: 'The storage services from which to retrieve logging info: (b)lob (q)ueue (t)able. Can be combined.' +short-summary: Delete VMs within a VMSS. examples: - - name: Show logging settings for a storage account. (autogenerated) + - name: Delete VMs within a VMSS. (autogenerated) text: | - az storage logging show --account-name MyAccount --services qt + az vmss delete-instances --instance-ids 0 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage metrics show'] = """ +aladdin_helps['vmss diagnostics set'] = """ type: command -short-summary: Show metrics settings for a storage account. -parameters: - - name: --services - short-summary: 'The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.' - - name: --interval - short-summary: Filter the set of metrics to retrieve by time interval +short-summary: Enable diagnostics on a VMSS. examples: - - name: Show metrics settings for a storage account. (autogenerated) + - name: Enable diagnostics on a VMSS. (autogenerated) text: | - az storage metrics show --account-key 00000000 --account-name MyAccount + az vmss diagnostics set --protected-settings {protected-settings} --resource-group MyResourceGroup --settings '{"commandToExecute": "echo testing"}' --vmss-name MyVmss crafted: true """ -aladdin_helps['storage metrics update'] = """ +aladdin_helps['vmss disk attach'] = """ type: command -short-summary: Update metrics settings for a storage account. -parameters: - - name: --services - short-summary: 'The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.' - - name: --hour - short-summary: Update the hourly metrics - - name: --minute - short-summary: Update the by-minute metrics - - name: --api - short-summary: Specify whether to include API in metrics. Applies to both hour and minute metrics if both are specified. Must be specified if hour or minute metrics are enabled and being updated. - - name: --retention - short-summary: Number of days for which to retain metrics. 0 to disable. Applies to both hour and minute metrics if both are specified. +short-summary: Attach managed data disks to a scale set or its instances. examples: - - name: Update metrics settings for a storage account. (autogenerated) + - name: Attach managed data disks to a scale set or its instances. (autogenerated) text: | - az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt + az vmss disk attach --disk {disk} --instance-id 0 --resource-group MyResourceGroup crafted: true - - name: Update metrics settings for a storage account by connection string. (autogenerated) + - name: Attach managed data disks of a given size to a scale set or its instances. (autogenerated) text: | - az storage metrics update --api true --connection-string $connectionString --hour true --minute true --retention 10 --services bfqt + az vmss disk attach --vmss-name MyVmss --resource-group MyResourceGroup --size-gb 50 crafted: true """ -aladdin_helps['storage share create'] = """ +aladdin_helps['vmss disk detach'] = """ type: command -short-summary: Creates a new share under the specified account. +short-summary: Detach managed data disks from a scale set or its instances. examples: - - name: Creates a new share under the specified account. (autogenerated) + - name: Detach managed data disks from a scale set or its instances. (autogenerated) text: | - az storage share create --account-name MyAccount --name MyFileShare + az vmss disk detach --instance-id 0 --lun {lun} --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage share exists'] = """ +aladdin_helps['vmss encryption enable'] = """ type: command -short-summary: Check for the existence of a file share. +short-summary: "Encrypt a VMSS with managed disks." +long-summary: "For more information, see: For more information, see: ttps://docs.microsoft.com/azure/security/fundamentals/azure-disk-encryption-vms-vmss" examples: - - name: Check for the existence of a file share. (autogenerated) - 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) + - name: Encrypt a VMSS with managed disks. (autogenerated) text: | - az storage share exists --connection-string $connectionString --name MyFileShare + az vmss encryption enable --disk-encryption-keyvault MyVault --name MyVmss --resource-group MyResourceGroup --volume-type DATA crafted: true """ -aladdin_helps['storage share generate-sas'] = """ +aladdin_helps['vmss encryption show'] = """ type: command +short-summary: Show encryption status. examples: - - 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: Generate a shared access signature for the share. (autogenerated) + - name: Show encryption status. (autogenerated) text: | - az storage share generate-sas --connection-string $connectionString --expiry 2019-02-01T12:20Z --name MyShare --permissions dlrw + az vmss encryption show --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['storage share url'] = """ +aladdin_helps['vmss extension delete'] = """ type: command -short-summary: Create a URI to access a file share. +short-summary: Delete an extension from a VMSS. examples: - - name: Create a URI to access a file share. (autogenerated) + - name: Delete an extension from a VMSS. (autogenerated) text: | - az storage share url --account-key 00000000 --account-name MyAccount --name MyFileShare + az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ - - - - -aladdin_helps['disk delete'] = """ +aladdin_helps['vmss extension list'] = """ type: command -short-summary: Delete a managed disk. +short-summary: List extensions associated with a VMSS. examples: - - name: Delete a managed disk. (autogenerated) + - name: List extensions associated with a VMSS. (autogenerated) text: | - az disk delete --name MyManagedDisk --resource-group MyResourceGroup + az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ -aladdin_helps['disk grant-access'] = """ +aladdin_helps['vmss extension show'] = """ type: command -short-summary: Grant a resource access to a managed disk. +short-summary: Show details on a VMSS extension. examples: - - name: Grant a resource read access to a managed disk. (autogenerated) + - name: Show details on a VMSS extension. (autogenerated) text: | - az disk grant-access --access-level Read --duration-in-seconds 3600 --name MyManagedDisk --resource-group MyResourceGroup + az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss crafted: true """ -aladdin_helps['disk revoke-access'] = """ +aladdin_helps['vmss get-instance-view'] = """ type: command -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 - crafted: true - - name: Revoke a resource's read access to a managed disk. (autogenerated) +short-summary: View an instance of a VMSS. +parameters: + - name: --instance-id + short-summary: A VM instance ID or "*" to list instance view for all VMs in a scale set. +examples: + - name: View an instance of a VMSS. (autogenerated) text: | - az disk revoke-access --name MyManagedDisk --resource-group MyResourceGroup + az vmss get-instance-view --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['disk update'] = """ +aladdin_helps['vmss identity assign'] = """ type: command -short-summary: Update a managed disk. +short-summary: Enable managed service identity on a VMSS. +long-summary: This is required to authenticate and interact with other Azure services using bearer tokens. examples: - - name: Update a managed disk. (autogenerated) + - name: Enable managed service identity on a VMSS. (autogenerated) text: | - az disk update --name MyManagedDisk --resource-group MyResourceGroup --size-gb 20 + az vmss identity assign --identities readerId writerId --name MyVmss --resource-group MyResourceGroup crafted: true """ -aladdin_helps['disk wait'] = """ +aladdin_helps['vmss identity show'] = """ type: command -short-summary: Place the CLI in a waiting state until a condition of a managed disk is met. +short-summary: display VM scaleset's managed identity info. 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 - crafted: true - - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) + - name: display VM scaleset's managed identity info. (autogenerated) text: | - az disk wait --deleted --name MyManagedDisk --resource-group MyResourceGroup --subscription mysubscription + az vmss identity show --name MyVirtualMachine --resource-group MyResourceGroup crafted: true """ -aladdin_helps['disk-encryption-set delete'] = """ +aladdin_helps['vmss list'] = """ type: command -short-summary: Delete a disk encryption set. +short-summary: List VMSS. examples: - - name: Delete a disk encryption set. (autogenerated) + - name: List VMSS (autogenerated) text: | - az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup + az vmss list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['disk-encryption-set show'] = """ +aladdin_helps['vmss list-instance-connection-info'] = """ type: command -short-summary: Get information of a disk encryption sets. +short-summary: Get the IP address and port number used to connect to individual VM instances within a set. examples: - - name: Get information of a disk encryption sets (autogenerated) + - name: Get the IP address and port number used to connect to individual VM instances within a set. (autogenerated) text: | - az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup + az vmss list-instance-connection-info --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['disk-encryption-set update'] = """ +aladdin_helps['vmss list-instance-public-ips'] = """ type: command -short-summary: Update a disk encryption set. +short-summary: List public IP addresses of VM instances within a set. examples: - - name: Update a disk encryption set. (autogenerated) + - name: List public IP addresses of VM instances within a set. (autogenerated) text: | - az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault + az vmss list-instance-public-ips --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['image builder delete'] = """ +aladdin_helps['vmss reimage'] = """ type: command -short-summary: Delete image builder template. +short-summary: Reimage VMs within a VMSS. +parameters: + - name: --instance-id + short-summary: VM instance ID. If missing, reimage all instances. examples: - - name: Delete image builder template. (autogenerated) + - name: Reimage VMs within a VMSS. (autogenerated) text: | - az image builder delete --name MyImageTemplate --resource-group MyResourceGroup + az vmss reimage --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['image builder show'] = """ +aladdin_helps['vmss restart'] = """ type: command -short-summary: Show an image builder template. +short-summary: Restart VMs within a VMSS. examples: - - name: Show an image builder template (autogenerated) + - name: Restart VMs within a VMSS. (autogenerated) text: | - az image builder show --name mytemplate --resource-group my-group + az vmss restart --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ppg create'] = """ +aladdin_helps['vmss scale'] = """ type: command -short-summary: Create a proximity placement group +short-summary: Change the number of VMs within a VMSS. +parameters: + - name: --new-capacity + short-summary: Number of VMs in the VMSS. examples: - - name: Create a proximity placement group (autogenerated) + - name: Change the number of VMs within a VMSS. (autogenerated) text: | - az ppg create --name MyProximityPlacementGroup --resource-group MyResourceGroup + az vmss scale --name MyScaleSet --new-capacity 6 --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ppg list'] = """ +aladdin_helps['vmss show'] = """ type: command -short-summary: List proximity placement groups +short-summary: Get details on VMs within a VMSS. +parameters: + - name: --instance-id + short-summary: VM instance ID. If missing, show the VMSS. examples: - - name: List proximity placement groups (autogenerated) + - name: Get details on VMs within a VMSS. (autogenerated) text: | - az ppg list --resource-group MyResourceGroup + az vmss show --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ppg show'] = """ +aladdin_helps['vmss start'] = """ type: command -short-summary: Get a proximity placement group +short-summary: Start VMs within a VMSS. examples: - - name: Get a proximity placement group (commonly used with --output). (autogenerated) + - name: Start VMs within a VMSS. (autogenerated) text: | - az ppg show --name MyProximityPlacementGroup --resource-group MyResourceGroup + az vmss start --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['sig image-version wait'] = """ +aladdin_helps['vmss stop'] = """ type: command -short-summary: wait for image version related operation +short-summary: Power off (stop) VMs within a VMSS. +long-summary: The VMs will continue to be billed. To avoid this, you can deallocate VM instances within a VMSS through "az vmss deallocate" examples: - - name: wait for image version related operation. (autogenerated) + - name: Power off (stop) VMs within a VMSS. (autogenerated) text: | - az sig image-version wait --created --resource-group MyResourceGroup \\ - --gallery-name MyGallery --gallery-image-definition MyImage \\ - --gallery-image-version 1.0.0 + az vmss stop --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['snapshot grant-access'] = """ +aladdin_helps['vmss update-instances'] = """ type: command -short-summary: Grant read access to a snapshot. +short-summary: Upgrade VMs within a VMSS. examples: - - name: Grant read access to a snapshot. (autogenerated) + - name: Upgrade VMs within a VMSS. (autogenerated) text: | - az snapshot grant-access --duration-in-seconds 3600 --name MySnapshot --resource-group MyResourceGroup + az vmss update-instances --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['snapshot revoke-access'] = """ +aladdin_helps['vmss wait'] = """ type: command -short-summary: Revoke read access to a snapshot. +short-summary: Place the CLI in a waiting state until a condition of a scale set is met. examples: - - name: Revoke read access to a snapshot. (autogenerated) + - name: Place the CLI in a waiting state until a condition of a scale set is met. (autogenerated) text: | - az snapshot revoke-access --name MySnapshot --resource-group MyResourceGroup + az vmss wait --created --name MyScaleSet --resource-group MyResourceGroup crafted: true """ -aladdin_helps['snapshot update'] = """ +aladdin_helps['storage account encryption-scope create'] = """ type: command -short-summary: Update a snapshot. +short-summary: Create an encryption scope within storage account. examples: - - name: Update a snapshot. (autogenerated) + - name: Create an encryption scope within storage account. (autogenerated) text: | - az snapshot update --name MySnapshot --resource-group MyResourceGroup --subscription MySubscription + az storage account encryption-scope create --account-name mystorageaccount --key-source Microsoft.Storage --name myencryption --resource-group MyResourceGroup --subscription mysubscription crafted: true """ -aladdin_helps['snapshot wait'] = """ +aladdin_helps['storage account generate-sas'] = """ type: command -short-summary: Place the CLI in a waiting state until a condition of a snapshot is met. +short-summary: Generate a shared access signature for the storage account. +parameters: + - name: --services + short-summary: 'The storage services the SAS is applicable for. Allowed values: (b)lob (f)ile (q)ueue (t)able. Can be combined.' + - name: --resource-types + short-summary: 'The resource types the SAS is applicable for. Allowed values: (s)ervice (c)ontainer (o)bject. Can be combined.' + - name: --expiry + short-summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. + - name: --start + short-summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Defaults to the time of the request. + - name: --account-name + short-summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment Variable: AZURE_STORAGE_ACCOUNT' 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 - crafted: true - - name: Place the CLI in a waiting state until a condition of a snapshot is met. (autogenerated) + - name: Generate a shared access signature for the account (autogenerated) text: | - az snapshot wait --created --name MySnapshot --resource-group MyResourceGroup + 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 """ -aladdin_helps['vm boot-diagnostics enable'] = """ +aladdin_helps['storage account management-policy create'] = """ type: command -short-summary: Enable the boot diagnostics on a VM. -parameters: - - name: --storage - short-summary: Name or URI of a storage account (e.g. https://your_storage_account_name.blob.core.windows.net/). If it's not specified, managed storage will be used. +short-summary: Create the data policy rules associated with the specified storage account. examples: - - name: Enable the boot diagnostics on a VM. (autogenerated) + - name: Create the data policy rules associated with the specified storage account. (autogenerated) text: | - az vm boot-diagnostics enable --name MyVirtualMachine --resource-group MyResourceGroup --storage https://mystor.blob.core.windows.net/ + az storage account management-policy create --account-name myaccount --policy @policy.json --resource-group myresourcegroup crafted: true """ -aladdin_helps['vm boot-diagnostics get-boot-log'] = """ +aladdin_helps['storage account network-rule list'] = """ type: command -short-summary: Get the boot diagnostics log from a VM. +short-summary: List network rules. examples: - - name: Get the boot diagnostics log from a VM. (autogenerated) + - name: List network rules. (autogenerated) text: | - az vm boot-diagnostics get-boot-log --name MyVirtualMachine --resource-group MyResourceGroup + az storage account network-rule list --account-name MyAccount --resource-group MyResourceGroup crafted: true """ -aladdin_helps['vm deallocate'] = """ +aladdin_helps['storage account network-rule remove'] = """ type: command -short-summary: Deallocate a VM. -long-summary: 'For an end-to-end tutorial, see https://docs.microsoft.com/azure/virtual-machines/linux/capture-image' +short-summary: Remove a network rule. examples: - - name: Deallocate a VM. (autogenerated) + - name: Remove a network rule. (autogenerated) text: | - az vm deallocate --name MyVm --no-wait --resource-group MyResourceGroup + 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 crafted: true """ -aladdin_helps['vm disk attach'] = """ +aladdin_helps['storage account show-connection-string'] = """ type: command -short-summary: Attach a managed persistent disk to a VM. Please note that --ids only supports one disk. -long-summary: This allows for the preservation of data, even if the VM is reprovisioned due to maintenance or resizing. +short-summary: Get the connection string for a storage account. examples: - - name: Attach a managed persistent disk to a VM. (autogenerated) + - name: Get the connection string for a storage account. (autogenerated) text: | - az vm disk attach --disk $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm + az storage account show-connection-string --name MyStorageAccount --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['vm encryption disable'] = """ +aladdin_helps['storage account show-usage'] = """ type: command -short-summary: Disable disk encryption on the OS disk and/or data disks. Decrypt mounted disks. -long-summary: | - For Linux VMs, disabling encryption is only permitted on data volumes. - For Windows VMs, disabling encryption is permitted on both OS and data volumes. +short-summary: Show the current count and limit of the storage accounts under the subscription. examples: - - name: Disable disk encryption on the OS disk and/or data disks. (autogenerated) + - name: Show the current count and limit of the storage accounts under the subscription. (autogenerated) text: | - az vm encryption disable --name MyVirtualMachine --resource-group MyResourceGroup --volume-type DATA + az storage account show-usage --location westus2 crafted: true """ -aladdin_helps['vm encryption enable'] = """ +aladdin_helps['storage account update'] = """ type: command -short-summary: "Enable disk encryption on the OS disk and/or data disks. Encrypt mounted disks." -long-summary: | - Note that Azure Active Directory / service principal arguments are unnecessary for vm encryption. The older version of Azure Disk Encryption required AAD arguments. - For more information, see: - ttps://docs.microsoft.com/azure/security/fundamentals/azure-disk-encryption-vms-vmss -parameters: - - name: --aad-client-id - short-summary: Client ID of an AAD app with permissions to write secrets to the key vault. - - name: --aad-client-secret - short-summary: Client secret of the AAD app with permissions to write secrets to the key vault. - - name: --aad-client-cert-thumbprint - short-summary: Thumbprint of the AAD app certificate with permissions to write secrets to the key vault. +short-summary: Update the properties of a storage account. examples: - - name: Enable disk encryption on the OS disk and/or data disks. Encrypt mounted disks. (autogenerated) + - name: Update the properties of a storage account. (autogenerated) text: | - az vm encryption enable --disk-encryption-keyvault MyVault --name MyVm --resource-group MyResourceGroup --volume-type DATA + az storage account update --default-action Allow --name MyStorageAccount --resource-group MyResourceGroup crafted: true """ -aladdin_helps['vm encryption show'] = """ +aladdin_helps['storage blob copy start-batch'] = """ type: command -short-summary: Show encryption status. +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 + short-summary: The blob container where the selected source files or blobs will be copied to. + - name: --pattern + type: string + short-summary: The pattern used for globbing files or blobs in the source. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. + long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. + - name: --dryrun + type: bool + short-summary: List the files or blobs to be uploaded. No actual data transfer will occur. + - name: --source-account-name + type: string + short-summary: The source storage account from which the files or blobs are copied to the destination. If omitted, the destination account is used. + - name: --source-account-key + type: string + short-summary: The account key for the source storage account. + - name: --source-container + type: string + short-summary: The source container from which blobs are copied. + - name: --source-share + type: string + short-summary: The source share from which files are copied. + - name: --source-uri + type: string + short-summary: A URI specifying a file share or blob container from which the files or blobs are copied. + long-summary: If the source is in another account, the source must either be public or be authenticated by using a shared access signature. + - name: --source-sas + type: string + short-summary: The shared access signature for the source storage account. examples: - - name: Show encryption status. (autogenerated) + - name: Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs. (autogenerated) text: | - az vm encryption show --name MyVirtualMachine --resource-group MyResourceGroup + 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 """ -aladdin_helps['vm extension wait'] = """ +aladdin_helps['storage blob exists'] = """ type: command -short-summary: Place the CLI in a waiting state until a condition of a virtual machine extension is met. +short-summary: Check for the existence of a blob in a container. +parameters: + - name: --name -n + short-summary: The blob name. 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 - 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 - crafted: true - - name: Place the CLI in a waiting state until a condition of a virtual machine extension is met. (autogenerated) + - name: Check for the existence of a blob in a container. (autogenerated) text: | - az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm + az storage blob exists --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob crafted: true """ -aladdin_helps['vm host create'] = """ +aladdin_helps['storage blob generate-sas'] = """ type: command -short-summary: Create a dedicated host. +short-summary: Generate a shared access signature for the blob. examples: - - name: Create a dedicated host (autogenerated) + - name: Generate a shared access signature for the blob. (autogenerated) text: | - az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1 + 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 """ -aladdin_helps['vm host group create'] = """ +aladdin_helps['storage blob incremental-copy start'] = """ type: command -short-summary: Create a dedicated host group. +short-summary: Copies an incremental copy of a blob asynchronously. +long-summary: This operation returns a copy operation properties object, including a copy ID you can use to check or abort the copy operation. The Blob service copies blobs on a best-effort basis. The source blob for an incremental copy operation must be a page blob. Call get_blob_properties on the destination blob to check the status of the copy operation. The final blob will be committed when the copy completes. +parameters: + - name: --source-uri -u + short-summary: > + A URL of up to 2 KB in length that specifies an Azure page blob. + The value should be URL-encoded as it would appear in a request URI. + The copy source must be a snapshot and include a valid SAS token or be public. + Example: + `https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=&sastoken` examples: - - name: Create a dedicated host group. (autogenerated) + - name: Copies an incremental copy of a blob asynchronously. (autogenerated) text: | - az vm host group create --name MyDedicatedHostGroup --platform-fault-domain-count 2 --resource-group MyResourceGroup + az storage blob incremental-copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-blob MyBlob --source-container MySourceContainer --source-snapshot MySnapshot + crafted: true + - name: Copy an incremental copy of a blob asynchronously. (autogenerated) + text: | + az storage blob incremental-copy start --connection-string myconnectionstring --destination-blob mydestinationblob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos crafted: true """ -aladdin_helps['vm host group show'] = """ +aladdin_helps['storage blob service-properties delete-policy show'] = """ type: command -short-summary: Get the details of a dedicated host group. +short-summary: Show the storage blob delete-policy. examples: - - name: Get the details of a dedicated host group (autogenerated) + - name: Show the storage blob delete-policy. (autogenerated) + text: | + az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 + crafted: true + - name: Show the storage blob delete-policy. (autogenerated) text: | - az vm host group show --name MyDedicatedHostGroup --resource-group MyResourceGroup + az storage blob service-properties delete-policy show --account-name mystorageccount --auth-mode login crafted: true """ -aladdin_helps['vm host list'] = """ +aladdin_helps['storage blob service-properties delete-policy update'] = """ type: command -short-summary: List dedicated hosts. +short-summary: Update the storage blob delete-policy. examples: - - name: List dedicated hosts. (autogenerated) + - name: Update the storage blob delete-policy. (autogenerated) text: | - az vm host list --host-group my-host-group --resource-group my-rg + az storage blob service-properties delete-policy update --account-name mystorageccount --account-key 00000000 --days-retained 7 --enable true crafted: true """ -aladdin_helps['vm host show'] = """ +aladdin_helps['storage blob service-properties update'] = """ type: command -short-summary: Get the details of a dedicated host. +short-summary: Update storage blob service properties. examples: - - name: Get the details of a dedicated host (autogenerated) + - name: Update storage blob service properties. (autogenerated) text: | - az vm host show --host-group my-host-group --name MyDedicatedHost --resource-group MyResourceGroup + 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 """ -aladdin_helps['vm identity show'] = """ +aladdin_helps['storage blob set-tier'] = """ type: command -short-summary: display VM's managed identity info. +short-summary: Set the block or page tiers on the blob. +parameters: + - name: --type -t + short-summary: The blob type + - name: --tier + short-summary: The tier value to set the blob to. + - name: --timeout + short-summary: The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually. +long-summary: > + For block blob this command only supports block blob on standard storage accounts. + For page blob, this command only supports for page blobs on premium accounts. examples: - - name: display VM's managed identity info. (autogenerated) + - name: Set the block or page tiers on the blob. (autogenerated) text: | - az vm identity show --name MyVirtualMachine --resource-group MyResourceGroup + az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob --tier P10 crafted: true """ -aladdin_helps['vm image accept-terms'] = """ +aladdin_helps['storage blob show'] = """ type: command -short-summary: Accept Azure Marketplace term so that the image can be used to create VMs +short-summary: Get the details of a blob. examples: - - name: Accept Azure Marketplace term so that the image can be used to create VMs. (autogenerated) + - name: Get the details of a blob (autogenerated) text: | - az vm image accept-terms --urn publisher:offer:sku:version + az storage blob show --account-name mystorageccount --account-key 00000000 --container-name mycontainer --name MyBlob crafted: true """ -aladdin_helps['vm image show'] = """ +aladdin_helps['storage blob upload'] = """ type: command -short-summary: Get the details for a VM image available in the Azure Marketplace. +short-summary: Upload a file to a storage blob. +long-summary: Create a new blob from a file path, or updates the content of an existing blob with automatic chunking and progress notifications. +parameters: + - name: --type -t + short-summary: Default to 'page' for *.vhd files, or 'block' otherwise. + - name: --maxsize-condition + short-summary: The max length in bytes permitted for an append blob. + - name: --validate-content + short-summary: Specify that an MD5 hash shall be calculated for each chunk of the blob and verified by the service when the chunk has arrived. examples: - - name: Get the details for a VM image available in the Azure Marketplace. (autogenerated) + - name: Upload a file to a storage blob. (autogenerated) text: | - az vm image show --location westus --urn publisher:offer:sku:version + az storage blob upload --account-name mystorageaccount --account-key 0000-0000 --container-name mycontainer --file /path/to/file --name myblob crafted: true """ -aladdin_helps['vm image terms cancel'] = """ +aladdin_helps['storage blob url'] = """ type: command -short-summary: Cancel Azure Marketplace image terms. +short-summary: Create the url to access a blob. examples: - - name: Cancel Azure Marketplace image terms. (autogenerated) + - name: Create the url to access a blob (autogenerated) text: | - az vm image terms cancel --subscription MySubscription --urn publisher:offer:sku:version + 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 crafted: true """ -aladdin_helps['vm monitor metrics list-definitions'] = """ +aladdin_helps['storage container delete'] = """ type: command -short-summary: List the metric definitions for a VM. +short-summary: Mark the specified container for deletion. +long-summary: > + The container and any blobs contained within it are later deleted during garbage collection. examples: - - name: List the metric definitions for a VM. (autogenerated) + - name: Marks the specified container for deletion. (autogenerated) text: | - az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup + az storage container delete --account-key 00000000 --account-name MyAccount --name mycontainer crafted: true """ -aladdin_helps['vm nic set'] = """ +aladdin_helps['storage container exists'] = """ type: command -short-summary: Configure settings of a NIC attached to a VM. +short-summary: Check for the existence of a storage container. examples: - - name: Configure settings of a NIC attached to a VM. (autogenerated) + - name: Check for the existence of a storage container. (autogenerated) text: | - az vm nic set --nics nic_name1 nic_name2 --primary-nic nic_name2 --resource-group MyResourceGroup --vm-name MyVm + az storage container exists --account-name mystorageccount --account-key 00000000 --name mycontainer crafted: true """ -aladdin_helps['vm run-command show'] = """ +aladdin_helps['storage container generate-sas'] = """ type: command -parameters: - - name: --command-id - type: string - short-summary: The command id - populator-commands: - - az vm run-command list +short-summary: Generate a SAS token for a storage container. examples: - - name: vm run-command show (autogenerated) + - name: Generate a shared access signature for the container (autogenerated) text: | - az vm run-command show --command-id RunShellScript --location westus2 + az storage container generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2020-01-01 --name mycontainer --permissions dlrw + crafted: true + - name: Generate a SAS token for a storage container. (autogenerated) + text: | + az storage container generate-sas --account-name mystorageaccount --as-user --auth-mode login --expiry 2020-01-01 --name container1 --permissions dlrw crafted: true """ -aladdin_helps['vm secret add'] = """ +aladdin_helps['storage container legal-hold show'] = """ type: command -short-summary: Add a secret to a VM. -long-summary: 'To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows) instead of `az vm secret add`.' +short-summary: Get the legal hold properties of a container. examples: - - name: Add a secret to a VM. (autogenerated) + - name: Get the legal hold properties of a container. (autogenerated) text: | - az vm secret add --certificate {certificate} --keyvault {keyvault} --name MyVirtualMachine --resource-group MyResourceGroup + az storage container legal-hold show --account-name mystorageccount --container-name mycontainer crafted: true """ -aladdin_helps['vm secret list'] = """ +aladdin_helps['storage cors clear'] = """ type: command -short-summary: List secrets on a VM. +short-summary: Remove all CORS rules from a storage account. +parameters: + - name: --services + short-summary: > + The storage service(s) to remove rules from. Allowed options are: (b)lob, (f)ile, + (q)ueue, (t)able. Can be combined. examples: - - name: List secrets on a VM. (autogenerated) + - name: Remove all CORS rules from a storage account. (autogenerated) text: | - az vm secret list --name MyVirtualMachine --resource-group MyResourceGroup + az storage cors clear --account-name MyAccount --services bfqt crafted: true """ -aladdin_helps['vm start'] = """ +aladdin_helps['storage cors list'] = """ type: command -short-summary: Start a stopped VM. +short-summary: List all CORS rules for a storage account. +parameters: + - name: --services + 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: Start a stopped VM. (autogenerated) + - name: List all CORS rules for a storage account. (autogenerated) text: | - az vm start --name MyVm --no-wait --resource-group MyResourceGroup + az storage cors list --account-key 00000000 --account-name mystorageaccount crafted: true """ -aladdin_helps['vm unmanaged-disk attach'] = """ +aladdin_helps['storage directory exists'] = """ type: command -short-summary: Attach an unmanaged persistent disk to a VM. -long-summary: This allows for the preservation of data, even if the VM is reprovisioned due to maintenance or resizing. +short-summary: Check for the existence of a storage directory. examples: - - name: Attach an unmanaged persistent disk to a VM. (autogenerated) + - name: Check for the existence of a storage directory. (autogenerated) text: | - az vm unmanaged-disk attach --name MyDataDisk --new --resource-group MyResourceGroup --size-gb 50 --vm-name MyVm + az storage directory exists --account-key 00000000 --account-name MyAccount --name MyDirectory --share-name MyShare crafted: true """ -aladdin_helps['vmss deallocate'] = """ +aladdin_helps['storage directory list'] = """ type: command -short-summary: Deallocate VMs within a VMSS. +short-summary: List directories in a share. examples: - - name: Deallocate VMs within a VMSS. (autogenerated) + - name: List directories in a share. (autogenerated) text: | - az vmss deallocate --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + az storage directory list --account-key 00000000 --account-name MyAccount --share-name MyShare crafted: true """ -aladdin_helps['vmss delete-instances'] = """ +aladdin_helps['storage entity insert'] = """ type: command -short-summary: Delete VMs within a VMSS. +short-summary: Insert an entity into a table. +parameters: + - name: --table-name -t + type: string + short-summary: The name of the table to insert the entity into. + - name: --entity -e + type: list + short-summary: Space-separated list of key=value pairs. Must contain a PartitionKey and a RowKey. + long-summary: The PartitionKey and RowKey must be unique within the table, and may be up to 64Kb in size. If using an integer value as a key, convert it to a fixed-width string which can be canonically sorted. For example, convert the integer value 1 to the string value "0000001" to ensure proper sorting. + - name: --if-exists + type: string + short-summary: Behavior when an entity already exists for the specified PartitionKey and RowKey. examples: - - name: Delete VMs within a VMSS. (autogenerated) + - name: Insert an entity into a table. (autogenerated) text: | - az vmss delete-instances --instance-ids 0 --name MyScaleSet --resource-group MyResourceGroup + az storage entity insert --connection-string $connectionString --entity PartitionKey=AAA RowKey=BBB Content=ASDF2 --if-exists fail --table-name MyTable crafted: true """ -aladdin_helps['vmss diagnostics set'] = """ +aladdin_helps['storage entity query'] = """ type: command -short-summary: Enable diagnostics on a VMSS. +short-summary: List entities which satisfy a query. +parameters: + - name: --marker + type: list + short-summary: Space-separated list of key=value pairs. Must contain a nextpartitionkey and a nextrowkey. + 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: Enable diagnostics on a VMSS. (autogenerated) + - name: List entities which satisfy a query. (autogenerated) text: | - az vmss diagnostics set --protected-settings {protected-settings} --resource-group MyResourceGroup --settings '{"commandToExecute": "echo testing"}' --vmss-name MyVmss + az storage entity query --table-name MyTable crafted: true """ -aladdin_helps['vmss disk attach'] = """ +aladdin_helps['storage file delete-batch'] = """ type: command -short-summary: Attach managed data disks to a scale set or its instances. +short-summary: Delete files from an Azure Storage File Share. +parameters: + - name: --source -s + type: string + short-summary: The source of the file delete operation. The source can be the file share URL or the share name. + - name: --pattern + type: string + short-summary: The pattern used for file globbing. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. + long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. + - name: --dryrun + type: bool + short-summary: List the files and blobs to be deleted. No actual data deletion will occur. examples: - - name: Attach managed data disks to a scale set or its instances. (autogenerated) + - name: Delete files from an Azure Storage File Share. (autogenerated) text: | - az vmss disk attach --disk {disk} --instance-id 0 --resource-group MyResourceGroup + az storage file delete-batch --account-key 00000000 --account-name MyAccount --source /path/to/file crafted: true - - name: Attach managed data disks of a given size to a scale set or its instances. (autogenerated) + - name: Delete files from an Azure Storage File Share. (autogenerated) text: | - az vmss disk attach --vmss-name MyVmss --resource-group MyResourceGroup --size-gb 50 + az storage file delete-batch --account-key 00000000 --account-name MyAccount --pattern *.py --source /path/to/file crafted: true """ -aladdin_helps['vmss disk detach'] = """ +aladdin_helps['storage file download-batch'] = """ type: command -short-summary: Detach managed data disks from a scale set or its instances. +short-summary: Download files from an Azure Storage File Share to a local directory in a batch operation. +parameters: + - name: --source -s + type: string + short-summary: The source of the file download operation. The source can be the file share URL or the share name. + - name: --destination -d + type: string + short-summary: The local directory where the files are downloaded to. This directory must already exist. + - name: --pattern + type: string + short-summary: The pattern used for file globbing. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. + long-summary: When you use '*' in --pattern, it will match any character including the the directory separator '/'. + - name: --dryrun + type: bool + short-summary: List the files and blobs to be downloaded. No actual data transfer will occur. + - name: --max-connections + type: integer + short-summary: The maximum number of parallel connections to use. Default value is 1. + - name: --snapshot + type: string + short-summary: A string that represents the snapshot version, if applicable. + - name: --validate-content + type: bool + short-summary: If set, calculates an MD5 hash for each range of the file for validation. + long-summary: > + The storage service checks the hash of the content that has arrived is identical to the hash that was sent. + This is mostly valuable for detecting bitflips during transfer if using HTTP instead of HTTPS. This hash is not stored. examples: - - name: Detach managed data disks from a scale set or its instances. (autogenerated) + - name: Download files from an Azure Storage File Share to a local directory in a batch operation. (autogenerated) text: | - az vmss disk detach --instance-id 0 --lun {lun} --resource-group MyResourceGroup + az storage file download-batch --account-key 00000000 --account-name MyAccount --destination . --no-progress --source /path/to/file crafted: true """ -aladdin_helps['vmss encryption enable'] = """ +aladdin_helps['storage file exists'] = """ type: command -short-summary: "Encrypt a VMSS with managed disks." -long-summary: "For more information, see: For more information, see: ttps://docs.microsoft.com/azure/security/fundamentals/azure-disk-encryption-vms-vmss" +short-summary: Check for the existence of a file. examples: - - name: Encrypt a VMSS with managed disks. (autogenerated) + - name: Check for the existence of a file. (autogenerated) text: | - az vmss encryption enable --disk-encryption-keyvault MyVault --name MyVmss --resource-group MyResourceGroup --volume-type DATA + az storage file exists --account-key 00000000 --account-name MyAccount --path path/file.txt --share-name MyShare crafted: true -""" - -aladdin_helps['vmss encryption show'] = """ -type: command -short-summary: Show encryption status. -examples: - - name: Show encryption status. (autogenerated) + - name: Check for the existence of a file. (autogenerated) text: | - az vmss encryption show --name MyScaleSet --resource-group MyResourceGroup + az storage file exists --connection-string $connectionString --path path/file.txt --share-name MyShare crafted: true """ -aladdin_helps['vmss extension delete'] = """ +aladdin_helps['storage file generate-sas'] = """ type: command -short-summary: Delete an extension from a VMSS. +short-summary: Generate a shared access signature for the file. examples: - - name: Delete an extension from a VMSS. (autogenerated) + - name: Generate a shared access signature for the file. (autogenerated) text: | - az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss + az storage file generate-sas --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --path path/file.txt --permissions rcdw --share-name MyShare --start 2019-01-01T12:20Z + crafted: true + - name: Generate a shared access signature for the file. (autogenerated) + text: | + az storage file generate-sas --account-key 00000000 --account-name mystorageaccount --expiry 2037-12-31T23:59:00Z --https-only --path path/file.txt --permissions rcdw --share-name myshare crafted: true """ -aladdin_helps['vmss extension list'] = """ +aladdin_helps['storage file list'] = """ type: command -short-summary: List extensions associated with a VMSS. +short-summary: List files and directories in a share. +parameters: + - name: --exclude-dir + type: bool + short-summary: List only files in the given share. examples: - - name: List extensions associated with a VMSS. (autogenerated) + - name: List files and directories in a share. (autogenerated) text: | - az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss + az storage file list --share-name MyShare crafted: true """ -aladdin_helps['vmss extension show'] = """ +aladdin_helps['storage file upload'] = """ type: command -short-summary: Show details on a VMSS extension. +short-summary: Upload a file to a share that uses the SMB 3.0 protocol. +long-summary: Creates or updates an Azure file from a source path with automatic chunking and progress notifications. examples: - - name: Show details on a VMSS extension. (autogenerated) + - name: Upload a file to a share that uses the SMB 3.0 protocol. (autogenerated) text: | - az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss + az storage file upload --account-key 00000000 --account-name MyStorageAccount --path path/file.txt --share-name MyShare --source /path/to/file crafted: true """ -aladdin_helps['vmss get-instance-view'] = """ +aladdin_helps['storage file url'] = """ type: command -short-summary: View an instance of a VMSS. -parameters: - - name: --instance-id - short-summary: A VM instance ID or "*" to list instance view for all VMs in a scale set. +short-summary: Create the url to access a file. examples: - - name: View an instance of a VMSS. (autogenerated) + - name: Create the url to access a file. (autogenerated) text: | - az vmss get-instance-view --name MyScaleSet --resource-group MyResourceGroup + az storage file url --account-key 00000000 --account-name mystorageaccount --path path/file.txt --share-name myshare crafted: true """ -aladdin_helps['vmss identity assign'] = """ +aladdin_helps['storage fs create'] = """ type: command -short-summary: Enable managed service identity on a VMSS. -long-summary: This is required to authenticate and interact with other Azure services using bearer tokens. +short-summary: Create file system for Azure Data Lake Storage Gen2 account. examples: - - name: Enable managed service identity on a VMSS. (autogenerated) + - name: Create file system for Azure Data Lake Storage Gen2 account. (autogenerated) text: | - az vmss identity assign --identities readerId writerId --name MyVmss --resource-group MyResourceGroup + az storage fs create --account-name mystorageaccount --auth-mode login --name fsname crafted: true """ -aladdin_helps['vmss identity show'] = """ +aladdin_helps['storage fs directory delete'] = """ type: command -short-summary: display VM scaleset's managed identity info. +short-summary: Delete a directory in ADLS Gen2 file system. examples: - - name: display VM scaleset's managed identity info. (autogenerated) + - name: Delete a directory in ADLS Gen2 file system. (autogenerated) text: | - az vmss identity show --name MyVirtualMachine --resource-group MyResourceGroup + az storage fs directory delete --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --yes crafted: true """ -aladdin_helps['vmss list'] = """ +aladdin_helps['storage fs directory exists'] = """ type: command -short-summary: List VMSS. +short-summary: Check for the existence of a directory in ADLS Gen2 file system. examples: - - name: List VMSS (autogenerated) + - name: Check for the existence of a directory in ADLS Gen2 file system. (autogenerated) text: | - az vmss list --resource-group MyResourceGroup + az storage fs directory exists --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir crafted: true """ -aladdin_helps['vmss list-instance-connection-info'] = """ +aladdin_helps['storage fs directory move'] = """ type: command -short-summary: Get the IP address and port number used to connect to individual VM instances within a set. +short-summary: Move a directory in ADLS Gen2 file system. examples: - - name: Get the IP address and port number used to connect to individual VM instances within a set. (autogenerated) + - name: Move a directory in ADLS Gen2 file system. (autogenerated) text: | - az vmss list-instance-connection-info --name MyScaleSet --resource-group MyResourceGroup + az storage fs directory move --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --new-directory newfs/dir crafted: true """ -aladdin_helps['vmss list-instance-public-ips'] = """ +aladdin_helps['storage fs directory show'] = """ type: command -short-summary: List public IP addresses of VM instances within a set. +short-summary: Show properties of a directory in ADLS Gen2 file system. examples: - - name: List public IP addresses of VM instances within a set. (autogenerated) + - name: Show properties of a directory in ADLS Gen2 file system. (autogenerated) text: | - az vmss list-instance-public-ips --name MyScaleSet --resource-group MyResourceGroup + az storage fs directory show --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir crafted: true """ -aladdin_helps['vmss reimage'] = """ +aladdin_helps['storage fs file show'] = """ type: command -short-summary: Reimage VMs within a VMSS. -parameters: - - name: --instance-id - short-summary: VM instance ID. If missing, reimage all instances. +short-summary: Show properties of file in ADLS Gen2 file system. examples: - - name: Reimage VMs within a VMSS. (autogenerated) + - name: Show properties of file in ADLS Gen2 file system. (autogenerated) text: | - az vmss reimage --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription + az storage fs file show --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt crafted: true """ -aladdin_helps['vmss restart'] = """ +aladdin_helps['storage fs show'] = """ type: command -short-summary: Restart VMs within a VMSS. +short-summary: Show properties of file system in ADLS Gen2 account. examples: - - name: Restart VMs within a VMSS. (autogenerated) + - name: Show properties of file system in ADLS Gen2 account. (autogenerated) text: | - az vmss restart --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + az storage fs show --account-name myadlsaccount --auth-mode login --name myfilesystem crafted: true """ -aladdin_helps['vmss run-command show'] = """ +aladdin_helps['storage logging show'] = """ type: command +short-summary: Show logging settings for a storage account. parameters: - - name: --command-id - type: string - short-summary: The command id - populator-commands: - - az vmss run-command list + - name: --services + short-summary: 'The storage services from which to retrieve logging info: (b)lob (q)ueue (t)able. Can be combined.' examples: - - name: Gets specific run command for a subscription in a location. (autogenerated) + - name: Show logging settings for a storage account. (autogenerated) text: | - az vmss run-command show --command-id RunShellScript --location westus2 --subscription mysubscription + az storage logging show --account-name MyAccount --services qt crafted: true """ -aladdin_helps['vmss scale'] = """ +aladdin_helps['storage metrics show'] = """ type: command -short-summary: Change the number of VMs within a VMSS. +short-summary: Show metrics settings for a storage account. parameters: - - name: --new-capacity - short-summary: Number of VMs in the VMSS. + - name: --services + short-summary: 'The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.' + - name: --interval + short-summary: Filter the set of metrics to retrieve by time interval examples: - - name: Change the number of VMs within a VMSS. (autogenerated) + - name: Show metrics settings for a storage account. (autogenerated) text: | - az vmss scale --name MyScaleSet --new-capacity 6 --resource-group MyResourceGroup + az storage metrics show --account-key 00000000 --account-name MyAccount crafted: true """ -aladdin_helps['vmss show'] = """ +aladdin_helps['storage metrics update'] = """ type: command -short-summary: Get details on VMs within a VMSS. +short-summary: Update metrics settings for a storage account. parameters: - - name: --instance-id - short-summary: VM instance ID. If missing, show the VMSS. + - name: --services + short-summary: 'The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.' + - name: --hour + short-summary: Update the hourly metrics + - name: --minute + short-summary: Update the by-minute metrics + - name: --api + short-summary: Specify whether to include API in metrics. Applies to both hour and minute metrics if both are specified. Must be specified if hour or minute metrics are enabled and being updated. + - name: --retention + 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: Get details on VMs within a VMSS. (autogenerated) + - name: Update metrics settings for a storage account. (autogenerated) text: | - az vmss show --name MyScaleSet --resource-group MyResourceGroup + az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt + crafted: true + - name: Update metrics settings for a storage account by connection string. (autogenerated) + text: | + az storage metrics update --api true --connection-string $connectionString --hour true --minute true --retention 10 --services bfqt crafted: true """ -aladdin_helps['vmss start'] = """ +aladdin_helps['storage share create'] = """ type: command -short-summary: Start VMs within a VMSS. +short-summary: Creates a new share under the specified account. examples: - - name: Start VMs within a VMSS. (autogenerated) + - name: Creates a new share under the specified account. (autogenerated) text: | - az vmss start --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + az storage share create --account-name MyAccount --name MyFileShare crafted: true """ -aladdin_helps['vmss stop'] = """ +aladdin_helps['storage share exists'] = """ type: command -short-summary: Power off (stop) VMs within a VMSS. -long-summary: The VMs will continue to be billed. To avoid this, you can deallocate VM instances within a VMSS through "az vmss deallocate" +short-summary: Check for the existence of a file share. examples: - - name: Power off (stop) VMs within a VMSS. (autogenerated) + - name: Check for the existence of a file share. (autogenerated) text: | - az vmss stop --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + 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 """ -aladdin_helps['vmss update-instances'] = """ +aladdin_helps['storage share generate-sas'] = """ type: command -short-summary: Upgrade VMs within a VMSS. +short-summary: Generate a shared access signature for the share. examples: - - name: Upgrade VMs within a VMSS. (autogenerated) + - name: Generate a shared access signature for the share. (autogenerated) text: | - az vmss update-instances --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup + az storage share generate-sas --account-key 00000000 --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --name MyShare --permissions dlrw + crafted: true + - 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 """ -aladdin_helps['vmss wait'] = """ +aladdin_helps['storage share url'] = """ type: command -short-summary: Place the CLI in a waiting state until a condition of a scale set is met. +short-summary: Create a URI to access a file share. examples: - - name: Place the CLI in a waiting state until a condition of a scale set is met. (autogenerated) + - name: Create a URI to access a file share. (autogenerated) text: | - az vmss wait --created --name MyScaleSet --resource-group MyResourceGroup + az storage share url --account-key 00000000 --account-name MyAccount --name MyFileShare crafted: true """ + + + + + +