diff --git a/scripts/ci/aladdin/aladdin.py b/scripts/ci/aladdin/aladdin.py index 40a9b7b3801..638ffe7ab55 100644 --- a/scripts/ci/aladdin/aladdin.py +++ b/scripts/ci/aladdin/aladdin.py @@ -8,24 +8,6 @@ # pylint: disable=line-too-long, too-many-lines aladdin_helps = {} -aladdin_helps['acr agentpool show'] = """ -type: command -short-summary: Get the properties of a specified agent pool for an Azure Container Registry. -examples: - - name: Get the properties of a specified agent pool for an Azure Container Registry. (autogenerated) - text: az acr agentpool show --name MyAgentName --registry MyRegistry --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['acr config content-trust update'] = """ -type: command -short-summary: Update content-trust policy for an Azure Container Registry. -examples: - - name: Update content-trust policy for an Azure Container Registry. (autogenerated) - text: az acr config content-trust update --registry MyRegistry --resource-group myresourcegroup --status enabled - crafted: true -""" - aladdin_helps['acr credential renew'] = """ type: command short-summary: Regenerate login credentials for an Azure Container Registry. @@ -35,54 +17,6 @@ crafted: true """ -aladdin_helps['acr encryption show'] = """ -type: command -short-summary: Show the container registry's encryption details -long-summary: For more information, see http://aka.ms/acr/cmk -examples: - - name: Show the container registry's encryption details. (autogenerated) - text: az acr encryption show --name mycontainerregistry - crafted: true -""" - -aladdin_helps['acr identity show'] = """ -type: command -short-summary: Show the container registry's identity details -examples: - - name: Show the container registry's identity details. (autogenerated) - text: az acr identity show --name mycontainerregistry - crafted: true -""" - -aladdin_helps['acr private-endpoint-connection approve'] = """ -type: command -short-summary: Approve a private endpoint connection request for a container registry -long-summary: To create a private endpoint connection use "az network private-endpoint create". For more information see https://aka.ms/acr/private-link -examples: - - name: Approve a private endpoint connection request for a container registry. (autogenerated) - text: az acr private-endpoint-connection approve --name myprivateendpointconnection --registry-name myregistry - crafted: true -""" - -aladdin_helps['acr private-endpoint-connection list'] = """ -type: command -short-summary: List all private endpoint connections to a container registry -long-summary: To create a private endpoint connection use "az network private-endpoint create". For more information see https://aka.ms/acr/private-link -examples: - - name: List all private endpoint connections to a container registry. (autogenerated) - text: az acr private-endpoint-connection list --registry-name myregistry - crafted: true -""" - -aladdin_helps['acr private-link-resource list'] = """ -type: command -short-summary: list the private link resources supported for a registry -examples: - - name: list the private link resources supported for a registry. (autogenerated) - text: az acr private-link-resource list --name mycontainerregistry - crafted: true -""" - aladdin_helps['acr replication create'] = """ type: command short-summary: Create a replicated region for an Azure Container Registry. @@ -110,24 +44,6 @@ crafted: true """ -aladdin_helps['acr show-endpoints'] = """ -type: command -short-summary: Display registry endpoints -examples: - - name: Display registry endpoints. (autogenerated) - text: az acr show-endpoints --name mycontainerregistry - crafted: true -""" - -aladdin_helps['acr task credential update'] = """ -type: command -short-summary: Update the registry login credential for a task. -examples: - - name: Update the registry login credential for a task. (autogenerated) - text: az acr task credential update --login-server myregistry.docker.io --name taskname --password mysecret --registry registryname --use-identity 00000000-0000-0000-0000-00000000000000000 --username myusername2 - crafted: true -""" - aladdin_helps['acr task update'] = """ type: command short-summary: Update a task for an Azure Container Registry. @@ -139,15 +55,6 @@ crafted: true """ -aladdin_helps['acr token update'] = """ -type: command -short-summary: Update a token (replace associated scope map) for an Azure Container Registry. -examples: - - name: Update a token (replace associated scope map) for an Azure Container Registry. (autogenerated) - text: az acr token update --name MyToken --registry MyRegistry --scope-map MyNewScopeMap --subscription mysubscription - crafted: true -""" - aladdin_helps['acs browse'] = """ type: command short-summary: Show the dashboard for a service container's orchestrator in a web browser. @@ -221,6 +128,18 @@ crafted: true """ +aladdin_helps['aks check-acr'] = """ +type: command +short-summary: Validate an ACR is accessible from an AKS cluster. +parameters: + - name: --acr + short-summary: The FQDN of the ACR. +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 + crafted: true +""" + aladdin_helps['aks delete'] = """ type: command short-summary: Delete a managed Kubernetes cluster. @@ -248,10 +167,16 @@ short-summary: Enable Kubernetes addons. long-summary: |- 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". - If monitoring addon is enabled --no-wait argument will have no effect - virtual-node - enable AKS Virtual Node (PREVIEW). Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. + - 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. + 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 @@ -259,19 +184,54 @@ - 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: --appgw-name + type: string + short-summary: Name of the application gateway to create/use in the node resource group. Use with ingress-azure addon. + - name: --appgw-subnet-cidr + type: string + short-summary: Subnet CIDR to use for a new subnet created to deploy the Application Gateway. Use with ingress-azure addon. + - name: --appgw-id + type: string + short-summary: Resource Id of an existing Application Gateway to use with AGIC. Use with ingress-azure addon. + - name: --appgw-subnet-id + type: string + short-summary: Resource Id of an existing Subnet used to deploy the Application Gateway. Use with ingress-azure addon. + - name: --appgw-watch-namespace + type: string + short-summary: Specify the namespace, which AGIC should watch. This could be a single string value, or a comma-separated list of namespaces. + - 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 + 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 + crafted: true + - name: Enable open-service-mesh addon. + text: az aks enable-addons --name MyManagedCluster --resource-group MyResourceGroup --addons open-service-mesh crafted: true """ aladdin_helps['aks get-credentials'] = """ type: command short-summary: Get access credentials for a managed Kubernetes cluster. +long-summary: By default, the credentials are merged into the .kube/config file so kubectl can use them. See -f parameter for details. parameters: - name: --admin -a type: bool short-summary: "Get cluster administrator credentials. Default: cluster user credentials." + long-summary: "On clusters with Azure Active Directory integration, this bypasses normal Azure AD authentication and can be used if you're permanently blocked by not having access to a valid Azure AD group with access to your cluster. Requires 'Azure Kubernetes Service Cluster Admin' role." - name: --file -f type: string short-summary: Kubernetes configuration file to update. Use "-" to print YAML to stdout instead. @@ -281,6 +241,12 @@ - name: --output -o type: string long-summary: Credentials are always in YAML format, so this argument is effectively ignored. + - 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 @@ -305,86 +271,17 @@ crafted: true """ -aladdin_helps['aks nodepool delete'] = """ -type: command -short-summary: Delete the agent pool in the managed Kubernetes cluster. -examples: - - name: Delete the agent pool in the managed Kubernetes cluster. (autogenerated) - text: az aks nodepool delete --cluster-name mycluster --name mynodepool --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['aks nodepool list'] = """ -type: command -short-summary: List node pools in the managed Kubernetes cluster. -examples: - - name: List node pools in the managed Kubernetes cluster. (autogenerated) - text: az aks nodepool list --cluster-name mycluster --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['aks nodepool scale'] = """ -type: command -short-summary: Scale the node pool in a managed Kubernetes cluster. -parameters: - - name: --node-count -c - type: int - short-summary: Number of nodes in the Kubernetes node pool. -examples: - - name: Scale the node pool in a managed Kubernetes cluster. (autogenerated) - text: az aks nodepool scale --cluster-name mycluster --name mynodepool --node-count 7 --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['aks nodepool show'] = """ -type: command -short-summary: Show the details for a node pool in the managed Kubernetes cluster. -examples: - - name: Show the details for a node pool in the managed Kubernetes cluster. (autogenerated) - text: az aks nodepool show --cluster-name mycluster --name mynodepool --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['aks nodepool upgrade'] = """ +aladdin_helps['aks nodepool get-upgrades'] = """ type: command -short-summary: Upgrade the node pool in a managed Kubernetes cluster. -parameters: - - name: --kubernetes-version -k - type: string - short-summary: Version of Kubernetes to upgrade the node pool to, such as "1.11.12". +short-summary: Get the available upgrade versions for an agent pool of the managed Kubernetes cluster. examples: - - name: Upgrade the node pool in a managed Kubernetes cluster. (autogenerated) - text: az aks nodepool upgrade --cluster-name mycluster --kubernetes-version 1.16.9 --name mynodepool --resource-group myresourcegroup + - 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 -""" - -aladdin_helps['aks remove-connector'] = """ -type: command -short-summary: Remove the ACI Connector from a managed Kubernetes cluster. parameters: - - name: --connector-name - type: string - short-summary: Name of the ACI Connector. - - name: --graceful - type: bool - short-summary: Use a "cordon and drain" strategy to evict pods safely before removing the ACI node. - - name: --os-type + - name: --nodepool-name type: string - short-summary: Remove support for deploying ACIs of this operating system type. -examples: - - name: Remove the ACI Connector from a managed Kubernetes cluster. (autogenerated) - text: az aks remove-connector --connector-name MyConnector --name MyManagedCluster --os-type Windows --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['aks rotate-certs'] = """ -type: command -short-summary: Rotate certificates and keys on a managed Kubernetes cluster -long-summary: Kubernetes will be unavailable during cluster certificate rotation. -examples: - - name: Rotate certificates and keys on a managed Kubernetes cluster. (autogenerated) - text: az aks rotate-certs --name mymanagedcluster --resource-group myresourcegroup - crafted: true + short-summary: name of the node pool. """ aladdin_helps['aks scale'] = """ @@ -416,12 +313,15 @@ parameters: - name: --kubernetes-version -k type: string - short-summary: Version of Kubernetes to upgrade the cluster to, such as "1.11.8" or "1.12.6". + short-summary: Version of Kubernetes to upgrade the cluster to, such as "1.16.9". populator-commands: - "`az aks get-upgrades`" - name: --control-plane-only type: bool short-summary: Upgrade the cluster control plane only. If not specified, both control plane AND all node pools will be upgraded. + - name: --node-image-only + type: bool + short-summary: Only upgrade node image for agent pools. examples: - name: Upgrade a managed Kubernetes cluster to a newer version. (autogenerated) text: az aks upgrade --kubernetes-version 1.12.6 --name MyManagedCluster --resource-group MyResourceGroup @@ -440,47 +340,38 @@ aladdin_helps['openshift delete'] = """ type: command -short-summary: Delete a managed OpenShift cluster. +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 a managed OpenShift cluster. (autogenerated) + - 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 a managed OpenShift cluster. +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 a managed OpenShift cluster. (autogenerated) + - 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 a managed OpenShift cluster. +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 a managed OpenShift cluster. (autogenerated) + - 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['openshift update'] = """ -type: command -short-summary: Commands to manage existing Openshift cluster. -parameters: - - name: --refresh-cluster - type: boolean -examples: - - name: Trigger nodes rotation. - text: az openshift update -g MyResourceGroup -n MyManagedCluster --refresh-cluster - crafted: true -""" - aladdin_helps['advisor configuration update'] = """ type: command short-summary: Update Azure Advisor configuration. @@ -499,965 +390,753 @@ crafted: true """ -aladdin_helps['ams account check-name'] = """ + + +aladdin_helps['apim api schema wait'] = """ type: command -short-summary: Checks whether the Media Service resource name is available. +short-summary: Place the CLI in a waiting state until a condition of an apim api schema is met. examples: - - name: Checks whether the Media Service resource name is available. (autogenerated) - text: az ams account check-name --location westus2 --name myazuremediaservicesaccount + - 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['ams account delete'] = """ +aladdin_helps['apim api wait'] = """ type: command -short-summary: Delete an Azure Media Services account. +short-summary: Place the CLI in a waiting state until a condition of an apim api is met. examples: - - name: Delete an Azure Media Services account. (autogenerated) - text: az ams account delete --name myazuremediaservicesaccount --resource-group myresourcegroup + - name: Place the CLI in a waiting state until a condition of a apim api is met. (autogenerated) + text: | + az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams account mru show'] = """ +aladdin_helps['apim product wait'] = """ type: command -short-summary: Show the details of media reserved units for an Azure Media Services account. +short-summary: Place the CLI in a waiting state until a condition of an apim product is met. examples: - - name: Show the details of media reserved units for an Azure Media Services account. (autogenerated) - text: az ams account mru show --name myazuremediaservicesaccount --resource-group myresourcegroup + - name: Place the CLI in a waiting state until a condition of a apim is met. (autogenerated) + text: | + az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID crafted: true """ -aladdin_helps['ams account show'] = """ +aladdin_helps['apim wait'] = """ type: command -short-summary: Show the details of an Azure Media Services account. +short-summary: Place the CLI in a waiting state until a condition of an apim is met. examples: - - name: Show the details of an Azure Media Services account. (autogenerated) - text: az ams account show --name myazuremediaservicesaccount + - name: Place the CLI in a waiting state until a condition of a apim is met. (autogenerated) + text: | + az apim wait --created --name MyApim --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams account sp reset-credentials'] = """ + + +aladdin_helps['appservice list-locations'] = """ type: command -short-summary: Generate a new client secret for a service principal configured for an Azure Media Services account. +short-summary: List regions where a plan sku is available. examples: - - name: Generate a new client secret for a service principal configured for an Azure Media Services account. (autogenerated) - text: az ams account sp reset-credentials --account-name myaccount --resource-group myresourcegroup + - name: List regions where a plan sku is available. (autogenerated) + text: az appservice list-locations --sku F1 crafted: true """ -aladdin_helps['ams asset create'] = """ +aladdin_helps['appservice plan delete'] = """ type: command -short-summary: Create an asset. +short-summary: Delete an app service plan. examples: - - name: Create an asset. (autogenerated) - text: az ams asset create --account-name myaccount --name myasset --resource-group myresourcegroup + - name: Delete an app service plan. (autogenerated) + text: az appservice plan delete --name MyAppServicePlan --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams asset delete'] = """ +aladdin_helps['appservice plan show'] = """ type: command -short-summary: Delete an asset. +short-summary: Get the app service plans for a resource group or a set of resource groups. examples: - - name: Delete an asset. (autogenerated) - text: az ams asset delete --account-name myaccount --name myasset --resource-group myresourcegroup + - 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 crafted: true """ -aladdin_helps['ams asset get-sas-urls'] = """ +aladdin_helps['appservice plan update'] = """ type: command -short-summary: Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys. +short-summary: Update an app service plan. +long-summary: See https:///go.microsoft.com/fwlink/?linkid=2133856 to learn more. examples: - - name: Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content (autogenerated) - text: az ams asset get-sas-urls --account-name myaccount --name myasset --permissions Read --resource-group myresourcegroup + - name: Update an app service plan. (autogenerated) + text: az appservice plan update --name MyAppServicePlan --resource-group MyResourceGroup --sku F1 crafted: true """ -aladdin_helps['ams asset list-streaming-locators'] = """ +aladdin_helps['functionapp config appsettings delete'] = """ type: command -short-summary: List streaming locators which are associated with this asset. +short-summary: Delete a function app's settings. examples: - - name: List streaming locators which are associated with this asset. (autogenerated) - text: az ams asset list-streaming-locators --account-name myaccount --name myasset + - name: Delete a function app's settings. (autogenerated) + text: az functionapp config appsettings delete --name MyFunctionApp --resource-group MyResourceGroup --setting-names {setting-names} crafted: true """ -aladdin_helps['ams asset show'] = """ +aladdin_helps['functionapp config appsettings list'] = """ type: command -short-summary: Show the details of an asset. +short-summary: Show settings for a function app. examples: - - name: Show the details of an asset. (autogenerated) - text: az ams asset show --account-name myaccount --name myasset --resource-group myresourcegroup + - name: Show settings for a function app. (autogenerated) + text: az functionapp config appsettings list --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams asset update'] = """ +aladdin_helps['functionapp config container set'] = """ type: command -short-summary: Update the details of an asset. +short-summary: Set an existing function app's container settings. examples: - - name: Update the details of an asset. (autogenerated) - text: az ams asset update --account-name myaccount --name myasset --resource-group myresourcegroup + - name: Set a function app container's settings. (autogenerated) + text: az functionapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams asset-filter create'] = """ +aladdin_helps['functionapp config container show'] = """ type: command -short-summary: Create an asset filter. +short-summary: Get details of a function app's container settings. examples: - - name: Create an asset filter. (autogenerated) - text: az ams asset-filter create --account-name amsAccount --asset-name assetName --end-timestamp 200000 --force-end-timestamp true --name filterName --resource-group resourceGroup --start-timestamp 100000 --timescale 1000 + - name: Get details of a function app container's settings. (autogenerated) + text: az functionapp config container show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams content-key-policy delete'] = """ +aladdin_helps['functionapp config hostname add'] = """ type: command -short-summary: Delete a content key policy. +short-summary: Bind a hostname to a function app. examples: - - name: Delete a content key policy. (autogenerated) - text: az ams content-key-policy delete --account-name myaccount --name mycontentkeypolicy --resource-group myresourcegroup + - name: Bind a hostname to a function app. (autogenerated) + text: az functionapp config hostname add --hostname www.yourdomain.com --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams content-key-policy list'] = """ +aladdin_helps['functionapp config hostname get-external-ip'] = """ type: command -short-summary: List all the content key policies within an Azure Media Services account. +short-summary: Get the external-facing IP address for a function app. examples: - - name: List all the content key policies within an Azure Media Services account. (autogenerated) - text: az ams content-key-policy list --account-name myaccount --resource-group myresourcegroup + - name: Get the external-facing IP address for a function app. (autogenerated) + text: az functionapp config hostname get-external-ip --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams content-key-policy show'] = """ +aladdin_helps['functionapp config hostname list'] = """ type: command -short-summary: Show an existing content key policy. +short-summary: List all hostname bindings for a function app. examples: - - name: Show an existing content key policy. (autogenerated) - text: az ams content-key-policy show --account-name myaccount --name mycontentkeypolicy --resource-group myresourcegroup + - name: List all hostname bindings for a function app. (autogenerated) + text: az functionapp config hostname list --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['ams job delete'] = """ +aladdin_helps['functionapp config set'] = """ type: command -short-summary: Delete a job. +short-summary: Set an existing function app's configuration. examples: - - name: Delete a job. (autogenerated) - text: az ams job delete --account-name myaccount --name myjob --resource-group myresourcegroup --transform-name mytransform + - name: Set the function app's configuration. (autogenerated) + text: az functionapp config set --always-on true --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams job show'] = """ +aladdin_helps['functionapp config show'] = """ type: command -short-summary: Show the details of a job. +short-summary: Get the details of an existing function app's configuration. examples: - - name: Show the details of a job. (autogenerated) - text: az ams job show --account-name myaccount --name myjob --resource-group myresourcegroup --transform-name mytransform + - name: Get the details of a web app's configuration. (autogenerated) + text: az functionapp config show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams live-event create'] = """ +aladdin_helps['functionapp config ssl bind'] = """ type: command -short-summary: Create a live event. +short-summary: Bind an SSL certificate to a function app. examples: - - name: Create a live event. (autogenerated) - text: az ams live-event create --account-name myaccount --ips 1.2.3.4/22 5.6.7.8/30 --name myliveevent --resource-group myresourcegroup --streaming-protocol FragmentedMP4 + - name: Bind an SSL certificate to a function app. (autogenerated) + text: az functionapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyFunctionApp --resource-group MyResourceGroup --ssl-type SNI crafted: true """ -aladdin_helps['ams live-event start'] = """ +aladdin_helps['functionapp config ssl list'] = """ type: command -short-summary: Start a live event. +short-summary: List SSL certificates for a function app. examples: - - name: Start a live event. (autogenerated) - text: az ams live-event start --account-name myaccount --name myliveevent --resource-group myresourcegroup + - name: List SSL certificates for a function app. (autogenerated) + text: az functionapp config ssl list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams live-event stop'] = """ +aladdin_helps['functionapp config ssl show'] = """ type: command -short-summary: Stop a live event. +short-summary: Show the details of an SSL certificate for a function app. examples: - - name: Stop a live event. (autogenerated) - text: az ams live-event stop --account-name myaccount --name myliveevent --resource-group myresourcegroup + - name: Show the details of an SSL certificate for a function app. (autogenerated) + text: az functionapp config ssl show --resource-group MyResourceGroup --certificate-name cname.mycustomdomain.com crafted: true """ -aladdin_helps['ams live-output delete'] = """ +aladdin_helps['functionapp config ssl upload'] = """ type: command -short-summary: Delete a live output. +short-summary: Upload an SSL certificate to a function app. examples: - - name: Delete a live output. (autogenerated) - text: az ams live-output delete --account-name myaccount --live-event-name myliveevent --name myliveoutput --resource-group myresourcegroup + - name: Upload an SSL certificate to a function app. (autogenerated) + text: az functionapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams live-output list'] = """ +aladdin_helps['functionapp cors show'] = """ type: command -short-summary: List all the live outputs in a live event. +short-summary: show allowed origins examples: - - name: List all the live outputs in a live event. (autogenerated) - text: az ams live-output list --account-name myaccount --live-event-name myliveevent --resource-group myresourcegroup + - name: show allowed origins (autogenerated) + text: az functionapp cors show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-endpoint delete'] = """ +aladdin_helps['functionapp create'] = """ type: command -short-summary: Delete a streaming endpoint. +short-summary: Create a function app. +long-summary: The function app's name must be able to produce a unique FQDN as AppName.azurewebsites.net. examples: - - name: Delete a streaming endpoint. (autogenerated) - text: az ams streaming-endpoint delete --account-name myaccount --name mystreamingendpoint --resource-group myresourcegroup + - name: Create a function app. (autogenerated) + text: az functionapp create --consumption-plan-location westus --name MyUniqueAppName --os-type Windows --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount crafted: true """ -aladdin_helps['ams streaming-endpoint list'] = """ +aladdin_helps['functionapp delete'] = """ type: command -short-summary: List all the streaming endpoints within an Azure Media Services account. +short-summary: Delete a function app. examples: - - name: List all the streaming endpoints within an Azure Media Services account. (autogenerated) - text: az ams streaming-endpoint list --account-name myaccount --resource-group myresourcegroup + - name: Delete a function app. (autogenerated) + text: az functionapp delete --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-endpoint show'] = """ +aladdin_helps['functionapp deployment container config'] = """ type: command -short-summary: Show the details of a streaming endpoint. +short-summary: Configure continuous deployment via containers. examples: - - name: Show the details of a streaming endpoint. (autogenerated) - text: az ams streaming-endpoint show --account-name myaccount --name mystreamingendpoint --resource-group myresourcegroup + - name: Configure continuous deployment via containers (autogenerated) + text: az functionapp deployment container config --enable-cd true --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-endpoint start'] = """ +aladdin_helps['functionapp deployment container show-cd-url'] = """ type: command -short-summary: Start a streaming endpoint. +short-summary: Get the URL which can be used to configure webhooks for continuous deployment. examples: - - name: Start a streaming endpoint. (autogenerated) - text: az ams streaming-endpoint start --account-name myaccount --name mystreamingendpoint --no-wait --resource-group myresourcegroup + - name: Get the URL which can be used to configure webhooks for continuous deployment. (autogenerated) + text: az functionapp deployment container show-cd-url --ids {ids} + crafted: true + - name: Get the URL which can be used to configure webhooks for continuous deployment. (autogenerated) + text: az functionapp deployment container show-cd-url --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-endpoint stop'] = """ +aladdin_helps['functionapp deployment list-publishing-credentials'] = """ type: command -short-summary: Stop a streaming endpoint. +short-summary: Get the details for available function app publishing credentials. examples: - - name: Stop a streaming endpoint. (autogenerated) - text: az ams streaming-endpoint stop --account-name myaccount --name mystreamingendpoint --resource-group myresourcegroup + - name: Get the details for available function app deployment publishing credentials. + text: az functionapp deployment list-publishing-credentials --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-locator create'] = """ +aladdin_helps['functionapp deployment list-publishing-profiles'] = """ type: command -short-summary: Create a streaming locator. +short-summary: Get the details for available function app deployment profiles. examples: - - name: Create a streaming locator. (autogenerated) - text: az ams streaming-locator create --account-name myaccount --asset-name myasset --name mystreaminglocator --resource-group myresourcegroup --streaming-policy-name mystreamingpolicy + - name: Get the details for available function app deployment profiles. (autogenerated) + text: az functionapp deployment list-publishing-profiles --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-locator get-paths'] = """ +aladdin_helps['functionapp deployment slot create'] = """ type: command -short-summary: List paths supported by a streaming locator. +short-summary: Create a deployment slot. examples: - - name: List paths supported by a streaming locator. (autogenerated) - text: az ams streaming-locator get-paths --account-name myaccount --name mystreaminglocator --resource-group myresourcegroup + - name: Create a deployment slot. (autogenerated) + text: az functionapp deployment slot create --name MyFunctionapp --resource-group MyResourceGroup --slot staging crafted: true """ -aladdin_helps['ams streaming-locator list'] = """ +aladdin_helps['functionapp deployment slot delete'] = """ type: command -short-summary: List all the streaming locators within an Azure Media Services account. +short-summary: Delete a deployment slot. examples: - - name: List all the streaming locators within an Azure Media Services account. (autogenerated) - text: az ams streaming-locator list --account-name myaccount --resource-group myresourcegroup + - name: Delete a deployment slot. (autogenerated) + text: az functionapp deployment slot delete --name MyFunctionapp --resource-group MyResourceGroup --slot staging crafted: true """ -aladdin_helps['ams streaming-locator list-content-keys'] = """ +aladdin_helps['functionapp deployment slot list'] = """ type: command -short-summary: List content keys used by a streaming locator. +short-summary: List all deployment slots. examples: - - name: List content keys used by a streaming locator. (autogenerated) - text: az ams streaming-locator list-content-keys --account-name myaccount --name mystreaminglocator --resource-group myresourcegroup + - name: List all deployment slots. (autogenerated) + text: az functionapp deployment slot list --name MyFunctionapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-locator show'] = """ +aladdin_helps['functionapp deployment source config'] = """ type: command -short-summary: Show the details of a streaming locator. +short-summary: Manage deployment from git or Mercurial repositories. examples: - - name: Show the details of a streaming locator. (autogenerated) - text: az ams streaming-locator show --account-name myaccount --name mystreaminglocator --resource-group myresourcegroup + - name: Manage deployment from git or Mercurial repositories. (autogenerated) + text: az functionapp deployment source config --branch master --manual-integration --name MyFunctionApp --repo-url https://github.com/Azure-Samples/function-image-upload-resize --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams streaming-policy list'] = """ +aladdin_helps['functionapp deployment source delete'] = """ type: command -short-summary: List all the streaming policies within an Azure Media Services account. +short-summary: Delete a source control deployment configuration. examples: - - name: List all the streaming policies within an Azure Media Services account. (autogenerated) - text: az ams streaming-policy list --account-name myaccount --resource-group myresourcegroup + - name: Delete a source control deployment configuration. (autogenerated) + text: az functionapp deployment source delete --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams transform delete'] = """ +aladdin_helps['functionapp deployment source show'] = """ type: command -short-summary: Delete a transform. +short-summary: Get the details of a source control deployment configuration. examples: - - name: Delete a transform. (autogenerated) - text: az ams transform delete --account-name myaccount --name mytransform --resource-group myresourcegroup + - name: Get the details of a source control deployment configuration. (autogenerated) + text: az functionapp deployment source show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams transform list'] = """ +aladdin_helps['functionapp deployment source sync'] = """ type: command -short-summary: List all the transforms of an Azure Media Services account. +short-summary: Synchronize from the repository. Only needed under manual integration mode. examples: - - name: List all the transforms of an Azure Media Services account. (autogenerated) - text: az ams transform list --account-name myaccount --resource-group myresourcegroup + - name: Synchronize from the repository. Only needed under manual integration mode. (autogenerated) + text: az functionapp deployment source sync --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['ams transform show'] = """ +aladdin_helps['functionapp function delete'] = """ type: command -short-summary: Show the details of a transform. +short-summary: Delete a function. examples: - - name: Show the details of a transform. (autogenerated) - text: az ams transform show --account-name myaccount --name mytransform --resource-group myresourcegroup + - name: Delete a function. + text: > + az functionapp function delete -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName crafted: true """ -aladdin_helps['apim show'] = """ +aladdin_helps['functionapp function keys delete'] = """ type: command -short-summary: Show details of an API Management service instance. +short-summary: Delete a function key. examples: - - name: Show details of an API Management service instance. (autogenerated) - text: az apim show --name myapimanagementserviceinstance --resource-group myresourcegroup + - name: Delete a function key. + text: > + az functionapp function keys delete -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName --key-name MyKeyName crafted: true """ -aladdin_helps['apim update'] = """ +aladdin_helps['functionapp function keys list'] = """ type: command -short-summary: Update an API Management service instance. +short-summary: List all function keys. examples: - - name: Update an API Management service instance. (autogenerated) - text: az apim update --enable-managed-identity true --name myapimanagementserviceinstance --resource-group myresourcegroup + - name: List all function keys. + text: > + az functionapp function keys list -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName crafted: true """ -aladdin_helps['appconfig kv restore'] = """ +aladdin_helps['functionapp function keys set'] = """ type: command -short-summary: Restore key-values. +short-summary: Create or update a function key. examples: - - name: Restore key-values. (autogenerated) - text: | - az appconfig kv restore --datetime "2019-05-01T11:24:12Z" --label v1.* --name MyAppConfiguration + - name: Create a function key. + text: > + az functionapp function keys set -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName --key-name MyKeyName --key-value MyKeyValue crafted: true """ -aladdin_helps['appservice list-locations'] = """ +aladdin_helps['functionapp function show'] = """ type: command -short-summary: List regions where a plan sku is available. +short-summary: Get the details of a function. examples: - - name: List regions where a plan sku is available. (autogenerated) - text: az appservice list-locations --sku F1 + - name: Show function details. + text: > + az functionapp function show -g MyResourceGroup -n MyFunctionAppName --function-name MyFunctionName crafted: true """ -aladdin_helps['appservice plan delete'] = """ +aladdin_helps['functionapp identity remove'] = """ type: command -short-summary: Delete an app service plan. +short-summary: Disable web app's managed identity examples: - - name: Delete an app service plan. (autogenerated) - text: az appservice plan delete --name MyAppServicePlan --resource-group MyResourceGroup + - name: Disable web app's system managed identity + text: az functionapp identity remove --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['appservice plan show'] = """ +aladdin_helps['functionapp identity show'] = """ type: command -short-summary: Get the app service plans for a resource group or a set of resource groups. +short-summary: display web app's managed identity 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 + - name: display functionapp's managed identity (autogenerated) + text: az functionapp identity show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['appservice plan update'] = """ +aladdin_helps['functionapp keys delete'] = """ type: command -short-summary: Update an app service plan. See https://docs.microsoft.com/azure/app-service/app-service-plan-manage#move-an-app-to-another-app-service-plan to learn more +short-summary: Delete a function app key. examples: - - name: Update an app service plan. (autogenerated) - text: az appservice plan update --name MyAppServicePlan --resource-group MyResourceGroup --sku F1 + - name: Delete a master key for an Azure Function app. + text: > + az functionapp keys delete -g MyResourceGroup -n MyFunctionAppName --key-type masterKey --key-name MyKeyName crafted: true """ -aladdin_helps['functionapp config appsettings delete'] = """ +aladdin_helps['functionapp keys list'] = """ type: command -short-summary: Delete a function app's settings. +short-summary: List all function app keys. examples: - - name: Delete a function app's settings. (autogenerated) - text: az functionapp config appsettings delete --name MyFunctionApp --resource-group MyResourceGroup --setting-names {setting-names} + - name: List all keys for an Azure Function app. + text: > + az functionapp keys list -g MyResourceGroup -n MyFunctionAppName crafted: true """ -aladdin_helps['functionapp config appsettings list'] = """ +aladdin_helps['functionapp keys set'] = """ type: command -short-summary: Show settings for a function app. +short-summary: Create or update a function app key. examples: - - name: Show settings for a function app. (autogenerated) - text: az functionapp config appsettings list --name MyWebapp --resource-group MyResourceGroup + - name: Create a function key for an Azure Function app. + text: > + az functionapp keys set -g MyResourceGroup -n MyFunctionAppName --key-type functionKeys --key-name MyKeyName --key-value MyKeyValue crafted: true """ -aladdin_helps['functionapp config container delete'] = """ +aladdin_helps['functionapp plan create'] = """ type: command -short-summary: Delete a function app container's settings. +short-summary: Create an App Service Plan for an Azure Function. examples: - - name: Delete a function app container's settings. (autogenerated) - text: az functionapp config container delete --name myfunctionapp --resource-group myresourcegroup + - name: Create an App Service Plan for an Azure Function. (autogenerated) + text: az functionapp plan create --location westus2 --name MyPlan --number-of-workers 1 --resource-group MyResourceGroup --sku B1 crafted: true """ -aladdin_helps['functionapp config container set'] = """ +aladdin_helps['functionapp plan show'] = """ type: command -short-summary: Set a function app container's settings. +short-summary: Get the App Service Plans for a resource group or a set of resource groups. examples: - - name: Set a function app container's settings. (autogenerated) - text: az functionapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyFunctionApp --resource-group MyResourceGroup + - name: Get the app service plans for a resource group or a set of resource groups. (autogenerated) + text: az functionapp plan show --name MyAppServicePlan --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config container show'] = """ +aladdin_helps['functionapp restart'] = """ type: command -short-summary: Get details of a function app container's settings. +short-summary: Restart a function app. examples: - - name: Get details of a function app container's settings. (autogenerated) - text: az functionapp config container show --name MyFunctionApp --resource-group MyResourceGroup + - name: Restart a function app. (autogenerated) + text: az functionapp restart --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config hostname add'] = """ +aladdin_helps['functionapp show'] = """ type: command -short-summary: Bind a hostname to a function app. +short-summary: Get the details of a function app. examples: - - name: Bind a hostname to a function app. (autogenerated) - text: az functionapp config hostname add --hostname www.yourdomain.com --name MyFunctionApp --resource-group MyResourceGroup + - name: Get the details of a function app. (autogenerated) + text: az functionapp show --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config hostname delete'] = """ +aladdin_helps['functionapp start'] = """ type: command -short-summary: Unbind a hostname from a function app. +short-summary: Start a function app. examples: - - name: Unbind a hostname from a function app. (autogenerated) - text: az functionapp config hostname delete --hostname www.yourdomain.com --name myfunctionapp --resource-group myresourcegroup + - name: Start a function app. (autogenerated) + text: az functionapp start --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config hostname get-external-ip'] = """ +aladdin_helps['functionapp stop'] = """ type: command -short-summary: Get the external-facing IP address for a function app. +short-summary: Stop a function app. examples: - - name: Get the external-facing IP address for a function app. (autogenerated) - text: az functionapp config hostname get-external-ip --name MyFunctionApp --resource-group MyResourceGroup + - name: Stop a function app. (autogenerated) + text: az functionapp stop --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config hostname list'] = """ +aladdin_helps['functionapp update'] = """ type: command -short-summary: List all hostname bindings for a function app. +short-summary: Update a function app. examples: - - name: List all hostname bindings for a function app. (autogenerated) - text: az functionapp config hostname list --resource-group MyResourceGroup --webapp-name MyWebapp + - name: Update a function app. (autogenerated) + text: az functionapp update --name MyFunctionApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config set'] = """ +aladdin_helps['logicapp restart'] = """ type: command -short-summary: Set the function app's configuration. +short-summary: Restart a logic app. examples: - - name: Set the function app's configuration. (autogenerated) - text: az functionapp config set --always-on true --name MyFunctionApp --resource-group MyResourceGroup + - name: Restart a logic app. + text: az logicapp restart --name MyLogicApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config show'] = """ +aladdin_helps['logicapp start'] = """ type: command -short-summary: Get the details of a function app's configuration. +short-summary: Start a logic app. examples: - - name: Get the details of a web app's configuration. (autogenerated) - text: az functionapp config show --name MyFunctionApp --resource-group MyResourceGroup + - name: Start a logic app + text: az logicapp start --name MyLogicApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config ssl bind'] = """ +aladdin_helps['logicapp stop'] = """ type: command -short-summary: Bind an SSL certificate to a function app. +short-summary: Stop a logic app. examples: - - name: Bind an SSL certificate to a function app. (autogenerated) - text: az functionapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyFunctionApp --resource-group MyResourceGroup --ssl-type SNI + - name: Stop a logic app. + text: az logicapp stop --name MyLogicApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config ssl list'] = """ +aladdin_helps['staticwebapp identity remove'] = """ type: command -short-summary: List SSL certificates for a function app. +short-summary: Disable static web app's managed identity examples: - - name: List SSL certificates for a function app. (autogenerated) - text: az functionapp config ssl list --resource-group MyResourceGroup + - name: Disable static web app's system managed identity + text: az staticwebapp identity remove --name MyApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp config ssl upload'] = """ +aladdin_helps['staticwebapp identity show'] = """ type: command -short-summary: Upload an SSL certificate to a function app. +short-summary: display static web app's managed identity examples: - - name: Upload an SSL certificate to a function app. (autogenerated) - text: az functionapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyFunctionApp --resource-group MyResourceGroup + - name: display static web app's managed identity (autogenerated) + text: az staticwebapp identity show --name MyApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp cors show'] = """ +aladdin_helps['webapp auth show'] = """ type: command -short-summary: show allowed origins +short-summary: Show the authentification settings for the webapp. examples: - - name: show allowed origins (autogenerated) - text: az functionapp cors show --name MyFunctionApp --resource-group MyResourceGroup + - name: Show the authentification settings for the webapp. (autogenerated) + text: az webapp auth show --name MyWebApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp create'] = """ +aladdin_helps['webapp browse'] = """ type: command -short-summary: Create a function app. -long-summary: The function app's name must be able to produce a unique FQDN as AppName.azurewebsites.net. +short-summary: Open a web app in a browser. examples: - - name: Create a function app. (autogenerated) - text: az functionapp create --consumption-plan-location westus --name MyUniqueAppName --os-type Windows --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount - crafted: true - - name: Create a function app. (autogenerated) - text: az functionapp create --consumption-plan-location westus --functions-version 2 --name MyUniqueAppName --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount + - name: Open a web app in a browser. (autogenerated) + text: az webapp browse --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp delete'] = """ +aladdin_helps['webapp config appsettings delete'] = """ type: command -short-summary: Delete a function app. +short-summary: Delete web app settings. examples: - - name: Delete a function app. (autogenerated) - text: az functionapp delete --name MyFunctionApp --resource-group MyResourceGroup + - name: Delete web app settings. (autogenerated) + text: az webapp config appsettings delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names} crafted: true """ -aladdin_helps['functionapp deployment container config'] = """ +aladdin_helps['webapp config appsettings list'] = """ type: command -short-summary: Configure continuous deployment via containers. +short-summary: Get the details of a web app's settings. examples: - - name: Configure continuous deployment via containers (autogenerated) - text: az functionapp deployment container config --enable-cd true --name MyFunctionApp --resource-group MyResourceGroup + - name: Get the details of a web app's settings. (autogenerated) + text: az webapp config appsettings list --name MyWebapp --resource-group MyResourceGroup --subscription MySubscription crafted: true """ -aladdin_helps['functionapp deployment container show-cd-url'] = """ +aladdin_helps['webapp config backup create'] = """ type: command -short-summary: Get the URL which can be used to configure webhooks for continuous deployment. +short-summary: Create a backup of a web app. examples: - - name: Get the URL which can be used to configure webhooks for continuous deployment. (autogenerated) - text: az functionapp deployment container show-cd-url --ids {ids} - crafted: true - - name: Get the URL which can be used to configure webhooks for continuous deployment. (autogenerated) - text: az functionapp deployment container show-cd-url --name MyFunctionApp --resource-group MyResourceGroup + - name: Create a backup of a web app. (autogenerated) + text: az webapp config backup create --container-url {container-url} --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp deployment list-publishing-credentials'] = """ +aladdin_helps['webapp config backup list'] = """ type: command -short-summary: Get the details for available function app publishing credentials. +short-summary: List backups of a web app. examples: - - name: Get the details for available function app deployment publishing credentials. - text: az functionapp deployment list-publishing-credentials --name MyFunctionApp --resource-group MyResourceGroup + - name: List backups of a web app. (autogenerated) + text: az webapp config backup list --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp deployment list-publishing-profiles'] = """ +aladdin_helps['webapp config backup show'] = """ type: command -short-summary: Get the details for available function app deployment profiles. +short-summary: Show the backup schedule for a web app. examples: - - name: Get the details for available function app deployment profiles. (autogenerated) - text: az functionapp deployment list-publishing-profiles --name MyFunctionApp --resource-group MyResourceGroup + - name: Show the backup schedule for a web app. (autogenerated) + text: az webapp config backup show --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp deployment slot auto-swap'] = """ +aladdin_helps['webapp config connection-string delete'] = """ type: command -short-summary: Configure deployment slot auto swap. +short-summary: Delete a web app's connection strings. examples: - - name: Configure deployment slot auto swap. (autogenerated) - text: az functionapp deployment slot auto-swap --name myfunctionapp --resource-group myresourcegroup --slot staging + - name: Delete a web app's connection strings. (autogenerated) + text: az webapp config connection-string delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names} crafted: true """ -aladdin_helps['functionapp deployment slot create'] = """ +aladdin_helps['webapp config connection-string list'] = """ type: command -short-summary: Create a deployment slot. +short-summary: Get a web app's connection strings. examples: - - name: Create a deployment slot. (autogenerated) - text: az functionapp deployment slot create --name MyFunctionapp --resource-group MyResourceGroup --slot staging + - name: Get a web app's connection strings. (autogenerated) + text: az webapp config connection-string list --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp deployment slot delete'] = """ +aladdin_helps['webapp config container delete'] = """ type: command -short-summary: Delete a deployment slot. +short-summary: Delete an existing web app's container settings. examples: - - name: Delete a deployment slot. (autogenerated) - text: az functionapp deployment slot delete --name MyFunctionapp --resource-group MyResourceGroup --slot staging + - name: Delete a web app container's settings. (autogenerated) + text: az webapp config container delete --name MyWebApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp deployment slot list'] = """ +aladdin_helps['webapp config container set'] = """ type: command -short-summary: List all deployment slots. +short-summary: Set an existing web app's container settings. examples: - - name: List all deployment slots. (autogenerated) - text: az functionapp deployment slot list --name MyFunctionapp --resource-group MyResourceGroup + - name: Set a web app container's settings. (autogenerated) + text: az webapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyWebApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp deployment source config'] = """ +aladdin_helps['webapp config container show'] = """ type: command -short-summary: Manage deployment from git or Mercurial repositories. +short-summary: Get details of a web app's container settings. examples: - - name: Manage deployment from git or Mercurial repositories. (autogenerated) - text: az functionapp deployment source config --branch master --manual-integration --name MyFunctionApp --repo-url https://github.com/Azure-Samples/function-image-upload-resize --resource-group MyResourceGroup + - name: Get details of a web app container's settings. (autogenerated) + text: az webapp config container show --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp deployment source delete'] = """ +aladdin_helps['webapp config hostname add'] = """ type: command -short-summary: Delete a source control deployment configuration. +short-summary: Bind a hostname to a web app. examples: - - name: Delete a source control deployment configuration. (autogenerated) - text: az functionapp deployment source delete --name MyFunctionApp --resource-group MyResourceGroup + - name: Bind a hostname to a web app. (autogenerated) + text: az webapp config hostname add --hostname cname.mycustomdomain.com --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp deployment source show'] = """ +aladdin_helps['webapp config hostname get-external-ip'] = """ type: command -short-summary: Get the details of a source control deployment configuration. +short-summary: Get the external-facing IP address for a web app. examples: - - name: Get the details of a source control deployment configuration. (autogenerated) - text: az functionapp deployment source show --name MyFunctionApp --resource-group MyResourceGroup + - name: Get the external-facing IP address for a web app. (autogenerated) + text: az webapp config hostname get-external-ip --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp deployment source sync'] = """ +aladdin_helps['webapp config hostname list'] = """ type: command -short-summary: Synchronize from the repository. Only needed under manual integration mode. +short-summary: List all hostname bindings for a web app. examples: - - name: Synchronize from the repository. Only needed under manual integration mode. (autogenerated) - text: az functionapp deployment source sync --name MyFunctionApp --resource-group MyResourceGroup + - name: List all hostname bindings for a web app. (autogenerated) + text: az webapp config hostname list --resource-group MyResourceGroup --webapp-name MyWebapp crafted: true """ -aladdin_helps['functionapp identity remove'] = """ +aladdin_helps['webapp config show'] = """ type: command -short-summary: Disable web app's managed service identity +short-summary: Get the details of a web app's configuration. examples: - - name: Disable web app's managed service identity (autogenerated) - text: az functionapp identity remove --name MyFunctionApp --resource-group MyResourceGroup + - name: Get the details of a web app's configuration. (autogenerated) + text: az webapp config show --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp identity show'] = """ +aladdin_helps['webapp config snapshot list'] = """ type: command -short-summary: display web app's managed service identity +short-summary: List the restorable snapshots for a web app. examples: - - name: display functionapp's managed service identity (autogenerated) - text: az functionapp identity show --name MyFunctionApp --resource-group MyResourceGroup + - name: List the restorable snapshots for a web app. (autogenerated) + text: az webapp config snapshot list --name MyWebApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp plan create'] = """ +aladdin_helps['webapp config ssl bind'] = """ type: command -short-summary: Create an App Service Plan for an Azure Function. +short-summary: Bind an SSL certificate to a web app. examples: - - name: Create an App Service Plan for an Azure Function. (autogenerated) - text: az functionapp plan create --is-linux true --location westus2 --name MyPlan --number-of-workers 1 --resource-group MyResourceGroup --sku B1 + - name: Bind an SSL certificate to a web app. (autogenerated) + text: az webapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyWebapp --resource-group MyResourceGroup --ssl-type SNI crafted: true """ -aladdin_helps['functionapp plan delete'] = """ +aladdin_helps['webapp config ssl delete'] = """ type: command -short-summary: Delete an App Service Plan. +short-summary: Delete an SSL certificate from a web app. examples: - - name: Delete an App Service Plan. (autogenerated) - text: az functionapp plan delete --name myappserviceplan --resource-group myresourcegroup + - name: Delete an SSL certificate from a web app. (autogenerated) + text: az webapp config ssl delete --certificate-thumbprint {certificate-thumbprint} --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp plan show'] = """ +aladdin_helps['webapp config ssl list'] = """ type: command -short-summary: Get the App Service Plans for a resource group or a set of resource groups. +short-summary: List SSL certificates for a web app. examples: - - name: Get the app service plans for a resource group or a set of resource groups. (autogenerated) - text: az functionapp plan show --name MyAppServicePlan --resource-group MyResourceGroup + - name: List SSL certificates for a web app. (autogenerated) + text: az webapp config ssl list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp restart'] = """ +aladdin_helps['webapp config ssl show'] = """ type: command -short-summary: Restart a function app. +short-summary: Show the details of an SSL certificate for a web app. examples: - - name: Restart a function app. (autogenerated) - text: az functionapp restart --name MyFunctionApp --resource-group MyResourceGroup + - name: Show the details of an SSL certificate for a web app. (autogenerated) + text: az webapp config ssl show --resource-group MyResourceGroup --certificate-name cname.mycustomdomain.com crafted: true """ -aladdin_helps['functionapp show'] = """ +aladdin_helps['webapp config ssl upload'] = """ type: command -short-summary: Get the details of a function app. +short-summary: Upload an SSL certificate to a web app. examples: - - name: Get the details of a function app. (autogenerated) - text: az functionapp show --name MyFunctionApp --resource-group MyResourceGroup + - name: Upload an SSL certificate to a web app. (autogenerated) + text: az webapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyWebapp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp start'] = """ +aladdin_helps['webapp config storage-account delete'] = """ type: command -short-summary: Start a function app. +short-summary: Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only) examples: - - name: Start a function app. (autogenerated) - text: az functionapp start --name MyFunctionApp --resource-group MyResourceGroup + - name: Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated) + text: az webapp config storage-account delete --custom-id CustomId --name MyWebApp --resource-group MyResourceGroup crafted: true """ -aladdin_helps['functionapp stop'] = """ +aladdin_helps['webapp config storage-account list'] = """ type: command -short-summary: Stop a function app. +short-summary: Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only) examples: - - name: Stop a function app. (autogenerated) - text: az functionapp stop --name MyFunctionApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['functionapp update'] = """ -type: command -short-summary: Update a function app. -examples: - - name: Update a function app. (autogenerated) - text: az functionapp update --name MyFunctionApp --plan MyPlan --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp auth show'] = """ -type: command -short-summary: Show the authentification settings for the webapp. -examples: - - name: Show the authentification settings for the webapp. (autogenerated) - text: az webapp auth show --name MyWebApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp browse'] = """ -type: command -short-summary: Open a web app in a browser. -examples: - - name: Open a web app in a browser. (autogenerated) - text: az webapp browse --name MyWebapp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config appsettings delete'] = """ -type: command -short-summary: Delete web app settings. -examples: - - name: Delete web app settings. (autogenerated) - text: az webapp config appsettings delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names} - crafted: true -""" - -aladdin_helps['webapp config appsettings list'] = """ -type: command -short-summary: Get the details of a web app's settings. -examples: - - name: Get the details of a web app's settings. (autogenerated) - text: az webapp config appsettings list --name MyWebapp --resource-group MyResourceGroup --subscription MySubscription - crafted: true -""" - -aladdin_helps['webapp config backup create'] = """ -type: command -short-summary: Create a backup of a web app. -examples: - - name: Create a backup of a web app. (autogenerated) - text: az webapp config backup create --container-url {container-url} --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config backup list'] = """ -type: command -short-summary: List backups of a web app. -examples: - - name: List backups of a web app. (autogenerated) - text: az webapp config backup list --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config backup show'] = """ -type: command -short-summary: Show the backup schedule for a web app. -examples: - - name: Show the backup schedule for a web app. (autogenerated) - text: az webapp config backup show --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config connection-string delete'] = """ -type: command -short-summary: Delete a web app's connection strings. -examples: - - name: Delete a web app's connection strings. (autogenerated) - text: az webapp config connection-string delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names} - crafted: true -""" - -aladdin_helps['webapp config connection-string list'] = """ -type: command -short-summary: Get a web app's connection strings. -examples: - - name: Get a web app's connection strings. (autogenerated) - text: az webapp config connection-string list --name MyWebapp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config container delete'] = """ -type: command -short-summary: Delete a web app container's settings. -examples: - - name: Delete a web app container's settings. (autogenerated) - text: az webapp config container delete --name MyWebApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config container set'] = """ -type: command -short-summary: Set a web app container's settings. -examples: - - name: Set a web app container's settings. (autogenerated) - text: az webapp config container set --docker-custom-image-name MyDockerCustomImage --docker-registry-server-password StrongPassword --docker-registry-server-url https://{azure-container-registry-name}.azurecr.io --docker-registry-server-user DockerUserId --name MyWebApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config container show'] = """ -type: command -short-summary: Get details of a web app container's settings. -examples: - - name: Get details of a web app container's settings. (autogenerated) - text: az webapp config container show --name MyWebapp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config hostname add'] = """ -type: command -short-summary: Bind a hostname to a web app. -examples: - - name: Bind a hostname to a web app. (autogenerated) - text: az webapp config hostname add --hostname $fqdn --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config hostname get-external-ip'] = """ -type: command -short-summary: Get the external-facing IP address for a web app. -examples: - - name: Get the external-facing IP address for a web app. (autogenerated) - text: az webapp config hostname get-external-ip --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config hostname list'] = """ -type: command -short-summary: List all hostname bindings for a web app. -examples: - - name: List all hostname bindings for a web app. (autogenerated) - text: az webapp config hostname list --resource-group MyResourceGroup --webapp-name MyWebapp - crafted: true -""" - -aladdin_helps['webapp config show'] = """ -type: command -short-summary: Get the details of a web app's configuration. -examples: - - name: Get the details of a web app's configuration. (autogenerated) - text: az webapp config show --name MyWebapp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config snapshot list'] = """ -type: command -short-summary: List the restorable snapshots for a web app. -examples: - - name: List the restorable snapshots for a web app. (autogenerated) - text: az webapp config snapshot list --name MyWebApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config snapshot restore'] = """ -type: command -short-summary: Restore a web app snapshot. -examples: - - name: Restore a web app snapshot. (autogenerated) - text: az webapp config snapshot restore --name MySite --resource-group MyResourceGroup --slot staging --source-name SourceApp --source-resource-group OriginalResourceGroup --time 2018-12-11T23:34:16.8388367 - crafted: true -""" - -aladdin_helps['webapp config ssl bind'] = """ -type: command -short-summary: Bind an SSL certificate to a web app. -examples: - - name: Bind an SSL certificate to a web app. (autogenerated) - text: az webapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyWebapp --resource-group MyResourceGroup --ssl-type SNI - crafted: true -""" - -aladdin_helps['webapp config ssl delete'] = """ -type: command -short-summary: Delete an SSL certificate from a web app. -examples: - - name: Delete an SSL certificate from a web app. (autogenerated) - text: az webapp config ssl delete --certificate-thumbprint {certificate-thumbprint} --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config ssl list'] = """ -type: command -short-summary: List SSL certificates for a web app. -examples: - - name: List SSL certificates for a web app. (autogenerated) - text: az webapp config ssl list --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config ssl upload'] = """ -type: command -short-summary: Upload an SSL certificate to a web app. -examples: - - name: Upload an SSL certificate to a web app. (autogenerated) - text: az webapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyWebapp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config storage-account delete'] = """ -type: command -short-summary: Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only) -examples: - - name: Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated) - text: az webapp config storage-account delete --custom-id CustomId --name MyWebApp --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['webapp config storage-account list'] = """ -type: command -short-summary: Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only) -examples: - - name: Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated) - text: az webapp config storage-account list --name MyWebApp --resource-group MyResourceGroup + - name: Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated) + text: az webapp config storage-account list --name MyWebApp --resource-group MyResourceGroup crafted: true """ @@ -1617,18 +1296,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 managed service identity (autogenerated) + - 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 """ @@ -1729,7 +1408,7 @@ aladdin_helps['webapp update'] = """ type: command -short-summary: Update a web app. +short-summary: Update an existing web app. examples: - name: Update a web app. (autogenerated) text: az webapp update --https-only true --name MyAppName --resource-group MyResourceGroup @@ -1824,7 +1503,7 @@ short-summary: Show details of a container registered to a Recovery services vault. examples: - name: Show details of a container registered to a Recovery services vault. (autogenerated) - text: az backup container show --backup-management-type AzureIaasVM --name MyContainer --resource-group MyResourceGroup --vault-name MyVault + text: az backup container show --name MyContainer --resource-group MyResourceGroup --vault-name MyVault crafted: true """ @@ -1837,24 +1516,12 @@ crafted: true """ -aladdin_helps['backup item set-policy'] = """ -type: command -short-summary: Update the policy associated with this item. Use this to change policies of the backup item. -examples: - - name: Update the policy associated with this item (autogenerated) - text: az backup item set-policy --backup-management-type AzureIaasVM --container-name MyContainer --name MyItem --policy-name MyPolicy --resource-group MyResourceGroup --vault-name MyVault - crafted: true -""" - aladdin_helps['backup item show'] = """ type: command short-summary: Show details of a particular backed up item. examples: - name: Show details of a particular backed up item. (autogenerated) - text: az backup item show --container-name MyContainer --ids {ids} --name MyBackedUpItem - crafted: true - - name: Show details of a particular backed up item. (autogenerated) - text: az backup item show --backup-management-type AzureIaasVM --container-name MyContainer --name MyBackedUpItem --resource-group MyResourceGroup --vault-name MyVault + text: az backup item show --container-name MyContainer --name MyBackedUpItem --resource-group MyResourceGroup --vault-name MyVault crafted: true """ @@ -1939,21 +1606,12 @@ crafted: true """ -aladdin_helps['backup protectable-item initialize'] = """ -type: command -short-summary: Trigger the discovery of any unprotected items of the given workload type in the given container. -examples: - - name: Trigger the discovery of any unprotected items of the given workload type in the given container. (autogenerated) - text: az backup protectable-item initialize --container-name MyContainer --resource-group MyResourceGroup --subscription mysubscription --vault-name MyVault --workload-type MSSQL - crafted: true -""" - aladdin_helps['backup protection backup-now'] = """ type: command short-summary: Perform an on-demand backup of a backed up item. examples: - name: Perform an on-demand backup of a backed up item. (autogenerated) - text: az backup protection backup-now --backup-management-type AzureIaasVM --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --retain-until 01-02-2018 --vault-name MyVault + text: az backup protection backup-now --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --retain-until 01-02-2018 --vault-name MyVault --backup-management-type AzureIaasVM crafted: true """ @@ -1962,7 +1620,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 """ @@ -1970,8 +1628,8 @@ type: command short-summary: Stop protecting a backed up item. Can retain the backed up data forever or choose to delete it. examples: - - name: Stop protecting a backed up item (autogenerated) - text: az backup protection disable --backup-management-type AzureIaasVM --container-name MyContainer --delete-backup-data true --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault --yes + - name: Stop protecting a backed up item. Can retain the backed up data forever or choose to delete it. (autogenerated) + text: az backup protection disable --container-name MyContainer --backup-management-type AzureIaasVM --delete-backup-data false --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault --yes crafted: true """ @@ -1984,21 +1642,12 @@ crafted: true """ -aladdin_helps['backup recoveryconfig show'] = """ -type: command -short-summary: Construct the recovery configuration of an Azure workload backed up item. -examples: - - name: Construct the recovery configuration of an Azure workload backed up item. (autogenerated) - text: az backup recoveryconfig show --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --restore-mode AlternateWorkloadRestore --rp-name myrp --target-container-name mytargetcontainer --target-item-name mytargetitem --target-server-name mytargetserver --target-server-type SQLAG --vault-name MyVault --workload-type MSSQL - crafted: true -""" - aladdin_helps['backup recoverypoint list'] = """ type: command short-summary: List all recovery points of a backed up item. examples: - name: List all recovery points of a backed up item. (autogenerated) - text: az backup recoverypoint list --backup-management-type AzureIaasVM --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault + text: az backup recoverypoint list --container-name MyContainer --backup-management-type AzureIaasVM --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault crafted: true """ @@ -2007,7 +1656,7 @@ short-summary: Shows details of a particular recovery point. examples: - name: Shows details of a particular recovery point. (autogenerated) - text: az backup recoverypoint show --backup-management-type AzureIaasVM --container-name MyContainer --item-name MyItem --name MyRecoveryPoint --resource-group MyResourceGroup --vault-name MyVault + text: az backup recoverypoint show --container-name MyContainer --backup-management-type AzureIaasVM --item-name MyItem --name MyRecoveryPoint --resource-group MyResourceGroup --vault-name MyVault crafted: true """ @@ -2025,7 +1674,7 @@ short-summary: Close access to the recovery point. examples: - name: Close access to the recovery point. (autogenerated) - text: az backup restore files unmount-rp --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --rp-name MyRp --subscription mysubscription --vault-name MyVault + text: az backup restore files unmount-rp --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --rp-name MyRp --vault-name MyVault crafted: true """ @@ -2074,6 +1723,33 @@ crafted: true """ +aladdin_helps['backup vault identity assign'] = """ +type: command +short-summary: Assign Identities to Recovery Services vault. +examples: + - name: Assign Identities to Recovery Services vault. (autogenerated) + text: az backup vault identity assign --system-assigned --user-assigned MyIdentityId1 --resource-group MyResourceGroup --name MyVault + crafted: true +""" + +aladdin_helps['backup vault identity remove'] = """ +type: command +short-summary: Remove Identities of Recovery Services vault. +examples: + - name: Remove Identities of Recovery Services vault. (autogenerated) + text: az backup vault identity remove --system-assigned --user-assigned MyIdentityId1 --resource-group MyResourceGroup --name MyVault + crafted: true +""" + +aladdin_helps['backup vault identity show'] = """ +type: command +short-summary: Show Identities of Recovery Services vault. +examples: + - name: Show Identities of Recovery Services vault. (autogenerated) + text: az backup vault identity show --resource-group MyResourceGroup --name MyVault + crafted: true +""" + aladdin_helps['backup vault show'] = """ type: command short-summary: Show details of a particular Recovery service vault. @@ -2122,110 +1798,11 @@ crafted: true """ -aladdin_helps['batchai workspace list'] = """ -type: command -short-summary: List workspaces. -examples: - - name: List workspaces. (autogenerated) - text: az batchai workspace list --resource-group MyResourceGroup --subscription mysubscription - crafted: true -""" -aladdin_helps['bot authsetting list'] = """ -type: command -short-summary: Show all OAuth connection settings on a bot. -examples: - - name: Show all OAuth connection settings on a bot. (autogenerated) - text: az bot authsetting list --name myresourcebot --resource-group myresourcegroup - crafted: true -""" -aladdin_helps['bot authsetting show'] = """ -type: command -short-summary: Show details of an OAuth connection setting on a bot. -examples: - - name: Show details of an OAuth connection setting on a bot. (autogenerated) - text: az bot authsetting show --name myresourcebot --resource-group myresourcegroup --setting-name mysetting - crafted: true -""" - -aladdin_helps['bot delete'] = """ -type: command -short-summary: Delete an existing bot. -examples: - - name: Delete an existing bot. (autogenerated) - text: az bot delete --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot directline delete'] = """ -type: command -short-summary: Delete the Directline Channel on a bot -examples: - - name: Delete the Directline Channel on a bot. (autogenerated) - text: az bot directline delete --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot directline show'] = """ -type: command -short-summary: Get details of the Directline Channel on a bot -examples: - - name: Get details of the Directline Channel on a bot. (autogenerated) - text: az bot directline show --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot download'] = """ -type: command -short-summary: Download an existing bot. -long-summary: The source code is downloaded from the web app associated with the bot. You can then make changes to it and publish it back to your app. -examples: - - name: Download an existing bot. (autogenerated) - text: az bot download --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot msteams delete'] = """ -type: command -short-summary: Delete the Microsoft Teams Channel on a bot -examples: - - name: Delete the Microsoft Teams Channel on a bot. (autogenerated) - text: az bot msteams delete --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot msteams show'] = """ -type: command -short-summary: Get details of the Microsoft Teams Channel on a bot -examples: - - name: Get details of the Microsoft Teams Channel on a bot. (autogenerated) - text: az bot msteams show --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['bot webchat show'] = """ -type: command -short-summary: Get details of the Webchat Channel on a bot -examples: - - name: Get details of the Webchat Channel on a bot. (autogenerated) - text: az bot webchat show --name myresourcebot --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cdn endpoint rule condition add'] = """ -type: command -short-summary: Add a condition to a delivery rule. -examples: - - name: Add a condition to a delivery rule. (autogenerated) - text: | - az cdn endpoint rule condition add --match-values "TH" --match-variable RemoteAddress --name endpoint --negate-condition true --operator GeoMatch --profile-name profile --resource-group group --rule-name name - crafted: true -""" - -aladdin_helps['cdn profile create'] = """ +aladdin_helps['cdn profile create'] = """ type: command short-summary: Create a new CDN profile. parameters: @@ -2249,52 +1826,6 @@ crafted: true """ -aladdin_helps['cdn waf policy custom-rule set'] = """ -type: command -short-summary: Add a custom rule to a CDN WAF policy. -parameters: - - name: --action - type: string - short-summary: > - The action to take when the rule is matched. - - name: --match-condition -m - type: string - short-summary: Conditions used to determine if the rule is matched for a request. - long-summary: | - Match conditions are specified as key value pairs in the form "KEY=VALUE [KEY=VALUE ...]". - Available keys are 'match-variable', 'operator', 'match-value', 'selector', 'negate', and - 'transform'. 'match-variable', 'operator', and 'match-value' are required. 'match-value' - and 'transform' may be specified multiple times per match condition. - - Valid values for 'match-variable' are 'RemoteAddr', 'SocketAddr', 'RequestMethod', - 'RequestHeader', 'RequestUri', 'QueryString', 'RequestBody', 'Cookies', and 'PostArgs'. - Valid values for 'operator' are 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', - 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', - 'EndsWith', and 'RegEx'. Valid values for 'transform' are 'Lowercase', 'Uppercase', - 'Trim', 'UrlDecode', 'UrlEncode', and 'RemoveNulls'. Valid values for 'negate' are 'True' - and 'False', and 'negate' defaults to 'False'. - - name: --priority - type: int - short-summary: The priority of the custom rule as a non-negative integer. - - name: --disabled - type: bool - short-summary: Disable the custom rule -examples: - - name: Add a custom rule to a CDN WAF policy. (autogenerated) - text: | - az cdn waf policy custom-rule set --action Allow --match-condition match-variable=QueryString operator=Contains "match-value= " --name customrule --only-show-errors --policy-name policy --priority 100 --resource-group group - crafted: true -""" - -aladdin_helps['cdn waf policy managed-rule-set add'] = """ -type: command -short-summary: Add a managed rule set to a CDN WAF policy. -examples: - - name: Add a managed rule set to a CDN WAF policy. (autogenerated) - text: az cdn waf policy managed-rule-set add --only-show-errors --policy-name policy --resource-group group --rule-set-type DefaultRuleSet --rule-set-version 1.0 - crafted: true -""" - aladdin_helps['cloud set'] = """ type: command short-summary: Set the active cloud. @@ -2375,6 +1906,8 @@ + + aladdin_helps['consumption budget delete'] = """ type: command short-summary: Delete a budget for an Azure subscription. @@ -2429,15 +1962,6 @@ crafted: true """ -aladdin_helps['cosmosdb cassandra keyspace create'] = """ -type: command -short-summary: Create an Cassandra keyspace under an Azure Cosmos DB account. -examples: - - name: Create an Cassandra keyspace under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb cassandra keyspace create --account-name myaccount --name mykeyspace --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb cassandra keyspace delete'] = """ type: command short-summary: Delete the Cassandra keyspace under an Azure Cosmos DB account. @@ -2456,34 +1980,6 @@ crafted: true """ -aladdin_helps['cosmosdb cassandra keyspace show'] = """ -type: command -short-summary: Show the details of a Cassandra keyspace under an Azure Cosmos DB account. -examples: - - name: Show the details of a Cassandra keyspace under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb cassandra keyspace show --account-name myaccount --name mykeyspace --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb cassandra keyspace throughput show'] = """ -type: command -short-summary: Get the throughput of the Cassandra keyspace under an Azure Cosmos DB account. -examples: - - name: Get the throughput of the Cassandra keyspace under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb cassandra keyspace throughput show --account-name myaccount --name mykeyspace --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb cassandra keyspace throughput update'] = """ -type: command -short-summary: Update the throughput of the Cassandra keyspace under an Azure Cosmos DB account. -examples: - - name: Update the throughput of the Cassandra keyspace under an Azure Cosmos DB account. (autogenerated) - text: | - az cosmosdb cassandra keyspace throughput update --account-name myaccount --name mykeyspace --resource-group myresourcegroup --throughput "500" - crafted: true -""" - aladdin_helps['cosmosdb cassandra table create'] = """ type: command short-summary: Create an Cassandra table under an Azure Cosmos DB Cassandra keyspace. @@ -2493,15 +1989,6 @@ crafted: true """ -aladdin_helps['cosmosdb cassandra table delete'] = """ -type: command -short-summary: Delete the Cassandra table under an Azure Cosmos DB Cassandra keyspace. -examples: - - name: Delete the Cassandra table under an Azure Cosmos DB Cassandra keyspace. (autogenerated) - text: az cosmosdb cassandra table delete --account-name myaccount --keyspace-name mykeyspace --name mytable --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb cassandra table list'] = """ type: command short-summary: List the Cassandra tables under an Azure Cosmos DB Cassandra keyspace. @@ -2511,15 +1998,6 @@ crafted: true """ -aladdin_helps['cosmosdb cassandra table show'] = """ -type: command -short-summary: Show the details of a Cassandra table under an Azure Cosmos DB Cassandra keyspace. -examples: - - name: Show the details of a Cassandra table under an Azure Cosmos DB Cassandra keyspace. (autogenerated) - text: az cosmosdb cassandra table show --account-name myaccount --keyspace-name mykeyspace --name mytable --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb cassandra table throughput show'] = """ type: command short-summary: Get the throughput of the Cassandra table under an Azure Cosmos DB Cassandra keyspace. @@ -2570,6 +2048,10 @@ Default: single region account in the location of the specified resource group. Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. Multiple locations can be specified by using more than one `--locations` argument. + - name: --databases-to-restore + short-summary: Add a database and its collection names to restore + long-summary: | + Usage: --databases-to-restore name=DatabaseName collections=collection1 [collection2 ...] examples: - name: Creates a new Azure Cosmos DB database account. (autogenerated) text: az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription @@ -2580,8 +2062,8 @@ type: command short-summary: Creates an Azure Cosmos DB database examples: - - name: Creates an Azure Cosmos DB database. (autogenerated) - text: az cosmosdb database create --db-name MyDatabase --name MyCosmosDBDatabaseAccount --resource-group-name myresourcegroup + - name: Creates an Azure Cosmos DB database. + text: az cosmosdb database create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --db-name MyDatabase crafted: true """ @@ -2634,44 +2116,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 - crafted: true -""" - -aladdin_helps['cosmosdb gremlin database create'] = """ -type: command -short-summary: Create an Gremlin database under an Azure Cosmos DB account. -examples: - - name: Create an Gremlin database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb gremlin database create --account-name myaccount --name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb gremlin database delete'] = """ -type: command -short-summary: Delete the Gremlin database under an Azure Cosmos DB account. -examples: - - name: Delete the Gremlin database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb gremlin database delete --account-name myaccount --name mydatabase --resource-group myresourcegroup --yes - crafted: true -""" - -aladdin_helps['cosmosdb gremlin database list'] = """ -type: command -short-summary: List the Gremlin databases under an Azure Cosmos DB account. -examples: - - name: List the Gremlin databases under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb gremlin database list --account-name myaccount --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb gremlin database show'] = """ -type: command -short-summary: Show the details of a Gremlin database under an Azure Cosmos DB account. -examples: - - name: Show the details of a Gremlin database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb gremlin database show --account-name myaccount --name mydatabase --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 """ @@ -2684,33 +2130,6 @@ crafted: true """ -aladdin_helps['cosmosdb gremlin graph delete'] = """ -type: command -short-summary: Delete the Gremlin graph under an Azure Cosmos DB Gremlin database. -examples: - - name: Delete the Gremlin graph under an Azure Cosmos DB Gremlin database. (autogenerated) - text: az cosmosdb gremlin graph delete --account-name myaccount --database-name mydatabase --name mygraph --resource-group myresourcegroup --yes - crafted: true -""" - -aladdin_helps['cosmosdb gremlin graph list'] = """ -type: command -short-summary: List the Gremlin graphs under an Azure Cosmos DB Gremlin database. -examples: - - name: List the Gremlin graphs under an Azure Cosmos DB Gremlin database (autogenerated) - text: az cosmosdb gremlin graph list --account-name myaccount --database-name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb gremlin graph show'] = """ -type: command -short-summary: Show the details of a Gremlin graph under an Azure Cosmos DB Gremlin database. -examples: - - name: Show the details of a Gremlin graph under an Azure Cosmos DB Gremlin database. (autogenerated) - text: az cosmosdb gremlin graph show --account-name myaccount --database-name mydatabase --name mygraph --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb keys list'] = """ type: command short-summary: List the access keys or connection strings for a Azure Cosmos DB database account. @@ -2756,70 +2175,6 @@ crafted: true """ -aladdin_helps['cosmosdb mongodb collection delete'] = """ -type: command -short-summary: Delete the MongoDB collection under an Azure Cosmos DB MongoDB database. -examples: - - name: Delete the MongoDB collection under an Azure Cosmos DB MongoDB database. (autogenerated) - text: az cosmosdb mongodb collection delete --account-name myaccount --database-name mydatabase --name mycollection --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb collection list'] = """ -type: command -short-summary: List the MongoDB collections under an Azure Cosmos DB MongoDB database. -examples: - - name: List the MongoDB collections under an Azure Cosmos DB MongoDB database. (autogenerated) - text: az cosmosdb mongodb collection list --account-name myaccount --database-name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb collection show'] = """ -type: command -short-summary: Show the details of a MongoDB collection under an Azure Cosmos DB MongoDB database. -examples: - - name: Show the details of a MongoDB collection under an Azure Cosmos DB MongoDB database. (autogenerated) - text: az cosmosdb mongodb collection show --account-name myaccount --database-name mydatabase --name mycollection --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb collection throughput show'] = """ -type: command -short-summary: Get the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. -examples: - - name: Get the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. (autogenerated) - text: az cosmosdb mongodb collection throughput show --account-name myaccount --database-name mydatabase --name mycollection --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb collection throughput update'] = """ -type: command -short-summary: Update the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. -examples: - - name: Update the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. (autogenerated) - text: | - az cosmosdb mongodb collection throughput update --account-name myaccount --database-name mydatabase --name mycollection --resource-group myresourcegroup --throughput "500" - crafted: true -""" - -aladdin_helps['cosmosdb mongodb collection update'] = """ -type: command -short-summary: Update an MongoDB collection under an Azure Cosmos DB MongoDB database. -examples: - - name: Update an MongoDB collection under an Azure Cosmos DB MongoDB database. (autogenerated) - text: az cosmosdb mongodb collection update --account-name myaccount --database-name mydatabase --idx @indexes-file.json --name mycollection --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb database create'] = """ -type: command -short-summary: Create an MongoDB database under an Azure Cosmos DB account. -examples: - - name: Create an MongoDB database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb mongodb database create --account-name myaccount --name mydatabase --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb mongodb database delete'] = """ type: command short-summary: Delete the MongoDB database under an Azure Cosmos DB account. @@ -2838,24 +2193,6 @@ crafted: true """ -aladdin_helps['cosmosdb mongodb database show'] = """ -type: command -short-summary: Show the details of a MongoDB database under an Azure Cosmos DB account. -examples: - - name: Show the details of a MongoDB database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb mongodb database show --account-name myaccount --name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb mongodb database throughput show'] = """ -type: command -short-summary: Get the throughput of the MongoDB database under an Azure Cosmos DB account. -examples: - - name: Get the throughput of the MongoDB database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb mongodb database throughput show --account-name myaccount --name mydatabase --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb mongodb database throughput update'] = """ type: command short-summary: Update the throughput of the MongoDB database under an Azure Cosmos DB account. @@ -2866,18 +2203,6 @@ crafted: true """ -aladdin_helps['cosmosdb private-link-resource list'] = """ -type: command -short-summary: List the private link resources supported for Azure Comsos DB. -example: - - name: List the private link resources supported for Azure Comsos DB. - text: cosmosdb private-link-resource list --account-name MyAccount --resource-group MyResourceGroup -examples: - - name: List the private link resources supported for Azure Cosmos DB. (autogenerated) - text: az cosmosdb private-link-resource list --account-name myaccount --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['cosmosdb regenerate-key'] = """ type: command short-summary: Regenerate an access key for a Azure Cosmos DB database account. @@ -2905,373 +2230,129 @@ crafted: true """ -aladdin_helps['cosmosdb sql container delete'] = """ +aladdin_helps['cosmosdb sql database list'] = """ type: command -short-summary: Delete the SQL container under an Azure Cosmos DB SQL database. +short-summary: List the SQL databases under an Azure Cosmos DB account. examples: - - name: Delete the SQL container under an Azure Cosmos DB SQL database. (autogenerated) - text: az cosmosdb sql container delete --account-name myaccount --database-name mydatabase --name mycontainer --resource-group myresourcegroup + - name: List the SQL databases under an Azure Cosmos DB account (autogenerated) + text: az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup crafted: true """ -aladdin_helps['cosmosdb sql container list'] = """ +aladdin_helps['cosmosdb sql stored-procedure create'] = """ type: command -short-summary: List the SQL containers under an Azure Cosmos DB SQL database. +short-summary: Create an SQL stored procedure under an Azure Cosmos DB SQL container. examples: - - name: List the SQL containers under an Azure Cosmos DB SQL database. (autogenerated) - text: az cosmosdb sql container list --account-name myaccount --database-name mydatabase --resource-group myresourcegroup + - name: Create an Azure Cosmos DB SQL stored procedure. + text: az cosmosdb sql stored-procedure create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyStoredProcedure -b StoredProcedureBody crafted: true """ -aladdin_helps['cosmosdb sql container show'] = """ +aladdin_helps['cosmosdb sql trigger create'] = """ type: command -short-summary: Show the details of a SQL container under an Azure Cosmos DB SQL database. +short-summary: Create an SQL trigger under an Azure Cosmos DB SQL container. examples: - - name: Show the details of a SQL container under an Azure Cosmos DB SQL database. (autogenerated) - text: az cosmosdb sql container show --account-name myaccount --database-name mydatabase --name mycontainer --resource-group myresourcegroup + - name: Create an Azure Cosmos DB SQL trigger. + text: az cosmosdb sql trigger create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyTrigger -b TriggerBody crafted: true """ -aladdin_helps['cosmosdb sql container throughput show'] = """ +aladdin_helps['cosmosdb sql user-defined-function create'] = """ type: command -short-summary: Get the throughput of the SQL container under an Azure Cosmos DB SQL database. +short-summary: Create an SQL user defined function under an Azure Cosmos DB SQL container. examples: - - name: Get the throughput of the SQL container under an Azure Cosmos DB SQL database. (autogenerated) - text: az cosmosdb sql container throughput show --account-name myaccount --database-name mydatabase --name mycontainer --resource-group myresourcegroup + - name: Create an Azure Cosmos DB SQL user defined function. + text: az cosmosdb sql user-defined-function create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyUserDefinedFunction -b UserDefinedFunctionBody crafted: true """ -aladdin_helps['cosmosdb sql container throughput update'] = """ +aladdin_helps['cosmosdb update'] = """ type: command -short-summary: Update the throughput of the SQL container under an Azure Cosmos DB SQL database. +short-summary: Update an Azure Cosmos DB database account. +parameters: + - name: --locations + short-summary: Add a location to the Cosmos DB database account + long-summary: | + Usage: --locations KEY=VALUE [KEY=VALUE ...] + Required Keys: regionName, failoverPriority + Optional Key: isZoneRedundant + Default: single region account in the location of the specified resource group. + Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. + Multiple locations can be specified by using more than one `--locations` argument. examples: - - name: Update the throughput of the SQL container under an Azure Cosmos DB SQL database. (autogenerated) - text: | - az cosmosdb sql container throughput update --account-name myaccount --database-name mydatabase --name mycontainer --resource-group myresourcegroup --throughput "700" + - name: Update an Azure Cosmos DB database account. (autogenerated) + text: az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup crafted: true """ -aladdin_helps['cosmosdb sql container update'] = """ + + +aladdin_helps['deploymentmanager service-unit update'] = """ type: command -short-summary: Update an SQL container under an Azure Cosmos DB SQL database. +short-summary: Updates the service unit. examples: - - name: Update an SQL container under an Azure Cosmos DB SQL database. (autogenerated) - text: az cosmosdb sql container update --account-name myaccount --database-name mydatabase --idx @policy-file.json --name mycontainer --resource-group myresourcegroup + - name: Updates the service unit. (autogenerated) + text: az deploymentmanager service-unit update --deployment-mode Incremental --resource-group rg1 --service-name contosoService1 --service-topology-name contosoServiceTopology --service-unit-name ContosoService1Storage crafted: true """ -aladdin_helps['cosmosdb sql database create'] = """ + + +aladdin_helps['dls account create'] = """ type: command -short-summary: Create an SQL database under an Azure Cosmos DB account. +short-summary: Creates a Data Lake Store account. +parameters: + - name: --key-vault-id + type: string + short-summary: 'Key vault for the user-assigned encryption type.' + - name: --key-name + type: string + short-summary: 'Key name for the user-assigned encryption type.' examples: - - name: Create an SQL database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb sql database create --account-name myaccount --name mydatabase --resource-group myresourcegroup + - name: Creates a Data Lake Store account. (autogenerated) + text: az dls account create --account mydatalakestoragegen1 --resource-group MyResourceGroup crafted: true """ -aladdin_helps['cosmosdb sql database delete'] = """ +aladdin_helps['dls account delete'] = """ type: command -short-summary: Delete the SQL database under an Azure Cosmos DB account. +short-summary: Delete a Data Lake Store account. examples: - - name: Delete the SQL database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb sql database delete --account-name myaccount --name mydatabase --resource-group myresourcegroup + - name: Delete a Data Lake Store account. (autogenerated) + text: az dls account delete --account mydatalakestoragegen1 crafted: true """ -aladdin_helps['cosmosdb sql database list'] = """ +aladdin_helps['dls account enable-key-vault'] = """ type: command -short-summary: List the SQL databases under an Azure Cosmos DB account. +short-summary: Enable the use of Azure Key Vault for encryption of a Data Lake Store account. examples: - - name: List the SQL databases under an Azure Cosmos DB account (autogenerated) - text: az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup + - name: Enable the use of Azure Key Vault for encryption of a Data Lake Store account. (autogenerated) + text: az dls account enable-key-vault --account mydatalakestoragegen1 crafted: true """ -aladdin_helps['cosmosdb sql database show'] = """ +aladdin_helps['dls account firewall list'] = """ type: command -short-summary: Show the details of a SQL database under an Azure Cosmos DB account. +short-summary: Lists firewall rules in a Data Lake Store account. examples: - - name: Show the details of a SQL database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb sql database show --account-name myaccount --name mydatabase --resource-group myresourcegroup + - name: Lists firewall rules in a Data Lake Store account. (autogenerated) + text: az dls account firewall list --account mydatalakestoragegen1 --subscription MySubscription crafted: true """ -aladdin_helps['cosmosdb sql database throughput show'] = """ +aladdin_helps['dls account list'] = """ type: command -short-summary: Get the throughput of the SQL database under an Azure Cosmos DB account. +short-summary: Lists available Data Lake Store accounts. examples: - - name: Get the throughput of the SQL database under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb sql database throughput show --account-name myaccount --name mydatabase --resource-group myresourcegroup + - name: Lists available Data Lake Store accounts. (autogenerated) + text: az dls account list --resource-group MyResourceGroup crafted: true """ -aladdin_helps['cosmosdb sql database throughput update'] = """ +aladdin_helps['dls account show'] = """ type: command -short-summary: Update the throughput of the SQL database under an Azure Cosmos DB account. -examples: - - name: Update the throughput of the SQL database under an Azure Cosmos DB account. (autogenerated) - text: | - az cosmosdb sql database throughput update --account-name myaccount --name mydatabase --resource-group myresourcegroup --throughput "700" - crafted: true -""" - -aladdin_helps['cosmosdb sql stored-procedure create'] = """ -type: command -short-summary: Create an SQL stored procedure under an Azure Cosmos DB SQL container. -examples: - - name: Create an Azure Cosmos DB SQL stored procedure. - text: az cosmosdb sql stored-procedure create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyStoredProcedure -b StoredProcedureBody - crafted: true -""" - -aladdin_helps['cosmosdb sql stored-procedure delete'] = """ -type: command -short-summary: Delete the SQL stored procedure under an Azure Cosmos DB SQL container. -examples: - - name: Delete the SQL stored procedure under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql stored-procedure delete --account-name myaccount --container-name mycontainer --database-name mydatabase --name mystoredprocedure --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql stored-procedure list'] = """ -type: command -short-summary: List the SQL stored procedures under an Azure Cosmos DB SQL container. -examples: - - name: List the SQL stored procedures under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql stored-procedure list --account-name myaccount --container-name mycontainer --database-name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql stored-procedure show'] = """ -type: command -short-summary: Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container. -examples: - - name: Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql stored-procedure show --account-name myaccount --container-name mycontainer --database-name mydatabase --name mystoredprocedure --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql trigger create'] = """ -type: command -short-summary: Create an SQL trigger under an Azure Cosmos DB SQL container. -examples: - - name: Create an SQL trigger under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql trigger create --account-name MyAccount --body TriggerBody --container-name MyContainer --database-name MyDatabase --name MyTrigger --operation All --resource-group MyResourceGroup --type Pre - crafted: true -""" - -aladdin_helps['cosmosdb sql trigger delete'] = """ -type: command -short-summary: Delete the SQL trigger under an Azure Cosmos DB SQL container. -examples: - - name: Delete the SQL trigger under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql trigger delete --account-name myaccount --container-name mycontainer --database-name mydatabase --name mytrigger --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql trigger list'] = """ -type: command -short-summary: List the SQL triggers under an Azure Cosmos DB SQL container. -examples: - - name: List the SQL triggers under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql trigger list --account-name myaccount --container-name mycontainer --database-name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql trigger show'] = """ -type: command -short-summary: Show the details of a SQL trigger under an Azure Cosmos DB SQL container. -examples: - - name: Show the details of a SQL trigger under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql trigger show --account-name myaccount --container-name mycontainer --database-name mydatabase --name mytrigger --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql user-defined-function create'] = """ -type: command -short-summary: Create an SQL user defined function under an Azure Cosmos DB SQL container. -examples: - - name: Create an Azure Cosmos DB SQL user defined function. - text: az cosmosdb sql user-defined-function create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyUserDefinedFunction -b UserDefinedFunctionBody - crafted: true -""" - -aladdin_helps['cosmosdb sql user-defined-function delete'] = """ -type: command -short-summary: Delete the SQL user defined function under an Azure Cosmos DB SQL container. -examples: - - name: Delete the SQL user defined function under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql user-defined-function delete --account-name myaccount --container-name mycontainer --database-name mydatabase --name myuserdefinedfunction --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql user-defined-function list'] = """ -type: command -short-summary: List the SQL user defined functions under an Azure Cosmos DB SQL container. -examples: - - name: List the SQL user defined functions under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql user-defined-function list --account-name myaccount --container-name mycontainer --database-name mydatabase --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb sql user-defined-function show'] = """ -type: command -short-summary: Show the details of a SQL user defined function under an Azure Cosmos DB SQL container. -examples: - - name: Show the details of a SQL user defined function under an Azure Cosmos DB SQL container. (autogenerated) - text: az cosmosdb sql user-defined-function show --account-name myaccount --container-name mycontainer --database-name mydatabase --name myuserdefinedfunction --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table create'] = """ -type: command -short-summary: Create an Table under an Azure Cosmos DB account. -examples: - - name: Create an Table under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb table create --account-name myaccount --name mytable --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table delete'] = """ -type: command -short-summary: Delete the Table under an Azure Cosmos DB account. -examples: - - name: Delete the Table under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb table delete --account-name myaccount --name mytable --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table list'] = """ -type: command -short-summary: List the Tables under an Azure Cosmos DB account. -examples: - - name: List the Tables under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb table list --account-name myaccount --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table show'] = """ -type: command -short-summary: Show the details of a Table under an Azure Cosmos DB account. -examples: - - name: Show the details of a Table under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb table show --account-name myaccount --name mytable --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table throughput show'] = """ -type: command -short-summary: Get the throughput of the Table under an Azure Cosmos DB account. -examples: - - name: Get the throughput of the Table under an Azure Cosmos DB account. (autogenerated) - text: az cosmosdb table throughput show --account-name myaccount --name mytable --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['cosmosdb table throughput update'] = """ -type: command -short-summary: Update the throughput of the Table under an Azure Cosmos DB account. -examples: - - name: Update the throughput of the Table under an Azure Cosmos DB account. (autogenerated) - text: | - az cosmosdb table throughput update --account-name myaccount --name mytable --resource-group myresourcegroup --throughput "700" - crafted: true -""" - -aladdin_helps['cosmosdb update'] = """ -type: command -short-summary: Update an Azure Cosmos DB database account. -parameters: - - name: --locations - short-summary: Add a location to the Cosmos DB database account - long-summary: | - Usage: --locations KEY=VALUE [KEY=VALUE ...] - Required Keys: regionName, failoverPriority - Optional Key: isZoneRedundant - Default: single region account in the location of the specified resource group. - Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. - Multiple locations can be specified by using more than one `--locations` argument. -examples: - - name: Update an Azure Cosmos DB database account. (autogenerated) - text: az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['deploymentmanager service-unit update'] = """ -type: command -short-summary: Updates the service unit. -examples: - - name: Updates the service unit. (autogenerated) - text: az deploymentmanager service-unit update --deployment-mode Incremental --resource-group rg1 --service-name contosoService1 --service-topology-name contosoServiceTopology --service-unit-name ContosoService1Storage - crafted: true -""" - - - -aladdin_helps['dls account create'] = """ -type: command -short-summary: Creates a Data Lake Store account. -parameters: - - name: --key-vault-id - type: string - short-summary: 'Key vault for the user-assigned encryption type.' - - name: --key-name - type: string - short-summary: 'Key name for the user-assigned encryption type.' -examples: - - name: Creates a Data Lake Store account. (autogenerated) - text: az dls account create --account mydatalakestoragegen1 --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['dls account delete'] = """ -type: command -short-summary: Delete a Data Lake Store account. -examples: - - name: Delete a Data Lake Store account. (autogenerated) - text: az dls account delete --account mydatalakestoragegen1 - crafted: true -""" - -aladdin_helps['dls account enable-key-vault'] = """ -type: command -short-summary: Enable the use of Azure Key Vault for encryption of a Data Lake Store account. -examples: - - name: Enable the use of Azure Key Vault for encryption of a Data Lake Store account. (autogenerated) - text: az dls account enable-key-vault --account mydatalakestoragegen1 - crafted: true -""" - -aladdin_helps['dls account firewall delete'] = """ -type: command -short-summary: Deletes a firewall rule in a Data Lake Store account. -examples: - - name: Deletes a firewall rule in a Data Lake Store account. (autogenerated) - text: az dls account firewall delete --account mydatalakestoragegen1 --firewall-rule-name myfirewallrule - crafted: true -""" - -aladdin_helps['dls account firewall list'] = """ -type: command -short-summary: Lists firewall rules in a Data Lake Store account. -examples: - - name: Lists firewall rules in a Data Lake Store account. (autogenerated) - text: az dls account firewall list --account mydatalakestoragegen1 --subscription MySubscription - crafted: true -""" - -aladdin_helps['dls account list'] = """ -type: command -short-summary: Lists available Data Lake Store accounts. -examples: - - name: Lists available Data Lake Store accounts. (autogenerated) - text: az dls account list --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['dls account show'] = """ -type: command -short-summary: Get the details of a Data Lake Store account. +short-summary: Get the details of a Data Lake Store account. examples: - name: Get the details of a Data Lake Store account. (autogenerated) text: az dls account show --account mydatalakestoragegen1 @@ -3366,7 +2447,7 @@ short-summary: Delete a file or folder in a Data Lake Store account. examples: - name: Delete a file or folder in a Data Lake Store account. (autogenerated) - text: az dls fs delete --account dpreptestfiles --path / --recurse + text: az dls fs delete --account {account} --path {path} crafted: true """ @@ -3469,7 +2550,6 @@ type: int short-summary: Size of a block, in bytes. long-summary: Within each chunk, a smaller block is written for each API call. A block cannot be bigger than a chunk and must be bigger than a buffer. - examples: - name: Upload a file or folder to a Data Lake Store account. (autogenerated) text: az dls fs upload --account {account} --destination-path {destination-path} --overwrite --source-path {source-path} @@ -3483,7 +2563,7 @@ - name: --name -n type: string short-summary: > - The Service name to check. + The service name to check. examples: - name: Check if a given DMS instance name is available in a given region as well as the name's validity. (autogenerated) text: az dms check-name --location westus2 --name MyService @@ -3513,90 +2593,67 @@ crafted: true """ -aladdin_helps['dms project check-name'] = """ -type: command -short-summary: Check if a given Project name is available within a given instance of DMS as well as the name's validity. -parameters: - - name: --name -n - type: string - short-summary: > - The Project name to check. -examples: - - name: Check if a given Project name is available within a given instance of DMS as well as the name's validity (autogenerated) - text: az dms project check-name --name myproject --resource-group myresourcegroup --service-name myservice - crafted: true -""" - aladdin_helps['dms project delete'] = """ type: command -short-summary: Delete a Project. +short-summary: Delete a project. parameters: - name: --delete-running-tasks type: bool short-summary: > - Cancel any running tasks before deleting the Project. + Cancel any running tasks before deleting the project. examples: - - name: Delete a Project. (autogenerated) + - name: Delete a project. (autogenerated) text: az dms project delete --name MyProject --resource-group MyResourceGroup --service-name MyService crafted: true """ aladdin_helps['dms project list'] = """ type: command -short-summary: List the Projects within an instance of DMS. +short-summary: List the projects within an instance of DMS. examples: - - name: List the Projects within an instance of DMS. (autogenerated) + - name: List the projects within an instance of DMS. (autogenerated) text: az dms project list --resource-group MyResourceGroup --service-name MyService crafted: true """ aladdin_helps['dms project show'] = """ type: command -short-summary: Show the details of a migration Project. +short-summary: Show the details of a migration project. examples: - - name: Show the details of a migration Project. (autogenerated) + - name: Show the details of a migration project. (autogenerated) text: az dms project show --name MyProject --resource-group MyResourceGroup --service-name MyService crafted: true """ aladdin_helps['dms project task delete'] = """ type: command -short-summary: Delete a migration Task. +short-summary: Delete a migration task. parameters: - name: --delete-running-tasks type: bool short-summary: > - If the Task is currently running, cancel the Task before deleting the Project. + If the task is currently running, cancel the task before deleting the project. examples: - - name: Delete a migration Task. (autogenerated) + - name: Delete a migration task. (autogenerated) text: az dms project task delete --name MyTask --project-name MyProject --resource-group MyResourceGroup --service-name MyService crafted: true """ aladdin_helps['dms project task show'] = """ type: command -short-summary: Show the details of a migration Task. Use the "--expand" to get more details. +short-summary: Show the details of a migration task. Use the "--expand" to get more details. parameters: - name: --expand type: string short-summary: > - Expand the response to provide more details. Use with "command" to see more details of the Task. - Use with "output" to see the results of the Task's migration. + Expand the response to provide more details. Use with "command" to see more details of the task. + Use with "output" to see the results of the task's migration. examples: - - name: Show the details of a migration Task. Use the "--expand" to get more details. (autogenerated) + - name: Show the details of a migration task. Use the "--expand" to get more details. (autogenerated) text: az dms project task show --name MyTask --project-name MyProject --resource-group MyResourceGroup --service-name MyService crafted: true """ -aladdin_helps['dms show'] = """ -type: command -short-summary: Show the details for an instance of the Data Migration Service. -examples: - - name: Show the details for an instance of the Data Migration Service. (autogenerated) - text: az dms show --name myservice --resource-group myresourcegroup - crafted: true -""" - 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. @@ -3606,15 +2663,6 @@ crafted: true """ -aladdin_helps['eventgrid domain delete'] = """ -type: command -short-summary: Delete a domain. -examples: - - name: Delete a domain. (autogenerated) - text: az eventgrid domain delete --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1 - crafted: true -""" - aladdin_helps['eventgrid domain key list'] = """ type: command short-summary: List shared access keys of a domain. @@ -3633,12 +2681,12 @@ crafted: true """ -aladdin_helps['eventgrid topic delete'] = """ +aladdin_helps['eventgrid partner namespace key list'] = """ type: command -short-summary: Delete a topic. +short-summary: List shared access keys of a partner namespace. examples: - - name: Delete a topic. (autogenerated) - text: az eventgrid topic delete --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 + - name: List shared access keys of a partner namespace (autogenerated) + text: az eventgrid partner namespace key list --partner-namespace-name MyNamespace --resource-group MyResourceGroup crafted: true """ @@ -3651,15 +2699,6 @@ crafted: true """ -aladdin_helps['eventgrid topic key regenerate'] = """ -type: command -short-summary: Regenerate a shared access key of a topic. -examples: - - name: Regenerate a shared access key of a topic (autogenerated) - text: az eventgrid topic key regenerate --key-name mykey --name mytopic --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['eventhubs eventhub update'] = """ type: command short-summary: Updates the EventHubs Eventhub @@ -3681,15 +2720,6 @@ crafted: true """ -aladdin_helps['eventhubs namespace authorization-rule keys renew'] = """ -type: command -short-summary: Regenerate the connection strings of Authorizationrule for the namespace. -examples: - - name: Regenerate the connection strings of Authorizationrule for the namespace. (autogenerated) - text: az eventhubs namespace authorization-rule keys renew --key PrimaryKey --name myauthorule --namespace-name mynamespace --resource-group myresourcegroup --subscription mysubscription - crafted: true -""" - aladdin_helps['eventhubs namespace exists'] = """ type: command short-summary: check for the availability of the given name for the Namespace @@ -3730,38 +2760,15 @@ -aladdin_helps['hdinsight monitor show'] = """ -type: command -short-summary: Get the status of Azure Monitor logs integration on an HDInsight cluster. -examples: - - name: Get the status of Azure Monitor logs integration on an HDInsight cluster. (autogenerated) - text: az hdinsight monitor show --name mycluster --resource-group myresourcegroup - crafted: true -""" -aladdin_helps['iot central app delete'] = """ -type: command -short-summary: Delete an IoT Central application. -examples: - - name: Delete an IoT Central application. (autogenerated) - text: az iot central app delete --name my-first-iot-app --resource-group MyResourceGroup --subscription mysubscription - crafted: true -""" -aladdin_helps['iot dps access-policy show'] = """ -type: command -short-summary: Show details of a shared access policies in an Azure IoT Hub device provisioning service. -examples: - - name: Show details of a shared access policies in an Azure IoT Hub device provisioning service (autogenerated) - text: az iot dps access-policy show --access-policy-name MyPolicy --dps-name MyDps --resource-group MyResourceGroup --subscription mysubscription - crafted: true -""" + 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 @@ -3808,15 +2815,6 @@ crafted: true """ -aladdin_helps['iot hub consumer-group delete'] = """ -type: command -short-summary: Delete an event hub consumer group. -examples: - - name: Delete an event hub consumer group. (autogenerated) - text: az iot hub consumer-group delete --hub-name myhub --name myeventhubconsumergroup - crafted: true -""" - aladdin_helps['iot hub consumer-group list'] = """ type: command short-summary: List event hub consumer groups. @@ -3844,67 +2842,30 @@ crafted: true """ -aladdin_helps['iot hub job cancel'] = """ +aladdin_helps['iot hub list-skus'] = """ type: command -short-summary: Cancel a job in an IoT hub. +short-summary: List available pricing tiers. examples: - - name: Cancel a job in an IoT hub. (autogenerated) - text: az iot hub job cancel --hub-name MyHub --job-id JobId + - name: List available pricing tiers. (autogenerated) + text: az iot hub list-skus --name MyIoTHub crafted: true """ -aladdin_helps['iot hub job list'] = """ +aladdin_helps['iot hub policy delete'] = """ type: command -short-summary: List the jobs in an IoT hub. +short-summary: Delete a shared access policy from an IoT hub. examples: - - name: List the jobs in an IoT hub. (autogenerated) - text: az iot hub job list --hub-name MyHub + - name: Delete a shared access policy from an IoT hub. (autogenerated) + text: az iot hub policy delete --hub-name MyHub --name MySharedAccessPolicy crafted: true """ -aladdin_helps['iot hub job show'] = """ +aladdin_helps['iot hub policy list'] = """ type: command -short-summary: Get the details of a job in an IoT hub. +short-summary: List shared access policies of an IoT hub. examples: - - name: Get the details of a job in an IoT hub. (autogenerated) - text: az iot hub job show --hub-name MyHub --job-id JobId - crafted: true -""" - -aladdin_helps['iot hub list-skus'] = """ -type: command -short-summary: List available pricing tiers. -examples: - - name: List available pricing tiers. (autogenerated) - text: az iot hub list-skus --name MyIoTHub - crafted: true -""" - -aladdin_helps['iot hub message-enrichment delete'] = """ -type: command -short-summary: Delete a message enrichment in your IoT hub (by key) -long-summary: Delete a message enrichment in your IoT hub (by key) -examples: - - name: Delete a message enrichment in your IoT hub (by key). (autogenerated) - text: az iot hub message-enrichment delete --key test --name new-policy --resource-group myresourcegroup --subscription mysubscription - crafted: true -""" - -aladdin_helps['iot hub policy delete'] = """ -type: command -short-summary: Delete a shared access policy from an IoT hub. -examples: - - name: Delete a shared access policy from an IoT hub. (autogenerated) - text: az iot hub policy delete --hub-name MyHub --name MySharedAccessPolicy - crafted: true -""" - -aladdin_helps['iot hub policy list'] = """ -type: command -short-summary: List shared access policies of an IoT hub. -examples: - - name: List shared access policies of an IoT hub. (autogenerated) - text: az iot hub policy list --hub-name MyHub --resource-group MyResourceGroup + - name: List shared access policies of an IoT hub. (autogenerated) + text: az iot hub policy list --hub-name MyHub --resource-group MyResourceGroup crafted: true """ @@ -3926,16 +2887,6 @@ crafted: true """ -aladdin_helps['iot hub route update'] = """ -type: command -short-summary: Update a route in IoT Hub. -long-summary: Updates a route in IoT Hub. You can change the source, enpoint or query on the route. -examples: - - name: Update a route in IoT Hub (autogenerated) - text: az iot hub route update --condition true --enabled true --endpoint-name myendpoint --hub-name MyIotHub --resource-group MyResourceGroup --route-name R1 --source-type invalid - crafted: true -""" - aladdin_helps['iot hub show'] = """ type: command short-summary: Get the details of an IoT hub. @@ -3985,30 +2936,20 @@ crafted: true """ -aladdin_helps['iotcentral app delete'] = """ -type: command -short-summary: Delete an IoT Central application. -examples: - - name: Delete an IoT Central application. (autogenerated) - text: az iotcentral app delete --name MyIoTCentralApplication --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['keyvault create'] = """ type: command -short-summary: Create a key vault. +short-summary: Create a Vault or HSM. long-summary: If `--enable-rbac-authorization` is not specified, then default permissions are created for the current user or service principal unless the `--no-self-perms` flag is specified. examples: - name: Create a key vault. (autogenerated) text: | az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup crafted: true - """ aladdin_helps['keyvault delete'] = """ type: command -short-summary: Delete a key vault. +short-summary: Delete a Vault or HSM. examples: - name: Delete a key vault. (autogenerated) text: | @@ -4018,8 +2959,8 @@ aladdin_helps['keyvault recover'] = """ type: command -short-summary: Recover a key vault. -long-summary: Recovers a previously deleted key vault for which soft delete was enabled. +short-summary: Recover a Vault or HSM. +long-summary: Recover a previously deleted Vault or HSM for which soft delete was enabled. examples: - name: Recover a key vault. (autogenerated) text: | @@ -4029,7 +2970,7 @@ aladdin_helps['keyvault show'] = """ type: command -short-summary: Show details of a key vault. +short-summary: Show details of a Vault or HSM. examples: - name: Show details of a key vault. (autogenerated) text: | @@ -4042,20 +2983,35 @@ short-summary: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions. This operation requires the storage/delete permission. examples: - name: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions (autogenerated) - text: az keyvault storage remove --name MyStorageAccount --vault-name MyVault + text: | + az keyvault storage remove --id "/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-00000000000000000" + crafted: true + - name: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions (autogenerated) + text: | + az keyvault storage remove --name MyStorageAccount --vault-name MyVault crafted: true """ aladdin_helps['keyvault update'] = """ type: command -short-summary: Update the properties of a key vault. +short-summary: Update the properties of a Vault. examples: - - name: Update the properties of a key vault. (autogenerated) + - name: Update the properties of a Vault. (autogenerated) text: | az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup crafted: true """ +aladdin_helps['keyvault update-hsm'] = """ +type: command +short-summary: Update the properties of a HSM. +examples: + - name: Update the properties of a HSM. + text: | + az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup + crafted: true +""" + aladdin_helps['kusto cluster list'] = """ type: command short-summary: List a Kusto cluster. @@ -4177,46 +3133,6 @@ -aladdin_helps['maps account create'] = """ -type: command -short-summary: Create a maps account. -parameters: - - name: --accept-tos - short-summary: Accept the Terms of Service, and do not prompt for confirmation. - long-summary: | - By creating an Azure Maps account, you agree that you have read and agree to the - License (https://azure.microsoft.com/support/legal/) and - Privacy Statement (https://privacy.microsoft.com/privacystatement). - -examples: - - name: Create a maps account. (autogenerated) - text: az maps account create --name MyMapsAccount --resource-group MyResourceGroup --sku S0 --subscription MySubscription - crafted: true - - name: Create a maps account. (autogenerated) - text: az maps account create --accept-tos --name MyMapsAccount --resource-group MyResourceGroup --sku S0 - crafted: true -""" - -aladdin_helps['maps account delete'] = """ -type: command -short-summary: Delete a maps account. -examples: - - name: Delete a maps account. (autogenerated) - text: az maps account delete --name MyMapsAccount --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['maps account keys list'] = """ -type: command -short-summary: List the keys to use with the Maps APIs. -long-summary: | - A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration. -examples: - - name: List the keys to use with the Maps APIs (autogenerated) - text: az maps account keys list --name MyMapsAccount --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['maps account show'] = """ type: command short-summary: Show the details of a maps account. @@ -4226,14 +3142,7 @@ crafted: true """ -aladdin_helps['maps account update'] = """ -type: command -short-summary: Update the properties of a maps account. -examples: - - name: Update the properties of a maps account. (autogenerated) - text: az maps account update --name mymapsaccount --resource-group myresourcegroup - crafted: true -""" + aladdin_helps['monitor action-group create'] = """ type: command @@ -4273,6 +3182,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. @@ -4335,6 +3247,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. @@ -4347,20 +3262,6 @@ crafted: true """ -aladdin_helps['monitor activity-log alert action-group remove'] = """ -type: command -short-summary: Remove action groups from this activity log alert -parameters: - - name: --name -n - short-summary: Name of the activity log alerts - - name: --action-group -a - short-summary: The names or the resource ids of the action groups to be added. -examples: - - name: Remove action groups from this activity log alert. (autogenerated) - text: az monitor activity-log alert action-group remove --action-group /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/microsoft.insights/actionGroups/{ActionGroup} --name myactivitylogalerts --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['monitor activity-log alert scope add'] = """ type: command short-summary: Add scopes to this activity log alert. @@ -4394,6 +3295,10 @@ text: | az monitor activity-log alert update --enabled true --name MyActivityLogAlerts --resource-group MyResourceGroup --subscription MySubscription crafted: true + - name: Update the details of this activity log alert. (autogenerated) + text: | + az monitor activity-log alert update --name MyActivityLogAlerts --resource-group MyResourceGroup --tags key=value + crafted: true """ aladdin_helps['monitor alert delete'] = """ @@ -4569,15 +3474,6 @@ crafted: true """ -aladdin_helps['monitor autoscale profile show'] = """ -type: command -short-summary: Show details of an autoscale profile. -examples: - - name: Show details of an autoscale profile. (autogenerated) - text: az monitor autoscale profile show --autoscale-name myautoscale --name myautoscaleprofile --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['monitor autoscale rule list'] = """ type: command short-summary: List autoscale rules for a profile. @@ -4651,7 +3547,7 @@ examples: - name: Delete a workspace instance. (autogenerated) text: | - az monitor log-analytics workspace delete --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace delete --force true --resource-group MyResourceGroup --workspace-name MyWorkspace crafted: true """ @@ -4660,7 +3556,7 @@ 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/en-us/rest/api/loganalytics/workspaces%202015-03-20/getschema + For more information, visit: https://docs.microsoft.com/rest/api/loganalytics/workspaces%202015-03-20/getschema examples: - name: Get the schema for a given workspace. (autogenerated) text: | @@ -4678,12 +3574,23 @@ crafted: true """ -aladdin_helps['monitor log-analytics workspace linked-service delete'] = """ +aladdin_helps['monitor log-analytics workspace linked-storage create'] = """ +type: command +short-summary: Create some linked storage accounts for log analytics workspace. +examples: + - name: Create some linked storage accounts for log analytics workspace. (autogenerated) + text: | + az monitor log-analytics workspace linked-storage create --resource-group MyResourceGroup --storage-accounts /subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.Storage/storageAccounts/cli000001 --subscription mysubscription --type CustomLogs --workspace-name MyWorkspace + crafted: true +""" + +aladdin_helps['monitor log-analytics workspace linked-storage list'] = """ type: command -short-summary: Delete a linked service. +short-summary: List all linked storage accounts for a log analytics workspace. examples: - - name: Delete a linked service. (autogenerated) - text: az monitor log-analytics workspace linked-service delete --name cluster --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace + - name: List all linked storage accounts for a log analytics workspace. (autogenerated) + text: | + az monitor log-analytics workspace linked-storage list --resource-group MyResourceGroup --workspace-name MyWorkspace crafted: true """ @@ -4693,7 +3600,7 @@ examples: - name: Get a list of management groups connected to a workspace. (autogenerated) text: | - az monitor log-analytics workspace list-management-groups --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace list-management-groups --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace crafted: true """ @@ -4713,7 +3620,7 @@ examples: - name: Enable an intelligence pack for a given workspace. (autogenerated) text: | - az monitor log-analytics workspace pack enable --name MyIntelligencePack --resource-group MyResourceGroup --workspace-name MyWorkspace + az monitor log-analytics workspace pack enable --name MyIntelligencePack --resource-group MyResourceGroup --subscription mysubscription --workspace-name MyWorkspace crafted: true """ @@ -4742,7 +3649,8 @@ short-summary: Update a workspace instance examples: - name: Update a workspace instance. (autogenerated) - text: az monitor log-analytics workspace update --resource-group myresourcegroup --retention-time 30 --workspace-name myworkspace + text: | + az monitor log-analytics workspace update --resource-group myresourcegroup --retention-time 30 --workspace-name myworkspace crafted: true """ @@ -4811,153 +3719,96 @@ crafted: true """ -aladdin_helps['monitor metrics alert update'] = """ +aladdin_helps['monitor metrics list-definitions'] = """ type: command -short-summary: Update a metric-based alert rule. +short-summary: List the metric definitions for the resource. parameters: - - name: --add-condition - short-summary: Add a condition which triggers the rule. - long-summary: | - Usage: --add-condition {avg,min,max,total,count} [NAMESPACE.]METRIC {=,!=,>,>=,<,<=} THRESHOLD - [where DIMENSION {includes,excludes} VALUE [or VALUE ...] - [and DIMENSION {includes,excludes} VALUE [or VALUE ...] ...]] - - Dimensions can be queried by adding the 'where' keyword and multiple dimensions can be queried by combining them with the 'and' keyword. - - Values for METRIC, DIMENSION and appropriate THRESHOLD values can be obtained from `az monitor metrics list-definitions` command. - - Due to server limitation, when an alert rule contains multiple criterias, the use of dimensions is limited to one value per dimension within each criterion. - - Multiple conditions can be specified by using more than one `--condition` argument. - - name: --remove-conditions - short-summary: Space-separated list of condition names to remove. - - name: --add-action - short-summary: Add an action group and optional webhook properties to fire when the alert is triggered. - long-summary: | - Usage: --add-action ACTION_GROUP_NAME_OR_ID [KEY=VAL [KEY=VAL ...]] - - Multiple action groups can be specified by using more than one `--action` argument. - - name: --remove-actions - short-summary: Space-separated list of action group names to remove. + - name: --namespace + short-summary: Namespace to query metric definitions for. + populator-commands: + - az monitor metrics list-namespaces examples: - - name: Update a metric-based alert rule. (autogenerated) + - name: List the metric definitions for the resource. (autogenerated) text: | - az monitor metrics alert update --enabled true --name MyAlertRule --resource-group MyResourceGroup + az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/Microsoft.Network/networkSecurityGroups/{resourceName} crafted: true """ -aladdin_helps['monitor metrics list-definitions'] = """ +aladdin_helps['monitor private-link-scope create'] = """ type: command -short-summary: Lists the metric definitions for the resource. +short-summary: Create a private link scope resource. examples: - - name: Lists the metric definitions for the resource. (autogenerated) + - name: Create a private link scope resource (autogenerated) text: | - az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/Space1999/providers/Microsoft.Network/networkSecurityGroups/ADDS-NSG + az monitor private-link-scope create --name MyAzureMonitorPrivateLinkScope --resource-group MyResourceRroup crafted: true """ -aladdin_helps['monitor private-link-scope create'] = """ +aladdin_helps['monitor private-link-scope private-endpoint-connection approve'] = """ type: command -short-summary: Create a private link scope resource. +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: Create a private link scope resource - text: az monitor private-link-scope create -g MyRG -n MyScope + - 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 a private link scope resource. (autogenerated) - text: az monitor private-link-scope create --name myazuremonitorprivatelinkscope --resource-group myresourcegroup + - 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 delete'] = """ +aladdin_helps['monitor private-link-scope private-endpoint-connection reject'] = """ type: command -short-summary: Delete a monitor private link scope resource. +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: Delete a monitor private link scope resource. (autogenerated) - text: az monitor private-link-scope delete --name myazuremonitorprivatelinkscope --resource-group myresourcegroup --yes + - 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['monitor private-link-scope scoped-resource delete'] = """ -type: command -short-summary: Delete a scoped resource of a private link scope resource. -examples: - - name: Delete a scoped resource of a private link scope resource. (autogenerated) - text: az monitor private-link-scope scoped-resource delete --name myassignedresource --resource-group myresourcegroup --scope-name myscope - crafted: true -""" -aladdin_helps['monitor private-link-scope scoped-resource list'] = """ -type: command -short-summary: List all scoped resource of a private link scope resource. -examples: - - name: List all scoped resource of a private link scope resource. (autogenerated) - text: az monitor private-link-scope scoped-resource list --resource-group myresourcegroup --scope-name myscope - crafted: true -""" -aladdin_helps['monitor private-link-scope show'] = """ -type: command -short-summary: Show a monitor private link scope resource. -examples: - - name: Show a monitor private link scope resource. (autogenerated) - text: az monitor private-link-scope show --name myazuremonitorprivatelinkscope --resource-group myresourcegroup - crafted: true -""" -aladdin_helps['network nat gateway update'] = """ -type: command -short-summary: Update a NAT gateway. -examples: - - name: Update a NAT gateway. (autogenerated) - text: az network nat gateway update --name MyNatGateway --public-ip-addresses MyPublicIp --resource-group MyResourceGroup - crafted: true -""" -aladdin_helps['netappfiles pool update'] = """ +aladdin_helps['network application-gateway create'] = """ type: command -short-summary: Update the tags of the specified ANF pool. +short-summary: Create an application gateway. parameters: - - name: --account-name -a - short-summary: The name of the ANF account - - name: --name --pool-name -n -p - short-summary: The name of the ANF pool - - name: --size - short-summary: The size for the ANF pool. Must be an integer number of tebibytes in multiples of 4 - - name: --service-level - short-summary: The service level for the ANF pool - - name: --tags - short-summary: Space-separated tags in `key[=value]` format -examples: - - name: Update the tags of the specified ANF pool. (autogenerated) - text: az netappfiles pool update --account-name myaccname --pool-name mypoolname --resource-group mygroup --size 8 - crafted: true -""" + - name: --trusted-client-cert + short-summary: The application gateway trusted client certificate. + long-summary: | + Usage: --trusted-client-certificates name=client1 data=client.cer -aladdin_helps['netappfiles volume update'] = """ -type: command -short-summary: Update the specified ANF volume with the values provided. Unspecified values will remain unchanged. Export policies are amended/created with the subgroup commands -parameters: - - name: --account-name -a - short-summary: The name of the ANF account - - name: --pool-name -p - short-summary: The name of the ANF pool - - name: --name --volume-name -n -v - short-summary: The name of the ANF volume - - name: --service-level - short-summary: The service level - - name: --usage-threshold - short-summary: The maximum storage quota allowed for a file system as integer number of GiB. Min 100 GiB, max 100TiB" - - name: --tags - short-summary: Space-separated tags in `key[=value]` format -examples: - - name: Update the specified ANF volume with the values provided (autogenerated) - text: az netappfiles volume update --account-name myaccname --pool-name mypoolname --protocol-types NFSv3 NFSv4.1 --resource-group mygroup --volume-name myvolname - crafted: true -""" + name: Required. Name of the trusted client certificate that is unique within an Application Gateway + data: Required. Certificate public data. -aladdin_helps['network application-gateway create'] = """ -type: command -short-summary: Create an application gateway. + 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: | @@ -4985,15 +3836,6 @@ crafted: true """ -aladdin_helps['network application-gateway http-listener update'] = """ -type: command -short-summary: Update an HTTP listener. -examples: - - name: Update an HTTP listener. (autogenerated) - text: az network application-gateway http-listener update --gateway-name MyAppGateway --host-names www.mynewhost.com --name MyHttpListener --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['network application-gateway http-settings create'] = """ type: command short-summary: Create HTTP settings. @@ -5002,9 +3844,6 @@ 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 - - name: Create HTTP settings. (autogenerated) - text: az network application-gateway http-settings create --cookie-based-affinity Enabled --gateway-name MyAppGateway --name MyHttpSettings --port 80 --probe MyNewProbe --protocol Http --resource-group MyResourceGroup --timeout 30 - crafted: true """ aladdin_helps['network application-gateway http-settings update'] = """ @@ -5016,7 +3855,8 @@ 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 + 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 """ @@ -5030,6 +3870,16 @@ 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. @@ -5055,7 +3905,8 @@ 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 + text: | + az network application-gateway rewrite-rule delete --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet crafted: true """ @@ -5079,15 +3930,6 @@ crafted: true """ -aladdin_helps['network application-gateway rewrite-rule set delete'] = """ -short-summary: Delete a rewrite rule set. -type: command -examples: - - name: Delete a rewrite rule set. (autogenerated) - text: az network application-gateway rewrite-rule set delete --gateway-name mygateway --name myrewriteruleset --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['network application-gateway rewrite-rule set list'] = """ short-summary: List rewrite rule sets. type: command @@ -5113,7 +3955,8 @@ type: command examples: - name: Update a rewrite rule set. (autogenerated) - text: az network application-gateway rewrite-rule set update --gateway-name MyGateway --name MyRewriteRuleSet --resource-group MyResourceGroup + text: | + az network application-gateway rewrite-rule set update --gateway-name MyGateway --name MyRewriteRuleSet --resource-group MyResourceGroup crafted: true """ @@ -5127,6 +3970,23 @@ crafted: true """ +aladdin_helps['network application-gateway rewrite-rule update'] = """ +short-summary: Update a rewrite rule. +type: command +parameters: + - name: --request-headers + populator-commands: + - az network application-gateway rewrite-rule list-request-headers + - name: --response-headers + populator-commands: + - az network application-gateway rewrite-rule list-response-headers +examples: + - name: Update a rewrite rule. (autogenerated) + text: | + az network application-gateway rewrite-rule update --gateway-name MyGateway --name MyRewriteRule --remove tags.no_80 --resource-group MyResourceGroup --rule-set-name MyRuleSet + crafted: true +""" + aladdin_helps['network application-gateway root-cert create'] = """ type: command short-summary: Upload a trusted root certificate. @@ -5142,7 +4002,8 @@ short-summary: Update a trusted root certificate. examples: - name: Update a trusted root certificate. (autogenerated) - text: az network application-gateway root-cert update --cert-file /path/to/cert/file --gateway-name MyGateway --name MyTrustedRootCertificate --resource-group MyResourceGroup + text: | + az network application-gateway root-cert update --cert-file /path/to/cert/file --gateway-name MyGateway --name MyTrustedRootCertificate --resource-group MyResourceGroup crafted: true """ @@ -5162,7 +4023,7 @@ 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 """ @@ -5172,7 +4033,7 @@ examples: - name: Update a URL path map. (autogenerated) text: | - az network application-gateway url-path-map update --default-address-pool MyAddressPool --default-http-settings MyNewHttpSettings --gateway-name MyAppGateway --name MyUrlPathMap --resource-group MyResourceGroup + az network application-gateway url-path-map update --default-address-pool MyAddressPool --default-http-settings MyNewHttpSettings --gateway-name MyAppGateway --name MyUrlPathMap --remove tags.no_80 --resource-group MyResourceGroup crafted: true """ @@ -5191,7 +4052,8 @@ short-summary: Create an application gateway WAF policy custom rule. examples: - name: Create an application gateway WAF policy custom rule. (autogenerated) - text: az network application-gateway waf-policy custom-rule create --action Allow --name mywafpolicyrule --policy-name mypolicy --priority 500 --resource-group myresourcegroup --rule-type MatchRule + text: | + az network application-gateway waf-policy custom-rule create --action Allow --name MyWafPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule crafted: true """ @@ -5200,7 +4062,8 @@ short-summary: Delete an application gateway WAF policy custom rule. examples: - name: Delete an application gateway WAF policy custom rule. (autogenerated) - text: az network application-gateway waf-policy custom-rule delete --name mywafpolicyrule --policy-name mypolicy --resource-group myresourcegroup + text: | + az network application-gateway waf-policy custom-rule delete --name MyWafPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -5242,6 +4105,10 @@ text: | az network application-gateway waf-policy custom-rule update --name MyWAFPolicyRule --policy-name MyPolicy --resource-group MyResourceGroup --set useRemoteGateways=true crafted: true + - name: Update an application gateway WAF policy custom rule. (autogenerated) + text: | + az network application-gateway waf-policy custom-rule update --action Allow --name MyWAFPolicyRule --policy-name MyPolicy --priority 500 --resource-group MyResourceGroup --rule-type MatchRule + crafted: true """ aladdin_helps['network application-gateway waf-policy delete'] = """ @@ -5268,10 +4135,11 @@ 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/en-us/azure/web-application-firewall/ag/application-gateway-crs-rulegroups-rules + https://docs.microsoft.com/azure/web-application-firewall/ag/application-gateway-crs-rulegroups-rules examples: - - name: Add managed rule set to the WAF policy managed rules (commonly used with --output). (autogenerated) - text: az network application-gateway waf-policy managed-rule rule-set add --policy-name MyPolicy --resource-group MyResourceGroup --type Microsoft_BotManagerRuleSet --version 0.1 + - name: Add managed rule set to the WAF policy managed rules (autogenerated) + text: | + az network application-gateway waf-policy managed-rule rule-set add --policy-name MyPolicy --resource-group MyResourceGroup --type Microsoft_BotManagerRuleSet --version 0.1 crafted: true """ @@ -5280,18 +4148,8 @@ short-summary: List all managed rule set. examples: - name: List all managed rule set. (autogenerated) - text: az network application-gateway waf-policy managed-rule rule-set list --policy-name MyPolicy --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['network application-gateway waf-policy managed-rule rule-set update'] = """ -type: command -short-summary: > - Update(Override) existing rule set of a WAF policy managed rules. For rule set and rules, please visit: - https://docs.microsoft.com/en-us/azure/web-application-firewall/ag/application-gateway-crs-rulegroups-rules -examples: - - name: Override rules under rule group EQUEST-921-PROTOCOL-ATTACK (autogenerated) - text: az network application-gateway waf-policy managed-rule rule-set update --group-name REQUEST-921-PROTOCOL-ATTACK --policy-name MyPolicy --resource-group MyResourceGroup --rules 921130 921160 --type Microsoft_BotManagerRuleSet --version 0.1 + text: | + az network application-gateway waf-policy managed-rule rule-set list --policy-name MyPolicy --resource-group MyResourceGroup crafted: true """ @@ -5310,7 +4168,8 @@ short-summary: Update properties of a web application firewall global configuration. examples: - name: Update properties of a web application firewall global configuration. (autogenerated) - text: az network application-gateway waf-policy policy-setting update --mode Prevention --policy-name MyPolicy --resource-group MyResourceGroup --state Disabled + text: | + az network application-gateway waf-policy policy-setting update --mode Prevention --policy-name MyPolicy --resource-group MyResourceGroup --state Disabled crafted: true """ @@ -5332,14 +4191,9 @@ text: | az network application-gateway waf-policy update --add communities='12076:5010' --name MyApplicationGatewayWAFPolicy --resource-group MyResourceGroup crafted: true -""" - -aladdin_helps['network asg delete'] = """ -type: command -short-summary: Delete an application security group. -examples: - - name: Delete an application security group. (autogenerated) - text: az network asg delete --name MyAsg --resource-group MyResourceGroup --subscription mysubscription + - 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 """ @@ -5348,7 +4202,8 @@ 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 + text: | + az network bastion create --location westus2 --name MyBastionHost --public-ip-address MyPublicIpAddress --resource-group MyResourceGroup --vnet-name MyVnet crafted: true """ @@ -5357,7 +4212,8 @@ 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 + text: | + az network bastion delete --name MyBastionHost --resource-group MyResourceGroup crafted: true """ @@ -5365,8 +4221,9 @@ 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 + - name: Show a Azure bastion host machine. + text: | + az network bastion show --name MyBastionHost --resource-group MyResourceGroup crafted: true """ @@ -5384,9 +4241,6 @@ text: | az network ddos-protection create --location westus2 --name MyDdosPlan --resource-group MyResourceGroup crafted: true - - name: Create a DDoS protection plan. (autogenerated) - text: az network ddos-protection create --name MyDdosPlan --resource-group MyResourceGroup --vnets MyVnet - crafted: true """ aladdin_helps['network ddos-protection update'] = """ @@ -5475,6 +4329,16 @@ crafted: true """ +aladdin_helps['network dns record-set mx list'] = """ +type: command +short-summary: List all MX record sets in a zone. +examples: + - name: List all MX record sets in a zone (autogenerated) + text: | + az network dns record-set mx list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + crafted: true +""" + aladdin_helps['network dns record-set mx update'] = """ type: command short-summary: Update an MX record set. @@ -5493,9 +4357,6 @@ text: | az network dns record-set ns create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com crafted: true - - name: Create an empty NS record set (autogenerated) - text: az network dns record-set ns create --name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --zone-name www.mysite.com - crafted: true """ aladdin_helps['network dns record-set ns delete'] = """ @@ -5503,16 +4364,21 @@ short-summary: Delete an NS record set and all associated records. examples: - name: Delete an NS record set and all associated records. (autogenerated) - text: az network dns record-set ns delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com + text: | + az network dns record-set ns delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set ns show'] = """ +aladdin_helps['network dns record-set ns remove-record'] = """ type: command -short-summary: Get the details of an NS record set. +short-summary: Remove an NS record from its record set. +long-summary: > + By default, if the last record in a set is removed, the record set is deleted. + To retain the empty record set, include --keep-empty-record-set. examples: - - name: Get the details of an NS record set. (autogenerated) - text: az network dns record-set ns show --name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --zone-name www.mysite.com + - name: Remove an NS record from its record set. (autogenerated) + text: | + az network dns record-set ns remove-record --keep-empty-record-set --nsdname ns.mysite.com --record-set-name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ @@ -5526,82 +4392,106 @@ crafted: true """ -aladdin_helps['network dns record-set ptr list'] = """ +aladdin_helps['network dns record-set ptr create'] = """ type: command -short-summary: List all PTR record sets in a zone. +short-summary: Create an empty PTR record set. examples: - - name: List all PTR record sets in a zone. (autogenerated) + - name: Create an empty PTR record set. (autogenerated) text: | - az network dns record-set ptr list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + az network dns record-set ptr create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set srv create'] = """ +aladdin_helps['network dns record-set ptr delete'] = """ type: command -short-summary: Create an empty SRV record set. +short-summary: Delete a PTR record set and all associated records. examples: - - name: Create an empty SRV record set. (autogenerated) - text: az network dns record-set srv create --metadata owner=WebTeam --name MyRecordSet --resource-group MyResourceGroup --zone-name www.mysite.com + - name: Delete a PTR record set and all associated records. (autogenerated) + text: | + az network dns record-set ptr delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set txt create'] = """ +aladdin_helps['network dns record-set ptr list'] = """ type: command -short-summary: Create an empty TXT record set. +short-summary: List all PTR record sets in a zone. examples: - - name: Create an empty TXT record set. (autogenerated) + - name: List all PTR record sets in a zone. (autogenerated) text: | - az network dns record-set txt create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + az network dns record-set ptr list --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set txt remove-record'] = """ +aladdin_helps['network dns record-set soa show'] = """ type: command -short-summary: Remove a TXT record from its record set. -long-summary: > - By default, if the last record in a set is removed, the record set is deleted. - To retain the empty record set, include --keep-empty-record-set. +short-summary: Get the details of an SOA record. examples: - - name: Remove a TXT record from its record set. (autogenerated) - text: az network dns record-set txt remove-record --keep-empty-record-set --record-set-name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --value Owner=WebTeam --zone-name www.mysite.com + - name: Get the details of an SOA record (autogenerated) + text: | + az network dns record-set soa show --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set txt show'] = """ +aladdin_helps['network dns record-set soa update'] = """ type: command -short-summary: Get the details of a TXT record set. +short-summary: Update properties of an SOA record. examples: - - name: Get the details of a TXT record set. (autogenerated) + - name: Update properties of an SOA record. (autogenerated) text: | - az network dns record-set txt show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com + az network dns record-set soa update --email myhostmaster.mysite.com --only-show-errors --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network dns record-set txt update'] = """ +aladdin_helps['network dns record-set srv create'] = """ type: command -short-summary: Update a TXT record set. +short-summary: Create an empty SRV record set. examples: - - name: Update a TXT record set. (autogenerated) + - name: Create an empty SRV record set. (autogenerated) text: | - az network dns record-set txt update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com + az network dns record-set srv create --metadata owner=WebTeam --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + crafted: true +""" + +aladdin_helps['network dns record-set txt create'] = """ +type: command +short-summary: Create an empty TXT record set. +examples: + - name: Create an empty TXT record set. (autogenerated) + text: | + az network dns record-set txt create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com + crafted: true +""" + +aladdin_helps['network dns record-set txt show'] = """ +type: command +short-summary: Get the details of a TXT record set. +examples: + - name: Get the details of a TXT record set. (autogenerated) + text: | + az network dns record-set txt show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network express-route auth create'] = """ +aladdin_helps['network dns record-set txt update'] = """ type: command -short-summary: Create a new link authorization for an ExpressRoute circuit. +short-summary: Update a TXT record set. examples: - - name: Create a new link authorization for an ExpressRoute circuit. (autogenerated) - text: az network express-route auth create --circuit-name MyCircuit --name MyAuthorization --resource-group MyResourceGroup --subscription mysubscription + - name: Update a TXT record set. (autogenerated) + text: | + az network dns record-set txt update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com crafted: true """ -aladdin_helps['network express-route auth delete'] = """ +aladdin_helps['network dns zone update'] = """ type: command -short-summary: Delete a link authorization of an ExpressRoute circuit. +short-summary: Update a DNS zone properties. Does not modify DNS records within the zone. +parameters: + - name: --if-match + short-summary: Update only if the resource with the same ETAG exists. examples: - - name: Delete a link authorization of an ExpressRoute circuit. (autogenerated) - text: az network express-route auth delete --circuit-name MyCircuit --name MyAuthorization --resource-group MyResourceGroup --subscription mysubscription + - name: Update a DNS zone properties (autogenerated) + text: | + az network dns zone update --name www.mysite.com --remove tags.no_80 --resource-group MyResourceGroup crafted: true """ @@ -5615,6 +4505,26 @@ crafted: true """ +aladdin_helps['network express-route delete'] = """ +type: command +short-summary: Delete an ExpressRoute circuit. +examples: + - name: Delete an ExpressRoute circuit. (autogenerated) + text: | + az network express-route delete --name MyCircuit --resource-group MyResourceGroup --subscription MySubscription + crafted: true +""" + +aladdin_helps['network express-route gateway connection create'] = """ +type: command +short-summary: Create an ExpressRoute gateway connection. +examples: + - name: Create an ExpressRoute gateway connection. (autogenerated) + text: | + az network express-route gateway connection create --gateway-name MyGateway --name MyExpressRouteConnection --peering /subscriptions/MySub/resourceGroups/MyResourceGroup/providers/Microsoft.Network/expressRouteCircuits/MyCircuit/peerings/AzurePrivatePeering --resource-group MyResourceGroup + crafted: true +""" + aladdin_helps['network express-route gateway connection delete'] = """ type: command short-summary: Delete an ExpressRoute gateway connection. @@ -5655,6 +4565,16 @@ crafted: true """ +aladdin_helps['network express-route gateway list'] = """ +type: command +short-summary: List ExpressRoute gateways. +examples: + - name: List ExpressRoute gateways. (autogenerated) + text: | + az network express-route gateway list --resource-group MyResourceGroup + crafted: true +""" + aladdin_helps['network express-route gateway show'] = """ type: command short-summary: Get the details of an ExpressRoute gateway. @@ -5675,6 +4595,26 @@ crafted: true """ +aladdin_helps['network express-route peering create'] = """ +type: command +short-summary: Create peering settings for an ExpressRoute circuit. +examples: + - name: Create peering settings for an ExpressRoute circuit. (autogenerated) + text: | + az network express-route peering create --circuit-name MyCircuit --peer-asn 10002 --peering-type AzurePublicPeering --primary-peer-subnet 101.0.0.0/30 --resource-group MyResourceGroup --secondary-peer-subnet 102.0.0.0/30 --shared-key Abc123 --vlan-id 103 + crafted: true +""" + +aladdin_helps['network express-route peering update'] = """ +type: command +short-summary: Update peering settings of an ExpressRoute circuit. +examples: + - name: Update peering settings of an ExpressRoute circuit. (autogenerated) + text: | + az network express-route peering update --circuit-name MyCircuit --name MyPeering --peer-asn 10002 --primary-peer-subnet 2002:db00::/126 --resource-group MyResourceGroup --secondary-peer-subnet 2003:db00::/126 --shared-key Abc123 --vlan-id 103 + crafted: true +""" + aladdin_helps['network express-route port create'] = """ type: command short-summary: Create an ExpressRoute port. @@ -5720,7 +4660,8 @@ short-summary: List ExpressRoute ports. examples: - name: List ExpressRoute ports. (autogenerated) - text: az network express-route port list --resource-group myresourcegroup + text: | + az network express-route port list --resource-group myresourcegroup crafted: true """ @@ -5754,15 +4695,6 @@ crafted: true """ -aladdin_helps['network express-route update'] = """ -type: command -short-summary: Update settings of an ExpressRoute circuit. -examples: - - name: Update settings of an ExpressRoute circuit. (autogenerated) - text: az network express-route update --allow-global-reach true --name MyCircuit --resource-group MyResourceGroup - crafted: true -""" - aladdin_helps['network lb frontend-ip show'] = """ type: command short-summary: Get the details of a frontend IP address. @@ -5796,7 +4728,8 @@ az network lb inbound-nat-pool update --enable-tcp-reset true --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup crafted: true - name: Update an inbound NAT address pool. (autogenerated) - text: az network lb inbound-nat-pool update --backend-port 8080 --floating-ip true --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup + text: | + az network lb inbound-nat-pool update --backend-port 8080 --floating-ip true --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --protocol Udp --resource-group MyResourceGroup crafted: true """ @@ -5859,7 +4792,8 @@ short-summary: Update an outbound-rule. examples: - name: Update an outbound-rule. (autogenerated) - text: az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup --subscription mysubscription + text: | + az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup crafted: true """ @@ -5868,7 +4802,8 @@ short-summary: Update a probe. examples: - name: Update a probe. (autogenerated) - text: az network lb probe update --lb-name MyLb --name MyProbe --port 81 --protocol Http --resource-group MyResourceGroup + text: | + az network lb probe update --lb-name MyLb --name MyProbe --port 81 --protocol Http --resource-group MyResourceGroup crafted: true """ @@ -5881,7 +4816,8 @@ az network lb rule update --disable-outbound-snat true --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup crafted: true - name: Update a load balancing rule. (autogenerated) - text: az network lb rule update --backend-pool-name mybackendpool --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup + text: | + az network lb rule update --idle-timeout 5 --lb-name MyLb --name MyLbRule --resource-group MyResourceGroup crafted: true """ @@ -5890,7 +4826,8 @@ 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 + text: | + az network list-service-aliases --location westus2 crafted: true """ @@ -5899,7 +4836,9 @@ 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/en-us/azure/virtual-network/security-overview#service-tags + 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: | @@ -6004,6 +4943,16 @@ crafted: true """ +aladdin_helps['network nic wait'] = """ +type: command +short-summary: Place the CLI in a waiting state until a condition of the network interface is met. +examples: + - name: Place the CLI in a waiting state until a condition of the network interface is met. (autogenerated) + text: | + az network nic wait --deleted --name MyNic --resource-group MyResourceGroup --subscription MySubscription + crafted: true +""" + aladdin_helps['network nsg rule update'] = """ type: command short-summary: Update a network security group rule. @@ -6041,7 +4990,8 @@ short-summary: Delete a private endpoint dns zone group. examples: - name: Delete a private endpoint dns zone group. (autogenerated) - text: az network private-endpoint dns-zone-group delete --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup + text: | + az network private-endpoint dns-zone-group delete --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup crafted: true """ @@ -6050,7 +5000,8 @@ short-summary: List all private endpoint dns zone groups. examples: - name: List all private endpoint dns zone groups. (autogenerated) - text: az network private-endpoint dns-zone-group list --endpoint-name MyEndpoint --resource-group MyResourceGroup + text: | + az network private-endpoint dns-zone-group list --endpoint-name MyEndpoint --resource-group MyResourceGroup crafted: true """ @@ -6059,7 +5010,8 @@ short-summary: Show a private endpoint dns zone group. examples: - name: Show a private endpoint dns zone group. (autogenerated) - text: az network private-endpoint dns-zone-group show --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup + text: | + az network private-endpoint dns-zone-group show --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup crafted: true """ @@ -6073,6 +5025,16 @@ crafted: true """ +aladdin_helps['network private-endpoint update'] = """ +type: command +short-summary: Update a private endpoint. +examples: + - name: Update a private endpoint. (autogenerated) + text: | + az network private-endpoint update --name MyPE --resource-group MyResourceGroup --set useRemoteGateways=true + crafted: true +""" + aladdin_helps['network private-link-service connection delete'] = """ type: command short-summary: Delete a private link service endpoint connection. @@ -6199,10 +5161,17 @@ 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 --route-table-name MyRouteTable + az network route-table route update --address-prefix 10.0.0.0/16 --name MyRoute --next-hop-ip-address 10.0.100.5 --next-hop-type VirtualNetworkGateway --resource-group MyResourceGroup --route-table-name MyRouteTable crafted: true - - name: Update a route in a route table. (autogenerated) - text: az network route-table route update --name MyRoute --next-hop-ip-address 10.0.100.5 --next-hop-type VirtualNetworkGateway --resource-group MyResourceGroup --route-table-name MyRouteTable +""" + +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 """ @@ -6236,6 +5205,36 @@ 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. @@ -6336,6 +5335,20 @@ 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: | @@ -6414,6 +5427,10 @@ - name: --validate short-summary: Display and validate the ARM template but do not create any resources. examples: + - name: Create a VPN connection with --ingress-nat-rule. + text: | + az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 --ingress-nat-rule /subscriptions/000/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/gwx/natRules/nat + crafted: true - name: Create a VPN connection. (autogenerated) text: | az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW @@ -6424,6 +5441,16 @@ crafted: true """ +aladdin_helps['network vpn-connection shared-key reset'] = """ +type: command +short-summary: Reset a VPN connection shared key. +examples: + - name: Reset a VPN connection shared key. (autogenerated) + text: | + az network vpn-connection shared-key reset --connection-name MyConnection --key-length 128 --resource-group MyResourceGroup --subscription MySubscription + crafted: true +""" + aladdin_helps['network vpn-connection shared-key show'] = """ type: command short-summary: Retrieve a VPN connection shared key. @@ -6454,21 +5481,13 @@ crafted: true """ -aladdin_helps['network vrouter list'] = """ -type: command -short-summary: List all virtual routers under a subscription or a resource group. -examples: - - name: List all virtual routers under a subscription or a resource group. (autogenerated) - text: az network vrouter list --resource-group myresourcegroup - crafted: true -""" - aladdin_helps['network vrouter update'] = """ type: command short-summary: Update a virtual router. examples: - name: Update a virtual router. (autogenerated) - text: az network vrouter update --name myvirtualrouter --resource-group myresourcegroup --tags super_secure no_80 no_22 + text: | + az network vrouter update --name myvirtualrouter --resource-group myresourcegroup --tags super_secure no_80 no_22 crafted: true """ @@ -6498,7 +5517,18 @@ short-summary: List all endpoints form a connection monitor examples: - name: List all endpoints form a connection monitor. (autogenerated) - text: az network watcher connection-monitor endpoint list --connection-monitor MyConnectionMonitor --location westus2 + text: | + az network watcher connection-monitor endpoint list --connection-monitor MyConnectionMonitor --location westus2 + crafted: true +""" + +aladdin_helps['network watcher connection-monitor endpoint show'] = """ +type: command +short-summary: Show an endpoint from a connection monitor +examples: + - name: Show an endpoint from a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor endpoint show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitorendpoint --subscription MySubscription crafted: true """ @@ -6517,7 +5547,8 @@ short-summary: List all test configurations of a connection monitor examples: - name: List all test configurations of a connection monitor. (autogenerated) - text: az network watcher connection-monitor test-configuration list --connection-monitor MyConnectionMonitor --location westus2 + text: | + az network watcher connection-monitor test-configuration list --connection-monitor MyConnectionMonitor --location westus2 crafted: true """ @@ -6526,7 +5557,8 @@ short-summary: Show a test configuration from a connection monitor examples: - name: Show a test configuration from a connection monitor. (autogenerated) - text: az network watcher connection-monitor test-configuration show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitortestconfiguration + text: | + az network watcher connection-monitor test-configuration show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestConfiguration crafted: true """ @@ -6535,7 +5567,18 @@ short-summary: List all test groups of a connection monitor examples: - name: List all test groups of a connection monitor. (autogenerated) - text: az network watcher connection-monitor test-group list --connection-monitor MyConnectionMonitor --location westus2 + text: | + az network watcher connection-monitor test-group list --connection-monitor MyConnectionMonitor --location westus2 + crafted: true +""" + +aladdin_helps['network watcher connection-monitor test-group remove'] = """ +type: command +short-summary: Remove test group from a connection monitor +examples: + - name: Remove test group from a connection monitor. (autogenerated) + text: | + az network watcher connection-monitor test-group remove --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup crafted: true """ @@ -6544,7 +5587,8 @@ short-summary: Show a test group of a connection monitor examples: - name: Show a test group of a connection monitor. (autogenerated) - text: az network watcher connection-monitor test-group show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitortestgroup + text: | + az network watcher connection-monitor test-group show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup --subscription MySubscription crafted: true """ @@ -6553,7 +5597,8 @@ short-summary: Delete the specified flow log resource. examples: - name: Delete the specified flow log resource. (autogenerated) - text: az network watcher flow-log delete --location westus2 --name MyFlowLogger --subscription MySubscription + text: | + az network watcher flow-log delete --location westus2 --name MyFlowLogger crafted: true """ @@ -6562,7 +5607,8 @@ short-summary: List all flow log resources for the specified Network Watcher examples: - name: List all flow log resources for the specified Network Watcher. (autogenerated) - text: az network watcher flow-log list --location westus2 + text: | + az network watcher flow-log list --location westus2 crafted: true """ @@ -6586,32 +5632,7 @@ crafted: true """ -aladdin_helps['policy remediation delete'] = """ -type: command -short-summary: Delete a resource policy remediation. -examples: - - name: Delete a resource policy remediation. (autogenerated) - text: az policy remediation delete --name myremediation - crafted: true -""" - -aladdin_helps['policy remediation deployment list'] = """ -type: command -short-summary: Lists deployments for a resource policy remediation. -examples: - - name: Lists deployments for a resource policy remediation. (autogenerated) - text: az policy remediation deployment list --name myremediation - crafted: true -""" -aladdin_helps['policy remediation show'] = """ -type: command -short-summary: Show a resource policy remediation. -examples: - - name: Show a resource policy remediation. (autogenerated) - text: az policy remediation show --name myremediation - crafted: true -""" aladdin_helps['network private-dns link vnet create'] = """ type: command @@ -6652,30 +5673,13 @@ crafted: true """ -aladdin_helps['network private-dns record-set aaaa list'] = """ -type: command -short-summary: List all AAAA record sets in a zone. -examples: - - name: List all AAAA record sets in a zone. (autogenerated) - text: az network private-dns record-set aaaa list --resource-group MyResourceGroup --subscription mysubscription --zone-name www.mysite.com - crafted: true -""" - -aladdin_helps['network private-dns record-set aaaa update'] = """ -type: command -short-summary: Update an AAAA record set. -examples: - - name: Update an AAAA record set. (autogenerated) - text: az network private-dns record-set aaaa update --name MyRecordSet --resource-group MyResourceGroup --set useRemoteGateways=true --zone-name www.mysite.com - crafted: true -""" - aladdin_helps['network private-dns record-set cname create'] = """ type: command short-summary: Create an empty CNAME record set. examples: - name: Create an empty CNAME record set (autogenerated) - text: az network private-dns record-set cname create --name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --ttl 300 --zone-name www.mysite.com + text: | + az network private-dns record-set cname create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --ttl 300 --zone-name www.mysite.com crafted: true """ @@ -6684,146 +5688,329 @@ short-summary: Delete a CNAME record set and its associated record. examples: - name: Delete a CNAME record set and its associated record. (autogenerated) - text: az network private-dns record-set cname delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com + text: | + az network private-dns record-set cname delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --zone-name www.mysite.com crafted: true """ -aladdin_helps['network private-dns record-set cname remove-record'] = """ +aladdin_helps['network private-dns record-set cname show'] = """ type: command -short-summary: Remove a CNAME record from its record set. -long-summary: > - By default, if the last record in a set is removed, the record set is deleted. - To retain the empty record set, include --keep-empty-record-set. +short-summary: Get the details of a CNAME record set. examples: - - name: Remove a CNAME record from its record set. (autogenerated) - text: az network private-dns record-set cname remove-record --cname www.contoso.com --record-set-name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --zone-name www.mysite.com + - name: Get the details of a CNAME record set (autogenerated) + text: | + az network private-dns record-set cname show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com crafted: true """ -aladdin_helps['network private-dns record-set mx add-record'] = """ +aladdin_helps['network private-dns record-set srv create'] = """ type: command -short-summary: Add an MX record. +short-summary: Create an empty SRV record set. examples: - - name: Add an MX record. (autogenerated) - text: az network private-dns record-set mx add-record --exchange mail.mysite.com --preference 10 --record-set-name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --zone-name www.mysite.com + - name: Create an empty SRV record set. (autogenerated) + text: | + az network private-dns record-set srv create --name MyRecordSet --resource-group MyResourceGroup --ttl 300 --zone-name www.mysite.com crafted: true """ -aladdin_helps['network private-dns record-set mx create'] = """ + + +aladdin_helps['ad app credential delete'] = """ type: command -short-summary: Create an empty MX record set. +short-summary: delete an application's password or certificate credentials examples: - - name: Create an empty MX record set. (autogenerated) - text: az network private-dns record-set mx create --name MyRecordSet --resource-group MyResourceGroup --subscription mysubscription --ttl 300 --zone-name www.mysite.com + - 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['network private-dns record-set srv create'] = """ +aladdin_helps['ad app credential list'] = """ type: command -short-summary: Create an empty SRV record set. +short-summary: List an application's password or certificate credential metadata. (The content of the password or certificate credential is not retrievable.) examples: - - name: Create an empty SRV record set. (autogenerated) - text: az network private-dns record-set srv create --name MyRecordSet --resource-group MyResourceGroup --ttl 300 --zone-name www.mysite.com + - 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['network private-dns zone wait'] = """ +aladdin_helps['ad app credential reset'] = """ type: command -short-summary: Place the CLI in a waiting state until a condition of the Private DNS zone is met. +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: Place the CLI in a waiting state until a condition of the Private DNS zone is met. (autogenerated) - text: az network private-dns zone wait --exists --name www.mysite.com --resource-group MyResourceGroup --timeout 60 + - 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['account set'] = """ +aladdin_helps['ad app delete'] = """ type: command -short-summary: Set a subscription to be the current active subscription. +short-summary: Delete an application. examples: - - name: Set a subscription to be the current active subscription. (autogenerated) - text: az account set --subscription mysubscription + - name: Delete an application. (autogenerated) + text: az ad app delete --id 00000000-0000-0000-0000-000000000000 crafted: true """ -aladdin_helps['mariadb db create'] = """ +aladdin_helps['ad app owner add'] = """ type: command -short-summary: Create a MariaDB database. +short-summary: Add an application owner. examples: - - name: Create a MariaDB database. (autogenerated) - text: az mariadb db create --name testdb --resource-group testgroup --server-name testsvr --subscription mysubscription + - name: add an application owner. (autogenerated) + text: az ad app owner add --id 00000000-0000-0000-0000-000000000000 --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx crafted: true """ -aladdin_helps['mariadb db show'] = """ +aladdin_helps['ad app owner list'] = """ type: command -short-summary: Show the details of a database. +short-summary: List application owners. examples: - - name: Show the details of a database. (autogenerated) - text: az mariadb db show --name testdb --resource-group testgroup --server-name testsvr --subscription mysubscription + - name: List application owners. (autogenerated) + text: az ad app owner list --id 00000000-0000-0000-0000-000000000000 crafted: true """ -aladdin_helps['mariadb server configuration list'] = """ +aladdin_helps['ad app permission admin-consent'] = """ type: command -short-summary: List the configuration values for a server. +short-summary: Grant Application & Delegated permissions through admin-consent. +long-summary: You must login as a global administrator examples: - - name: List the configuration values for a server. (autogenerated) - text: az mariadb server configuration list --resource-group MyResourceGroup --server-name MyServer + - 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['mariadb server configuration show'] = """ +aladdin_helps['ad app show'] = """ type: command -short-summary: Get the configuration for a server." +short-summary: Get the details of an application. examples: - - name: Get the configuration for a server." (commonly used with --output). (autogenerated) - text: az mariadb server configuration show --name MyServerConfiguration --resource-group MyResourceGroup --server-name MyServer + - name: Get the details of an application. (autogenerated) + text: az ad app show --id 00000000-0000-0000-0000-000000000000 crafted: true """ -aladdin_helps['mariadb server delete'] = """ +aladdin_helps['ad group create'] = """ type: command -short-summary: Delete a server. +short-summary: Create a group in the directory. examples: - - name: Delete a server. (autogenerated) - text: az mariadb server delete --name testsvr --resource-group testgroup --subscription mysubscription --yes + - name: Create a group in the directory. (autogenerated) + text: az ad group create --display-name MyDisplay --mail-nickname MyDisplay crafted: true """ -aladdin_helps['mariadb server firewall-rule delete'] = """ +aladdin_helps['ad group member check'] = """ type: command -short-summary: Delete a firewall rule. +short-summary: Check if a member is in a group. examples: - - name: Delete a firewall rule. (autogenerated) - text: az mariadb server firewall-rule delete --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer --subscription MySubscription --yes + - name: Check if a member is in a group. (autogenerated) + text: az ad group member check --group MyGroupDisplayName --member-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx crafted: true """ -aladdin_helps['mariadb server firewall-rule list'] = """ +aladdin_helps['ad group owner add'] = """ type: command -short-summary: List all firewall rules for a server. +short-summary: Add a group owner. examples: - - name: List all firewall rules for a server (autogenerated) - text: az mariadb server firewall-rule list --resource-group MyResourceGroup --server-name MyServer + - name: add a group owner. (autogenerated) + text: az ad group owner add --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx crafted: true """ -aladdin_helps['mariadb server firewall-rule show'] = """ +aladdin_helps['ad group owner list'] = """ type: command -short-summary: Get the details of a firewall rule. +short-summary: List group owners. examples: - - name: Get the details of a firewall rule. (autogenerated) - text: az mariadb server firewall-rule show --name myfirewallrule --resource-group myresourcegroup --server-name myserver --subscription mysubscription + - name: List group owners. (autogenerated) + text: az ad group owner list --group MyGroupDisplayName crafted: true """ -aladdin_helps['mariadb server show'] = """ +aladdin_helps['ad group owner remove'] = """ type: command -short-summary: Get the details of a server. +short-summary: Remove a group owner. examples: - - name: Get the details of a server. (autogenerated) - text: az mariadb server show --name MyServer --resource-group MyResourceGroup - crafted: true + - name: remove a group owner. (autogenerated) + text: az ad group owner remove --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + crafted: true +""" + +aladdin_helps['ad sp create'] = """ +type: command +short-summary: Create a service principal. +examples: + - name: Create a service principal. (autogenerated) + text: az ad sp create --id 00000000-0000-0000-0000-000000000000 + 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. +examples: + - name: Delete a service principal and its role assignments. (autogenerated) + text: az ad sp delete --id 00000000-0000-0000-0000-000000000000 + crafted: true +""" + +aladdin_helps['ad sp owner list'] = """ +type: command +short-summary: List service principal owners. +examples: + - name: List service principal owners. (autogenerated) + text: az ad sp owner list --id 00000000-0000-0000-0000-000000000000 + 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 +examples: + - name: update a service principal (autogenerated) + text: az ad sp update --id 00000000-0000-0000-0000-000000000000 --set groupMembershipClaims=All + 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. +examples: + - name: List the configuration values for a server. (autogenerated) + text: az mariadb server configuration list --resource-group MyResourceGroup --server-name MyServer + crafted: true +""" + +aladdin_helps['mariadb server configuration show'] = """ +type: command +short-summary: Get the configuration for a server." +examples: + - name: Get the configuration for a server." (commonly used with --output). (autogenerated) + text: az mariadb server configuration show --name MyServerConfiguration --resource-group MyResourceGroup --server-name MyServer + crafted: true +""" + +aladdin_helps['mariadb server firewall-rule delete'] = """ +type: command +short-summary: Delete a firewall rule. +examples: + - name: Delete a firewall rule. (autogenerated) + text: az mariadb server firewall-rule delete --name MyFirewallRule --resource-group MyResourceGroup --server-name MyServer --subscription MySubscription --yes + crafted: true +""" + +aladdin_helps['mariadb 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 mariadb server firewall-rule list --resource-group MyResourceGroup --server-name MyServer + crafted: true +""" + +aladdin_helps['mariadb server show'] = """ +type: command +short-summary: Get the details of a server. +examples: + - name: Get the details of a server. (autogenerated) + text: az mariadb server show --name MyServer --resource-group MyResourceGroup + crafted: true +""" + +aladdin_helps['mariadb server start'] = """ +type: command +short-summary: Start a stopped server. +examples: + - name: Start a stopped server. (autogenerated) + text: az mariadb server start --name testsvr --resource-group testgroup --subscription MySubscription + crafted: true +""" + +aladdin_helps['mariadb server stop'] = """ +type: command +short-summary: Stop a running server. +examples: + - name: Stop a running server. (autogenerated) + text: az mariadb server stop --name testsvr --resource-group testgroup --subscription MySubscription + crafted: true """ aladdin_helps['mariadb server update'] = """ @@ -6836,17 +6023,68 @@ - name: Update a server. (autogenerated) text: az mariadb server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled crafted: true - - name: Update a server. (autogenerated) - text: az mariadb server update --name testsvrnew --public-network-access Disabled --resource-group testgroup +""" + +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 restart'] = """ +type: command +short-summary: Restart a flexible server. +examples: + - name: Restart a flexible server. + text: az mysql flexible-server restart --resource-group testGroup --name testserver + crafted: true +""" + +aladdin_helps['mysql flexible-server show'] = """ +type: command +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 + crafted: true +""" + +aladdin_helps['mysql flexible-server start'] = """ +type: command +short-summary: Start a flexible server. +examples: + - name: Start a flexible server. + text: az mysql flexible-server start --resource-group testGroup --name testserver + crafted: true +""" + +aladdin_helps['mysql flexible-server stop'] = """ +type: command +short-summary: Stop a flexible server. +examples: + - name: Stop a flexible server. + text: az mysql flexible-server stop --resource-group testGroup --name testserver + crafted: true +""" + +aladdin_helps['mysql flexible-server update'] = """ +type: command +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" crafted: true """ -aladdin_helps['mariadb server vnet-rule create'] = """ +aladdin_helps['mysql flexible-server wait'] = """ type: command -short-summary: Create a virtual network rule to allows access to a MariaDB server. +short-summary: Wait for the flexible server to satisfy certain conditions. examples: - - name: Create a virtual network rule to allows access to a MariaDB server. (autogenerated) - text: az mariadb server vnet-rule create --ignore-missing-endpoint true --name vnetRuleName --resource-group testgroup --server-name testsvr --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/subnetName --subscription mysubscription --vnet-name vnetName + - name: Wait for the flexible server to satisfy certain conditions. + text: az mysql flexible-server wait --exists --resource-group testGroup --name testserver crafted: true """ @@ -6895,16 +6133,6 @@ crafted: true """ -aladdin_helps['mysql server replica create'] = """ -type: command -short-summary: Create a read replica for a server. -examples: - - name: Create a read replica for a server. (autogenerated) - text: | - az mysql server replica create --location westus2 --name testreplsvr --resource-group testgroup --source-server "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforMySQL/servers/testsvr2" - crafted: true -""" - aladdin_helps['mysql server restart'] = """ type: command short-summary: Restart a server. @@ -6923,12 +6151,30 @@ crafted: true """ +aladdin_helps['mysql server start'] = """ +type: command +short-summary: Start a stopped server. +examples: + - name: Start a stopped server. (autogenerated) + text: az mysql server start --name testsvr --resource-group testgroup --subscription MySubscription + crafted: true +""" + +aladdin_helps['mysql server stop'] = """ +type: command +short-summary: Stop a running server. +examples: + - name: Stop a running server. (autogenerated) + text: az mysql server stop --name testsvr --resource-group testgroup --subscription MySubscription + crafted: true +""" + aladdin_helps['mysql server update'] = """ type: command short-summary: Update a server. examples: - name: Update a server. (autogenerated) - text: az mysql server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled + text: az mysql server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled --minimal-tls-version TLS1_0 crafted: true """ @@ -6941,15 +6187,6 @@ crafted: true """ -aladdin_helps['postgres server ad-admin show'] = """ -type: command -short-summary: Get Active Directory Administrator information for a PostgreSQL server. -examples: - - name: Get Active Directory Administrator information for a PostgreSQL server (autogenerated) - text: az postgres server ad-admin show --resource-group testgroup --server-name testsvr --subscription mysubscription - crafted: true -""" - aladdin_helps['postgres server configuration list'] = """ type: command short-summary: List the configuration values for a server. @@ -6995,50 +6232,109 @@ crafted: true """ -aladdin_helps['postgres server private-link-resource list'] = """ +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 + crafted: true +""" + +aladdin_helps['postgres server update'] = """ type: command -short-summary: List the private link resources supported for a PostgreSQL server. +short-summary: Update a server. examples: - - name: List the private link resources supported for a PostgreSQL server. (autogenerated) - text: az postgres server private-link-resource list --resource-group myresourcegroup --server-name myserver + - 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 server replica create'] = """ +aladdin_helps['role assignment create'] = """ type: command -short-summary: Create a read replica for a server. +short-summary: Create a new role assignment for a user, group, or service principal. examples: - - name: Create a read replica for a server. (autogenerated) + - name: Create a new role assignment for a user, group, or service principal. (autogenerated) text: | - az postgres server replica create --location westus2 --name testreplsvr --resource-group testgroup --source-server "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/testsvr2" + az role assignment create --assignee 00000000-0000-0000-0000-000000000000 --role "Storage Account Key Operator Service Role" --scope $id crafted: true """ -aladdin_helps['postgres server show'] = """ +aladdin_helps['role assignment delete'] = """ type: command -short-summary: Get the details of a server. +short-summary: Delete role assignments. examples: - - name: Get the details of a server. (autogenerated) - text: az postgres server show --name MyServer --resource-group MyResourceGroup + - 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 update'] = """ +aladdin_helps['role definition delete'] = """ type: command -short-summary: Update a server. +short-summary: Delete a role definition. examples: - - name: Update a server. (autogenerated) - text: az postgres server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled + - name: Delete a role definition. (autogenerated) + text: az role definition delete --name MyRole crafted: true """ aladdin_helps['redis create'] = """ type: command 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: Create new Redis Cache instance. (autogenerated) text: az redis create --location westus2 --name MyRedisCache --resource-group MyResourceGroup --sku Basic --vm-size c0 crafted: true + - 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 + - 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 + - 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 + - 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 + - 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 + - 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['redis update'] = """ @@ -7046,14 +6342,32 @@ short-summary: Update a Redis cache. long-summary: Scale or update settings of a Redis cache. examples: - - name: Update a Redis cache. (autogenerated) - text: az redis update --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 -""" - -aladdin_helps['relay hyco authorization-rule keys list'] = """ -type: command -short-summary: List the keys and connection strings of Authorization Rule for Relay Service Hybrid Connection. + - 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"="DefaultEndpointsProtocol=https;AccountName=mystorageaccount;AccountKey=myAccountKey;EndpointSuffix=core.windows.net" "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 +""" + +aladdin_helps['relay hyco authorization-rule keys list'] = """ +type: command +short-summary: List the keys and connection strings of Authorization Rule for Relay Service Hybrid Connection. examples: - name: List the keys and connection strings of Authorization Rule for Relay Service Hybrid Connection (autogenerated) text: az relay hyco authorization-rule keys list --hybrid-connection-name myhyco --name myauthorule --namespace-name mynamespace --resource-group myresourcegroup --subscription MySubscription @@ -7069,15 +6383,6 @@ crafted: true """ -aladdin_helps['relay wcfrelay list'] = """ -type: command -short-summary: List the WCF Relay by Relay Service Namepsace -examples: - - name: List the WCF Relay by Relay Service Namepsace. (autogenerated) - text: az relay wcfrelay list --namespace-name mynamespace --resource-group myresourcegroup --subscription mysubscription - crafted: true -""" - aladdin_helps['deployment group validate'] = """ @@ -7090,9 +6395,11 @@ Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. - name: --template-file -f - short-summary: The path to the template file. + short-summary: The path to the template file or Bicep file. - name: --template-uri -u short-summary: The URI to the template file. + - name: --template-spec -s + short-summary: The template spec resource id. - name: --resource-group -g short-summary: The resource group to create deployment at. - name: --name -n @@ -7101,7 +6408,18 @@ short-summary: The deployment mode. examples: - name: Validate whether a template is valid at resource group. (autogenerated) - text: az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json + text: | + az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json + crafted: true +""" + +aladdin_helps['deployment group wait'] = """ +type: command +short-summary: Place the CLI in a waiting state until a deployment condition is met. +examples: + - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) + text: | + az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup crafted: true """ @@ -7115,9 +6433,11 @@ Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. - name: --template-file -f - short-summary: The path to the template file. + short-summary: The path to the template file or Bicep file. - name: --template-uri -u short-summary: The URI to the template file. + - name: --template-spec -s + short-summary: The template spec resource id. - name: --management-group-id -m short-summary: The management group id to create deployment at. - name: --name -n @@ -7126,7 +6446,8 @@ short-summary: The location to store the deployment metadata. examples: - name: Validate whether a template is valid at management group. (autogenerated) - text: az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json + text: | + az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json crafted: true """ @@ -7135,7 +6456,8 @@ short-summary: List deployment operations at resource group. examples: - name: List deployment operations at resource group (autogenerated) - text: az deployment operation group list --name MyDeployment --resource-group MyResourceGroup + text: | + az deployment operation group list --name MyDeployment --resource-group MyResourceGroup crafted: true """ @@ -7144,16 +6466,18 @@ short-summary: List deployment operations at subscription scope. examples: - name: List deployment operations at subscription scope. (autogenerated) - text: az deployment operation list --name MyDeployment + text: | + az deployment operation list --name MyDeployment crafted: true """ -aladdin_helps['deployment operation mg list'] = """ +aladdin_helps['deployment operation sub list'] = """ type: command -short-summary: List deployment operations at management group. +short-summary: List deployment operations at subscription scope. examples: - - name: List deployment operations at management group. (autogenerated) - text: az deployment operation mg list --management-group-id testrg --name mydeployment + - name: List deployment operations at subscription scope. (autogenerated) + text: | + az deployment operation sub list --name mydeployment crafted: true """ @@ -7167,16 +6491,19 @@ Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. - name: --template-file -f - short-summary: The path to the template file. + short-summary: The path to the template file or Bicep file. - name: --template-uri -u short-summary: The URI to the template file. + - name: --template-spec -s + short-summary: The template spec resource id. - name: --location -l short-summary: The location to store the deployment metadata. - name: --name -n short-summary: The deployment name. examples: - name: Validate whether a template is valid at subscription scope. (autogenerated) - text: az deployment sub validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json + text: | + az deployment sub validate --location westus2 --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json crafted: true """ @@ -7185,7 +6512,8 @@ short-summary: Place the CLI in a waiting state until a deployment condition is met. examples: - name: Place the CLI in a waiting state until a deployment condition is met. (autogenerated) - text: az deployment sub wait --created --name MyDeployment + text: | + az deployment sub wait --created --name MyDeployment crafted: true """ @@ -7199,16 +6527,19 @@ Parameters may be supplied from a file using the `@{path}` syntax, a JSON string, or as pairs. Parameters are evaluated in order, so when a value is assigned twice, the latter value will be used. It is recommended that you supply your parameters file first, and then override selectively using KEY=VALUE syntax. - name: --template-file -f - short-summary: The path to the template file. + short-summary: The path to the template file or Bicep file. - name: --template-uri -u short-summary: The URI to the template file. + - name: --template-spec -s + short-summary: The template spec resource id. - name: --name -n short-summary: The deployment name. - name: --location -l short-summary: The location to store the deployment metadata. examples: - name: Validate whether a template is valid at tenant scope. (autogenerated) - text: az deployment tenant validate --location WestUS --name mydeployment --parameters MyValue=This MyArray=@array.json --template-file azuredeploy.json + text: | + az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json crafted: true """ @@ -7331,8 +6662,9 @@ type: command short-summary: Delete a managed application. examples: - - name: Delete a managed application (autogenerated) - text: az managedapp delete --name MyManagedApplication --only-show-errors --resource-group MyResourceGroup + - name: Delete a managed application. (autogenerated) + text: | + az managedapp delete --name MyManagedApplication --resource-group MyResourceGroup --subscription MySubscription crafted: true """ @@ -7406,6 +6738,26 @@ crafted: true """ +aladdin_helps['policy exemption delete'] = """ +type: command +short-summary: Delete a policy exemption. +examples: + - name: Delete a policy exemption. + text: | + az policy exemption delete --name MyPolicyExemption --resource-group "myResourceGroup" + crafted: true +""" + +aladdin_helps['policy exemption show'] = """ +type: command +short-summary: Show a policy exemption. +examples: + - name: Show a policy exemption. + text: | + az policy exemption show --name MyPolicyExemption --resource-group "myResourceGroup" + crafted: true +""" + aladdin_helps['policy set-definition delete'] = """ type: command short-summary: Delete a policy set definition. @@ -7468,376 +6820,80 @@ text: | az resource invoke-action --action capture --name MyResource --resource-group MyResourceGroup --resource-type Microsoft.web/sites crafted: true -""" - -aladdin_helps['resource lock delete'] = """ -type: command -short-summary: Delete a resource-level lock. -examples: - - name: Delete a resource-level lock. (autogenerated) - text: | - az resource lock delete --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} - crafted: true -""" - -aladdin_helps['resource lock update'] = """ -type: command -short-summary: Update a resource-level lock. -examples: - - name: Update a resource-level lock. (autogenerated) - text: az resource lock update --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --lock-type CanNotDelete - crafted: true -""" - -aladdin_helps['resource update'] = """ -type: command -short-summary: Update a resource. -examples: - - name: Update a resource. (autogenerated) - text: | - az resource update --ids $id --set properties.connectionType=Proxy - crafted: true - - name: Update a resource. (autogenerated) - text: az resource update --name myresource --resource-group myresourcegroup --resource-type subnets --set tags.key=value - crafted: true -""" - -aladdin_helps['resource wait'] = """ -type: command -short-summary: Place the CLI in a waiting state until a condition of a resources is met. -examples: - - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) - text: | - az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} - crafted: true - - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) - text: | - az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --include-response-body true - crafted: true - - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) - text: | - az resource wait --exists --name MyResource --resource-group MyResourceGroup --resource-type subnets - crafted: true -""" - -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 credentials -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 -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. -examples: - - name: Delete an application. (autogenerated) - text: az ad app delete --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - -aladdin_helps['ad app owner add'] = """ -type: command -short-summary: add an application owner. -examples: - - name: add an application owner. (autogenerated) - text: az ad app owner add --id 00000000-0000-0000-0000-000000000000 --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad app owner list'] = """ -type: command -short-summary: List application owners. -examples: - - name: List application owners. (autogenerated) - text: az ad app owner list --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - -aladdin_helps['ad app owner remove'] = """ -type: command -short-summary: remove an application owner. -examples: - - name: Remove an application owner. (autogenerated) - text: az ad app owner remove --id 00000000-0000-0000-0000-00000000000000000 --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -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 -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. -examples: - - name: Create a group in the directory. (autogenerated) - text: az ad group create --display-name MyDisplay --mail-nickname MyDisplay - crafted: true -""" - -aladdin_helps['ad group member check'] = """ -type: command -short-summary: Check if a member is in a group. -examples: - - name: Check if a member is in a group. (autogenerated) - text: az ad group member check --group MyGroupDisplayName --member-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad group owner add'] = """ -type: command -short-summary: add a group owner. -examples: - - name: add a group owner. (autogenerated) - text: az ad group owner add --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad group owner list'] = """ -type: command -short-summary: List group owners. -examples: - - name: List group owners. (autogenerated) - text: az ad group owner list --group MyGroupDisplayName - crafted: true -""" - -aladdin_helps['ad group owner remove'] = """ -type: command -short-summary: remove a group owner. -examples: - - name: remove a group owner. (autogenerated) - text: az ad group owner remove --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - crafted: true -""" - -aladdin_helps['ad sp create'] = """ -type: command -short-summary: Create a service principal. -examples: - - name: Create a service principal. (autogenerated) - text: az ad sp create --id 00000000-0000-0000-0000-000000000000 - 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. -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. -examples: - - name: Delete a service principal and its role assignments. (autogenerated) - text: az ad sp delete --id 00000000-0000-0000-0000-000000000000 - crafted: true -""" - -aladdin_helps['ad sp owner list'] = """ -type: command -short-summary: List service principal owners. -examples: - - name: List service principal owners. (autogenerated) - text: az ad sp owner list --id 00000000-0000-0000-0000-000000000000 - 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 -examples: - - name: update a service principal (autogenerated) - text: az ad sp update --id 00000000-0000-0000-0000-000000000000 --set groupMembershipClaims=All - 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 --id 00000000-0000-0000-0000-00000000000000000 - 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['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 - crafted: true -""" - -aladdin_helps['role assignment delete'] = """ -type: command -short-summary: Delete role assignments. -examples: - - 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['role definition delete'] = """ -type: command -short-summary: Delete a role definition. -examples: - - name: Delete a role definition. (autogenerated) - text: az role definition delete --name MyRole - crafted: true -""" - - +""" -aladdin_helps['security alert show'] = """ +aladdin_helps['resource lock delete'] = """ type: command -short-summary: Shows a security alert. +short-summary: Delete a resource-level lock. examples: - - name: Shows a security alert. (autogenerated) + - name: Delete a resource-level lock. (autogenerated) text: | - az security alert show --location "centralus" --name "alertName" --subscription mysubscription + az resource lock delete --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} crafted: true """ -aladdin_helps['security auto-provisioning-setting update'] = """ +aladdin_helps['resource lock update'] = """ type: command -short-summary: Updates your automatic provisioning settings on the subscription. +short-summary: Update a resource-level lock. examples: - - name: Updates your automatic provisioning settings on the subscription. (autogenerated) + - name: Update a resource-level lock. (autogenerated) text: | - az security auto-provisioning-setting update --auto-provision "Off" --name "default" --subscription MySubscription + az resource lock update --lock-type CanNotDelete --name lockName --namespace Microsoft.Network --resource-group MyResourceGroup --resource-name myvnet --resource-type Microsoft.Network/virtualNetworks crafted: true """ -aladdin_helps['security pricing create'] = """ +aladdin_helps['resource update'] = """ type: command -short-summary: Updates the Azure Security Center Pricing tier for the subscription. +short-summary: Update a resource. examples: - - name: Updates the Azure Security Center Pricing tier for the subscription. (autogenerated) - text: az security pricing create --name default --subscription MySubscription --tier 'standard' + - name: Update a resource. (autogenerated) + text: | + az resource update --ids $id --set properties.connectionType=Proxy + crafted: true + - name: Update a resource. (autogenerated) + text: | + az resource update --name myresource --resource-group myresourcegroup --resource-type subnets --set tags.key=value crafted: true """ -aladdin_helps['security workspace-setting create'] = """ +aladdin_helps['resource wait'] = """ type: command -short-summary: Creates a workspace settings in your subscription - these settings let you control which workspace will hold your security data +short-summary: Place the CLI in a waiting state until a condition of a resources is met. examples: - - name: Creates a workspace settings in your subscription - these settings let you control which workspace will hold your security data. (autogenerated) - text: az security workspace-setting create --name default --subscription mysubscription --target-workspace '/subscriptions/00000000-0000-0000-0000-00000000000000000/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace' + - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) + text: | + az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} + crafted: true + - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) + text: | + az resource wait --exists --ids /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Web/sites/{WebApp} --include-response-body true + crafted: true + - name: Place the CLI in a waiting state until a condition of a resources is met. (autogenerated) + text: | + az resource wait --exists --name MyResource --resource-group MyResourceGroup --resource-type subnets crafted: true """ -aladdin_helps['servicebus georecovery-alias authorization-rule keys list'] = """ + + + + +aladdin_helps['security auto-provisioning-setting update'] = """ type: command -short-summary: List the keys and connection strings of Authorization Rule for the Service Bus Namespace +short-summary: Updates your automatic provisioning settings on the subscription. examples: - - name: List the keys and connection strings of Authorization Rule for the Service Bus Namespace (autogenerated) - text: az servicebus georecovery-alias authorization-rule keys list --alias myaliasname --name myauthorule --namespace-name mynamespace --resource-group myresourcegroup --subscription mysubscription + - name: Updates your automatic provisioning settings on the subscription. (autogenerated) + text: | + az security auto-provisioning-setting update --auto-provision "Off" --name "default" --subscription MySubscription crafted: true """ -aladdin_helps['servicebus georecovery-alias break-pair'] = """ +aladdin_helps['security pricing create'] = """ type: command -short-summary: Disables Service Bus Geo-Disaster Recovery Configuration Alias and stops replicating changes from primary to secondary namespaces +short-summary: Updates the Azure defender plan for the subscription. examples: - - name: Disables Service Bus Geo-Disaster Recovery Configuration Alias and stops replicating changes from primary to secondary namespaces. (autogenerated) - text: az servicebus georecovery-alias break-pair --alias myaliasname --namespace-name primarynamespace --resource-group myresourcegroup --subscription mysubscription + - name: Updates the Azure defender plan for the subscription. (autogenerated) + text: az security pricing create -n VirtualMachines --tier 'standard' crafted: true """ @@ -7877,15 +6933,6 @@ crafted: true """ -aladdin_helps['servicebus topic subscription rule update'] = """ -type: command -short-summary: Updates the ServiceBus Rule for Subscription -examples: - - name: Updates the ServiceBus Rule for Subscription. (autogenerated) - text: az servicebus topic subscription rule update --enable-action-preprocessing true --enable-correlation-preprocessing true --name myrule --namespace-name mynamespace --resource-group myresourcegroup --subscription-name mysubscription --topic-name mytopic - crafted: true -""" - aladdin_helps['servicebus topic subscription update'] = """ type: command short-summary: Updates the ServiceBus Subscription @@ -7907,33 +6954,11 @@ crafted: true """ -aladdin_helps['sf cluster certificate add'] = """ -type: command -short-summary: Add a secondary cluster certificate to the cluster. -examples: - - name: Add a secondary cluster certificate to the cluster. (autogenerated) - text: az sf cluster certificate add --cluster-name cluster1 --resource-group group-name --secret-identifier 'https://{KeyVault}.vault.azure.net/secrets/{Secret}' --vault-name MyVault - crafted: true -""" -aladdin_helps['signalr cors list'] = """ -type: command -short-summary: List allowed origins of a SignalR Service -examples: - - name: List allowed origins of a SignalR Service. (autogenerated) - text: az signalr cors list --name mysignalrservice --resource-group myresourcegroup - crafted: true -""" -aladdin_helps['sql db copy'] = """ -type: command -short-summary: Create a copy of a database. -long-summary: A full list of performance level options can be seen by executing `az sql db list-editions -a -o table -l LOCATION`. The copy destination database must have the same edition as the source database, but you can change the edition after the copy has completed. -examples: - - name: Create a copy of a database. (autogenerated) - text: az sql db copy --dest-name newDb --dest-resource-group mygroup --dest-server myserver --name originalDb --resource-group mygroup --server myserver - crafted: true -""" + + + aladdin_helps['sql db delete'] = """ type: command @@ -7946,9 +6971,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 """ @@ -8071,33 +7096,6 @@ crafted: true """ -aladdin_helps['sql instance-failover-group set-primary'] = """ -type: command -short-summary: Set the primary of the instance failover group by failing over all databases from the current primary managed instance. -examples: - - name: Set the primary of the instance failover group by failing over all databases from the current primary managed instance. (autogenerated) - text: az sql instance-failover-group set-primary --location westus2 --name myinstancefailovergroup --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['sql mi ad-admin list'] = """ -type: command -short-summary: Returns a list of managed instance Active Directory Administrators. -examples: - - name: Returns a list of managed instance Active Directory Administrators. (autogenerated) - text: az sql mi ad-admin list --managed-instance myinstance --resource-group myresourcegroup - crafted: true -""" - -aladdin_helps['sql mi create'] = """ -type: command -short-summary: Create a managed instance. -examples: - - name: Create a managed instance. (autogenerated) - text: az sql mi create --admin-password mypassword --admin-user myusername --assign-identity --capacity 8 --collation Latin1_General_100_CS_AS_SC --edition GeneralPurpose --family Gen5 --license-type LicenseIncluded --location mylocation --name myinstance --resource-group mygroup --storage 32GB --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} - crafted: true -""" - aladdin_helps['sql mi update'] = """ type: command short-summary: Update a managed instance. @@ -8135,15 +7133,23 @@ - name: Update a server. (autogenerated) text: az sql server update --admin-password myadminpassword --name MyAzureSQLServer --resource-group MyResourceGroup crafted: true - - name: Update a server. (autogenerated) - text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --set tags.tagName=tagValue - crafted: true """ +aladdin_helps['storage account encryption-scope create'] = """ +type: command +short-summary: Create an encryption scope within storage account. +examples: + - name: Create an encryption scope within storage account. (autogenerated) + text: | + az storage account encryption-scope create --account-name mystorageaccount --key-source Microsoft.Storage --name myencryption --resource-group MyResourceGroup --subscription mysubscription + crafted: true +""" + aladdin_helps['storage account generate-sas'] = """ 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.' @@ -8164,10 +7170,11 @@ aladdin_helps['storage account management-policy create'] = """ type: command -short-summary: Creates the data policy rules associated with the specified storage account. +short-summary: Create the data policy rules associated with the specified storage account. examples: - name: Create the data policy rules associated with the specified storage account. (autogenerated) - text: az storage account management-policy create --account-name myaccount --policy @policy.json --resource-group myresourcegroup + text: | + az storage account management-policy create --account-name myaccount --policy @policy.json --resource-group myresourcegroup crafted: true """ @@ -8225,20 +7232,6 @@ crafted: true """ -aladdin_helps['storage blob copy start'] = """ -type: command -short-summary: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs. -examples: - - name: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs. (autogenerated) - text: | - az storage blob copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-uri https://storage.blob.core.windows.net/photos - crafted: true - - name: Copies a blob asynchronously. Use `az storage blob show` to check the status of the blobs (autogenerated) - text: | - az storage blob copy start --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --sas-token $sas --source-uri https://storage.blob.core.windows.net/photos - crafted: true -""" - aladdin_helps['storage blob copy start-batch'] = """ type: command short-summary: Copy multiple blobs to a blob container. Use `az storage blob show` to check the status of the blobs. @@ -8288,7 +7281,7 @@ examples: - name: Check for the existence of a blob in a container. (autogenerated) text: | - az storage blob exists --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob + az storage blob exists --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob crafted: true """ @@ -8298,7 +7291,7 @@ examples: - name: Generate a shared access signature for the blob. (autogenerated) text: | - az storage blob generate-sas --account-key 00000000 --account-name MyStorageAccount --container-name MyContainer --expiry 2018-01-01T00:00:00Z --name MyBlob --permissions r + 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 """ @@ -8306,11 +7299,23 @@ 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` examples: - name: Copies an incremental copy of a blob asynchronously. (autogenerated) text: | az storage blob incremental-copy start --account-key 00000000 --account-name MyAccount --destination-blob MyDestinationBlob --destination-container MyDestinationContainer --source-account-key MySourceKey --source-account-name MySourceAccount --source-blob MyBlob --source-container MySourceContainer --source-snapshot MySnapshot 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['storage blob service-properties delete-policy show'] = """ @@ -8321,6 +7326,10 @@ text: | az storage blob service-properties delete-policy show --account-name mystorageccount --account-key 00000000 crafted: true + - name: Show the storage blob delete-policy. (autogenerated) + text: | + az storage blob service-properties delete-policy show --account-name mystorageccount --auth-mode login + crafted: true """ aladdin_helps['storage blob service-properties delete-policy update'] = """ @@ -8359,7 +7368,7 @@ examples: - name: Set the block or page tiers on the blob. (autogenerated) text: | - az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name MyContainer --name MyBlob --tier P10 + az storage blob set-tier --account-key 00000000 --account-name MyAccount --container-name mycontainer --name MyBlob --tier P10 crafted: true """ @@ -8369,26 +7378,25 @@ examples: - name: Get the details of a blob (autogenerated) text: | - az storage blob show --account-name mystorageccount --account-key 00000000 --container-name MyContainer --name MyBlob + az storage blob show --account-name mystorageccount --account-key 00000000 --container-name mycontainer --name MyBlob crafted: true """ aladdin_helps['storage blob upload'] = """ 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. +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: Defaults to 'page' for *.vhd files, or 'block' otherwise. + 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: 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: 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: Upload a file to a storage blob. (autogenerated) - text: az storage blob upload --account-key 0000-0000 --account-name mystorageaccount --container-name MyContainer --file /path/to/file --name MyBlob + text: | + az storage blob upload --account-name mystorageaccount --account-key 0000-0000 --container-name mycontainer --file /path/to/file --name myblob crafted: true """ @@ -8414,7 +7422,7 @@ examples: - name: Marks the specified container for deletion. (autogenerated) text: | - az storage container delete --account-key 00000000 --account-name MyAccount --name MyContainer + az storage container delete --account-key 00000000 --account-name MyAccount --name mycontainer crafted: true """ @@ -8426,9 +7434,6 @@ text: | az storage container exists --account-name mystorageccount --account-key 00000000 --name mycontainer crafted: true - - name: Check for the existence of a storage container. (autogenerated) - text: az storage container exists --account-name mystorageccount --auth-mode login --name mycontainer - crafted: true """ aladdin_helps['storage container generate-sas'] = """ @@ -8440,7 +7445,8 @@ 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 + text: | + az storage container generate-sas --account-name mystorageaccount --as-user --auth-mode login --expiry 2020-01-01 --name container1 --permissions dlrw crafted: true """ @@ -8450,7 +7456,7 @@ examples: - name: Get the legal hold properties of a container. (autogenerated) text: | - az storage container legal-hold show --account-name mystorageccount --container-name MyContainer + az storage container legal-hold show --account-name mystorageccount --container-name mycontainer crafted: true """ @@ -8480,7 +7486,7 @@ examples: - name: List all CORS rules for a storage account. (autogenerated) text: | - az storage cors list --account-name MyAccount + az storage cors list --account-key 00000000 --account-name mystorageaccount crafted: true """ @@ -8518,8 +7524,6 @@ - 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) text: | @@ -8624,8 +7628,9 @@ 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: Generates a shared access signature for the file (autogenerated) - text: az storage file generate-sas --account-name MyStorageAccount --expiry 2037-12-31T23:59:00Z --https-only --path path/file.txt --permissions rcdw --share-name MyShare --subscription mysubscription + - 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 """ @@ -8654,49 +7659,13 @@ crafted: true """ -aladdin_helps['storage file upload-batch'] = """ -type: command -short-summary: Upload files from a local directory to an Azure Storage File Share in a batch operation. -parameters: - - name: --source -s - type: string - short-summary: The directory to upload files from. - - name: --destination -d - type: string - short-summary: The destination of the upload operation. - long-summary: The destination can be the file share URL or the share name. When the destination is the share URL, the storage account name is parsed from the URL. - - name: --destination-path - type: string - short-summary: The directory where the source data is copied to. If omitted, data is copied to the root directory. - - 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 uploaded. 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: --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: Upload files from a local directory to an Azure Storage File Share in a batch operation. (autogenerated) - text: | - az storage file upload-batch --account-key 00000000 --account-name MyAccount --destination . --source /path/to/file - crafted: true -""" - aladdin_helps['storage file url'] = """ type: command short-summary: Create the url to access a file. examples: - name: Create the url to access a file. (autogenerated) - text: az storage file url --account-key 00000000 --account-name MyAccount --path path/file.txt --share-name MyShare + text: | + az storage file url --account-key 00000000 --account-name mystorageaccount --path path/file.txt --share-name myshare crafted: true """ @@ -8705,25 +7674,8 @@ short-summary: Create file system for Azure Data Lake Storage Gen2 account. examples: - name: Create file system for Azure Data Lake Storage Gen2 account. (autogenerated) - text: az storage fs create --account-name mystorageaccount --auth-mode login --name fsname - crafted: true -""" - -aladdin_helps['storage fs delete'] = """ -type: command -short-summary: Delete a file system in ADLS Gen2 account. -examples: - - name: Delete a file system in ADLS Gen2 account. (autogenerated) - text: az storage fs delete --account-name myadlsaccount --auth-mode login --name myfilesystem - crafted: true -""" - -aladdin_helps['storage fs directory create'] = """ -type: command -short-summary: Create a directory in ADLS Gen2 file system. -examples: - - name: Create a directory in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory create --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + text: | + az storage fs create --account-name mystorageaccount --auth-mode login --name fsname crafted: true """ @@ -8732,7 +7684,8 @@ short-summary: Delete a directory in ADLS Gen2 file system. examples: - name: Delete a directory in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory delete --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir + text: | + az storage fs directory delete --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --yes crafted: true """ @@ -8741,16 +7694,8 @@ short-summary: Check for the existence of a directory in ADLS Gen2 file system. examples: - name: Check for the existence of a directory in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory exists --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir - crafted: true -""" - -aladdin_helps['storage fs directory list'] = """ -type: command -short-summary: List directories in ADLS Gen2 file system. -examples: - - name: List directories in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory list --account-name myadlsaccount --auth-mode login --file-system myfilesystem + text: | + az storage fs directory exists --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir crafted: true """ @@ -8759,7 +7704,8 @@ short-summary: Move a directory in ADLS Gen2 file system. examples: - name: Move a directory in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory move --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --new-directory newfs/dir + text: | + az storage fs directory move --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir --new-directory newfs/dir crafted: true """ @@ -8768,16 +7714,8 @@ short-summary: Show properties of a directory in ADLS Gen2 file system. examples: - name: Show properties of a directory in ADLS Gen2 file system. (autogenerated) - text: az storage fs directory show --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir - crafted: true -""" - -aladdin_helps['storage fs exists'] = """ -type: command -short-summary: Check for the existence of a file system in ADLS Gen2 account. -examples: - - name: Check for the existence of a file system in ADLS Gen2 account. (autogenerated) - text: az storage fs exists --account-name myadlsaccount --auth-mode login --name myfilesystem + text: | + az storage fs directory show --account-name myadlsaccount --auth-mode login --file-system myfilesystem --name dir crafted: true """ @@ -8786,25 +7724,8 @@ short-summary: Show properties of file in ADLS Gen2 file system. examples: - name: Show properties of file in ADLS Gen2 file system. (autogenerated) - text: az storage fs file show --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt - crafted: true -""" - -aladdin_helps['storage fs file upload'] = """ -type: command -short-summary: Upload a file to a file path in ADLS Gen2 file system. -examples: - - name: Upload a file to a file path in ADLS Gen2 file system. (autogenerated) - text: az storage fs file upload --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt --source a.txt - crafted: true -""" - -aladdin_helps['storage fs metadata show'] = """ -type: command -short-summary: Return all user-defined metadata for the specified file system. -examples: - - name: Return all user-defined metadata for the specified file system. (autogenerated) - text: az storage fs metadata show --account-name myadlsaccount --auth-mode login --name myfilesystem + text: | + az storage fs file show --account-name myadlsaccount --auth-mode login --file-system fsname --path dir/a.txt crafted: true """ @@ -8813,7 +7734,8 @@ short-summary: Show properties of file system in ADLS Gen2 account. examples: - name: Show properties of file system in ADLS Gen2 account. (autogenerated) - text: az storage fs show --account-name myadlsaccount --auth-mode login --name myfilesystem + text: | + az storage fs show --account-name myadlsaccount --auth-mode login --name myfilesystem crafted: true """ @@ -8864,6 +7786,10 @@ text: | az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt crafted: true + - name: Update metrics settings for a storage account 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['storage share create'] = """ @@ -8913,6 +7839,10 @@ crafted: true """ + + + + aladdin_helps['disk delete'] = """ type: command short-summary: Delete a managed disk. @@ -8965,17 +7895,9 @@ text: | az disk wait --created --name MyManagedDisk --resource-group MyResourceGroup crafted: true - - name: Place the CLI in a waiting state until a condition of a managed disk is met (autogenerated) - text: az disk wait --exists --name MyManagedDisk --only-show-errors --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['disk-encryption-set create'] = """ -type: command -short-summary: Create a disk encryption set. -examples: - - name: Create a disk encryption set. (autogenerated) - text: az disk-encryption-set create --key-url MyKey --location westus2 --name MyDiskEncryptionSet --resource-group MyResourceGroup --source-vault MyVault + - name: Place the CLI in a waiting state until a condition of a managed disk is met. (autogenerated) + text: | + az disk wait --deleted --name MyManagedDisk --resource-group MyResourceGroup --subscription mysubscription crafted: true """ @@ -8984,7 +7906,8 @@ short-summary: Delete a disk encryption set. examples: - name: Delete a disk encryption set. (autogenerated) - text: az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup + text: | + az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup crafted: true """ @@ -8993,7 +7916,18 @@ short-summary: Get information of a disk encryption sets. examples: - name: Get information of a disk encryption sets (autogenerated) - text: az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup + text: | + az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup + crafted: true +""" + +aladdin_helps['disk-encryption-set update'] = """ +type: command +short-summary: Update a disk encryption set. +examples: + - name: Update a disk encryption set. (autogenerated) + text: | + az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault crafted: true """ @@ -9002,7 +7936,8 @@ short-summary: Delete image builder template. examples: - name: Delete image builder template. (autogenerated) - text: az image builder delete --name MyImageTemplate --resource-group MyResourceGroup + text: | + az image builder delete --name MyImageTemplate --resource-group MyResourceGroup crafted: true """ @@ -9046,50 +7981,15 @@ crafted: true """ -aladdin_helps['sig create'] = """ -type: command -short-summary: create a share image gallery. -examples: - - name: create a share image gallery. (autogenerated) - text: | - az sig create --gallery-name MyGallery --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['sig image-definition create'] = """ -type: command -short-summary: create a gallery image definition -examples: - - name: create a gallery image definition. (autogenerated) - text: az sig image-definition create --gallery-image-definition MyImage --gallery-name MyGallery --offer GreatOffer --os-state Generalized --os-type Windows --publisher GreatPublisher --resource-group MyResourceGroup --sku GreatSku - crafted: true -""" - -aladdin_helps['sig image-definition update'] = """ -type: command -short-summary: update a share image defintiion. -examples: - - name: update a share image defintiion. (autogenerated) - text: | - az sig image-definition update --gallery-image-definition MyImage --gallery-name MyGallery --resource-group MyResourceGroup - crafted: true -""" - -aladdin_helps['sig image-version update'] = """ -type: command -short-summary: update a share image version -examples: - - name: Update --exclude-from-latest. If it is set to true, people deploying VMs with version omitted will not use this version. (autogenerated) - text: az sig image-version update --gallery-image-definition MyImage --gallery-image-version 1.0.0 --gallery-name MyGallery --resource-group MyResourceGroup --set publishingProfile.excludeFromLatest=true - crafted: true -""" - aladdin_helps['sig image-version wait'] = """ type: command short-summary: wait for image version related operation examples: - name: wait for image version related operation. (autogenerated) - text: az sig image-version wait --created --gallery-image-definition MyImage --gallery-image-version 1.0.0 --gallery-name MyGallery --resource-group MyResourceGroup + text: | + az sig image-version wait --created --resource-group MyResourceGroup \\ + --gallery-name MyGallery --gallery-image-definition MyImage \\ + --gallery-image-version 1.0.0 crafted: true """ @@ -9142,7 +8042,7 @@ 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/) + 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: Enable the boot diagnostics on a VM. (autogenerated) text: | @@ -9163,7 +8063,7 @@ aladdin_helps['vm deallocate'] = """ type: command short-summary: Deallocate a VM. -long-summary: 'For an end-to-end tutorial, see https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-capture-image' +long-summary: 'For an end-to-end tutorial, see https://docs.microsoft.com/azure/virtual-machines/linux/capture-image' examples: - name: Deallocate a VM. (autogenerated) text: | @@ -9178,7 +8078,11 @@ examples: - name: Attach a managed persistent disk to a VM. (autogenerated) text: | - az vm disk attach --disk $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm + az vm disk attach --name $diskId --new --resource-group MyResourceGroup --size-gb 128 --sku Standard_LRS --vm-name MyVm + crafted: true + - name: Attach multiple managed disks to a VM. + text: | + az vm disk attach --vm-name MyVm --resource-group MyResourceGroup --sku Standard_LRS --disks diskId1 diskId2 diskId3 crafted: true """ @@ -9187,7 +8091,7 @@ 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. + For Windows VMs, disabling encryption is permitted on both OS and data volumes. examples: - name: Disable disk encryption on the OS disk and/or data disks. (autogenerated) text: | @@ -9201,7 +8105,7 @@ 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/azure-security-disk-encryption-overview + 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. @@ -9244,6 +8148,16 @@ crafted: true """ +aladdin_helps['vm host create'] = """ +type: command +short-summary: Create a dedicated host. +examples: + - name: Create a dedicated host (autogenerated) + text: | + az vm host create --auto-replace true --host-group my-host-group --license-type None --location eastasia --name my-host --resource-group my-resource-group --sku DSv3-Type1 + crafted: true +""" + aladdin_helps['vm host group create'] = """ type: command short-summary: Create a dedicated host group. @@ -9284,15 +8198,6 @@ crafted: true """ -aladdin_helps['vm host update'] = """ -type: command -short-summary: Update a dedicated host. -examples: - - name: Update a dedicated host. (autogenerated) - text: az vm host update --host-group my-host-group --name my-host --remove tags.tagName --resource-group my-resource-group - crafted: true -""" - aladdin_helps['vm identity show'] = """ type: command short-summary: display VM's managed identity info. @@ -9338,7 +8243,8 @@ short-summary: List the metric definitions for a VM. examples: - name: List the metric definitions for a VM. (autogenerated) - text: az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup + text: | + az vm monitor metrics list-definitions --name MyIDVirtualMachine --resource-group MyResourceGroup crafted: true """ @@ -9352,24 +8258,10 @@ crafted: true """ -aladdin_helps['vm run-command show'] = """ -type: command -parameters: - - name: --command-id - type: string - short-summary: The command id - populator-commands: - - az vm run-command list -examples: - - name: vm run-command show (autogenerated) - text: | - az vm run-command show --command-id RunShellScript --location westus2 - crafted: true -""" - aladdin_helps['vm secret add'] = """ 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`.' examples: - name: Add a secret to a VM. (autogenerated) text: | @@ -9465,7 +8357,7 @@ aladdin_helps['vmss encryption enable'] = """ type: command short-summary: "Encrypt a VMSS with managed disks." -long-summary: "For more information, see: For more information, see: https://docs.microsoft.com/azure/security/azure-security-disk-encryption-overview" +long-summary: "For more information, see: For more information, see: ttps://docs.microsoft.com/azure/security/fundamentals/azure-disk-encryption-vms-vmss" examples: - name: Encrypt a VMSS with managed disks. (autogenerated) text: | @@ -9519,7 +8411,6 @@ 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: | @@ -9553,7 +8444,8 @@ short-summary: List VMSS. examples: - name: List VMSS (autogenerated) - text: az vmss list --resource-group MyResourceGroup + text: | + az vmss list --resource-group MyResourceGroup crafted: true """ @@ -9600,21 +8492,6 @@ crafted: true """ -aladdin_helps['vmss run-command show'] = """ -type: command -parameters: - - name: --command-id - type: string - short-summary: The command id - populator-commands: - - az vmss run-command list -examples: - - name: vmss run-command show (autogenerated) - text: | - az vmss run-command show --command-id RunShellScript --location westus2 - crafted: true -""" - aladdin_helps['vmss scale'] = """ type: command short-summary: Change the number of VMs within a VMSS.