diff --git a/.openpublishing.redirection.delete-service-page.json b/.openpublishing.redirection.delete-service-page.json index dc424e17d4..5c2e6e3b0b 100644 --- a/.openpublishing.redirection.delete-service-page.json +++ b/.openpublishing.redirection.delete-service-page.json @@ -2169,6 +2169,21 @@ "source_path": "2017-03-09-profile/docs-ref-autogen/service-page/Microsoft.StorageCache.yml", "redirect_url": "/cli/azure/service-page/Storage%20Cache%20-%20AML%20file%20systems", "redirect_document_id": false + }, + { + "source_path": "2017-03-09-profile/docs-ref-autogen/service-page/Stack HCI VM.yml", + "redirect_url": "/cli/azure/service-page/Stack%20HCI", + "redirect_document_id": false + }, + { + "source_path": "2018-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml", + "redirect_url": "/cli/azure/service-page/Stack%20HCI", + "redirect_document_id": false + }, + { + "source_path": "latest/docs-ref-autogen/service-page/Stack HCI VM.yml", + "redirect_url": "/cli/azure/service-page/Stack%20HCI", + "redirect_document_id": false } ] } diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 2f5c5d3e14..71bb417588 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -155,6 +155,11 @@ "source_path":"docs-ref-conceptual/azure-cli-vm-tutorial.yml", "redirect_url":"/cli/azure/azure-cli-vm-tutorial-1", "redirect_document_id": false + }, + { + "source_path":"docs-ref-conceptual/create-an-azure-service-principal-azure-cli.md", + "redirect_url":"/cli/azure/azure-cli-sp-tutorial-1.md", + "redirect_document_id": false } ] } diff --git a/2017-03-09-profile/docs-ref-autogen/TOC.yml b/2017-03-09-profile/docs-ref-autogen/TOC.yml index 5f3811b92a..236a1974cd 100644 --- a/2017-03-09-profile/docs-ref-autogen/TOC.yml +++ b/2017-03-09-profile/docs-ref-autogen/TOC.yml @@ -434,6 +434,14 @@ uid: az_scvmm_vm_disk displayName: az scvmm vm disk items: [] + - name: extension + uid: az_scvmm_vm_extension + displayName: az scvmm vm extension + items: [] + - name: guest-agent + uid: az_scvmm_vm_guest-agent + displayName: az scvmm vm guest-agent + items: [] - name: nic uid: az_scvmm_vm_nic displayName: az scvmm vm nic @@ -3457,6 +3465,10 @@ uid: az_aks_egress-endpoints displayName: az aks egress-endpoints items: [] + - name: machine + uid: az_aks_machine + displayName: az aks machine + items: [] - name: maintenanceconfiguration uid: az_aks_maintenanceconfiguration displayName: az aks maintenanceconfiguration @@ -6684,10 +6696,6 @@ uid: az_stack-hci_extension displayName: az stack-hci extension items: [] - - name: Stack HCI VM - uid: sp-Stack_HCI_VM - displayName: Stack HCI VM - items: [] - name: Storage items: - name: Summary diff --git a/2017-03-09-profile/docs-ref-autogen/account.yml b/2017-03-09-profile/docs-ref-autogen/account.yml index 2785893928..c726ac59fe 100644 --- a/2017-03-09-profile/docs-ref-autogen/account.yml +++ b/2017-03-09-profile/docs-ref-autogen/account.yml @@ -132,14 +132,6 @@ directCommands: defaultValue: "False" summary: |- Retrieve up-to-date subscriptions from server. -- uid: az_account_list-locations() - name: az account list-locations - summary: |- - List supported regions for the current subscription. - status: GA - sourceType: Core - editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py - syntax: az account list-locations - uid: az_account_set() name: az account set summary: |- @@ -179,7 +171,6 @@ commands: - az_account_create(subscription) - az_account_get-access-token() - az_account_list() -- az_account_list-locations() - az_account_lock - az_account_lock_create() - az_account_lock_delete() diff --git a/2017-03-09-profile/docs-ref-autogen/account/lock.yml b/2017-03-09-profile/docs-ref-autogen/account/lock.yml index 8868f4e99e..65cc8fbba7 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/lock.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/lock.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure subscription level locks. diff --git a/2017-03-09-profile/docs-ref-autogen/account/management-group.yml b/2017-03-09-profile/docs-ref-autogen/account/management-group.yml index 4581a2922b..697a9365b8 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/management-group.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/management-group.yml @@ -257,5 +257,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure Management Groups. diff --git a/2017-03-09-profile/docs-ref-autogen/account/management-group/entities.yml b/2017-03-09-profile/docs-ref-autogen/account/management-group/entities.yml index 216e0bf65c..4e4e45263a 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/management-group/entities.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/management-group/entities.yml @@ -47,5 +47,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Entity operations (Management Group and Subscriptions) for Management Groups. diff --git a/2017-03-09-profile/docs-ref-autogen/account/management-group/hierarchy-settings.yml b/2017-03-09-profile/docs-ref-autogen/account/management-group/hierarchy-settings.yml index 1765ca90da..8273695000 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/management-group/hierarchy-settings.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/management-group/hierarchy-settings.yml @@ -177,5 +177,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy. diff --git a/2017-03-09-profile/docs-ref-autogen/account/management-group/subscription.yml b/2017-03-09-profile/docs-ref-autogen/account/management-group/subscription.yml index 572dfc76f3..523464ad76 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/management-group/subscription.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/management-group/subscription.yml @@ -130,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Subscription operations for Management Groups. diff --git a/2017-03-09-profile/docs-ref-autogen/account/management-group/tenant-backfill.yml b/2017-03-09-profile/docs-ref-autogen/account/management-group/tenant-backfill.yml index 037d92a58d..8d240dd236 100644 --- a/2017-03-09-profile/docs-ref-autogen/account/management-group/tenant-backfill.yml +++ b/2017-03-09-profile/docs-ref-autogen/account/management-group/tenant-backfill.yml @@ -62,5 +62,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Backfill Tenant Subscription Operations for Management Groups. diff --git a/2017-03-09-profile/docs-ref-autogen/aks.yml b/2017-03-09-profile/docs-ref-autogen/aks.yml index 6a1c17ad6e..b4342d6872 100644 --- a/2017-03-09-profile/docs-ref-autogen/aks.yml +++ b/2017-03-09-profile/docs-ref-autogen/aks.yml @@ -148,6 +148,7 @@ directCommands: [--http-proxy-config] [--image-cleaner-interval-hours] [--ip-families] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -206,7 +207,7 @@ directCommands: [--snapshot-id] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--vm-set-type] [--vnet-subnet-id] [--windows-admin-password] @@ -683,6 +684,10 @@ directCommands: A comma separated list of IP versions to use for cluster networking. description: |- Each IP version should be in the format IPvN. For example, IPv4. + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -932,7 +937,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA. - name: --vm-set-type @@ -1664,6 +1669,7 @@ directCommands: [--guardrails-version] [--http-proxy-config] [--image-cleaner-interval-hours] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -1691,7 +1697,7 @@ directCommands: [--rotation-poll-interval] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--update-cluster-autoscaler] [--upgrade-override-until] [--windows-admin-password] @@ -2138,6 +2144,10 @@ directCommands: summary: |- ImageCleaner scanning interval. isPreview: true + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -2256,7 +2266,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' changes a standard managed cluster to a free one. - name: --update-cluster-autoscaler -u @@ -2488,6 +2498,9 @@ commands: - az_aks_kanalyze(aks-preview) - az_aks_kollect(aks-preview) - az_aks_list(aks-preview) +- az_aks_machine +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) - az_aks_maintenanceconfiguration - az_aks_maintenanceconfiguration_add(aks-preview) - az_aks_maintenanceconfiguration_delete(aks-preview) diff --git a/2017-03-09-profile/docs-ref-autogen/aks/machine.yml b/2017-03-09-profile/docs-ref-autogen/aks/machine.yml new file mode 100644 index 0000000000..0562e9ba0f --- /dev/null +++ b/2017-03-09-profile/docs-ref-autogen/aks/machine.yml @@ -0,0 +1,92 @@ +### YamlMime:AzureCLIGroup +uid: az_aks_machine +name: az aks machine +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **aks-preview** extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an **az aks machine** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Get information about machines in a nodepool of a managed clusters. +status: GA +sourceType: Extension +directCommands: +- uid: az_aks_machine_list(aks-preview) + name: az aks machine list + summary: |- + Get information about IP Addresses, Hostname for all machines in an agentpool. + status: GA + sourceType: Extension + syntax: >- + az aks machine list --cluster-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_aks_machine_show(aks-preview) + name: az aks machine show + summary: |- + Show IP Addresses, Hostname for a specific machine in an agentpool for a managedcluster. + status: GA + sourceType: Extension + syntax: >- + az aks machine show --cluster-name + --machine-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --machine-name + summary: |- + Get IP Addresses, Hostname for a specific machine in an agentpool. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +commands: +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Get information about machines in a nodepool of a managed clusters. diff --git a/2017-03-09-profile/docs-ref-autogen/containerapp/connection.yml b/2017-03-09-profile/docs-ref-autogen/containerapp/connection.yml index c65eca91b8..62f0fe7ed2 100644 --- a/2017-03-09-profile/docs-ref-autogen/containerapp/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/containerapp/connection.yml @@ -12,6 +12,7 @@ directCommands: Delete a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection delete [--connection] [--id] @@ -38,14 +39,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -56,6 +57,7 @@ directCommands: List connections of a containerapp. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list [--name] [--resource-group] @@ -73,10 +75,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -86,6 +88,7 @@ directCommands: List source configurations of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list-configuration [--connection] [--id] @@ -110,16 +113,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_list-support-types() name: az containerapp connection list-support-types summary: |- List client types and auth types supported by containerapp connections. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: az containerapp connection list-support-types [--target-type {appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}] examples: - summary: |- @@ -139,6 +143,7 @@ directCommands: Get the details of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection show [--connection] [--id] @@ -163,16 +168,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_validate() name: az containerapp connection validate summary: |- Validate a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection validate [--connection] [--id] @@ -197,16 +203,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_wait() name: az containerapp connection wait summary: |- Place the CLI in a waiting state until a condition of the connection is met. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection wait [--connection] [--created] @@ -251,10 +258,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- @@ -344,4 +351,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Commands to manage containerapp connections. diff --git a/2017-03-09-profile/docs-ref-autogen/containerapp/connection/create.yml b/2017-03-09-profile/docs-ref-autogen/containerapp/connection/create.yml index b07b1e4f10..28f82f023d 100644 --- a/2017-03-09-profile/docs-ref-autogen/containerapp/connection/create.yml +++ b/2017-03-09-profile/docs-ref-autogen/containerapp/connection/create.yml @@ -12,6 +12,7 @@ directCommands: Create a containerapp connection to appconfig. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create appconfig [--app-config] [--client-type {dotnet, java, nodejs, none, python}] @@ -59,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -116,6 +117,7 @@ directCommands: Create a containerapp connection to confluent-cloud. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create confluent-cloud --bootstrap-server --kafka-key @@ -177,14 +179,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -197,6 +199,7 @@ directCommands: Create a containerapp connection to cosmos-cassandra. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-cassandra [--account] [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] @@ -249,7 +252,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -260,7 +263,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,6 +313,7 @@ directCommands: Create a containerapp connection to cosmos-gremlin. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-gremlin [--account] [--client-type {dotnet, java, nodejs, none, php, python}] @@ -366,7 +370,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -377,7 +381,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -427,6 +431,7 @@ directCommands: Create a containerapp connection to cosmos-mongo. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-mongo [--account] [--client-type {dotnet, go, java, nodejs, none, springBoot}] @@ -479,7 +484,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -490,7 +495,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -540,6 +545,7 @@ directCommands: Create a containerapp connection to cosmos-sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-sql [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -592,7 +598,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -603,7 +609,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -653,6 +659,7 @@ directCommands: Create a containerapp connection to cosmos-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-table [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -702,7 +709,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -713,7 +720,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -766,6 +773,7 @@ directCommands: Create a containerapp connection to eventhub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -811,7 +819,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -825,7 +833,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -875,6 +883,7 @@ directCommands: Create a containerapp connection to keyvault. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -926,7 +935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -942,7 +951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -992,6 +1001,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1038,7 +1048,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1049,7 +1059,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1087,6 +1097,7 @@ directCommands: Create a containerapp connection to mysql-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1132,14 +1143,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1182,6 +1193,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1236,7 +1248,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1252,7 +1264,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1295,6 +1307,7 @@ directCommands: Create a containerapp connection to postgres-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1340,14 +1353,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1386,6 +1399,7 @@ directCommands: Create a containerapp connection to redis. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1431,7 +1445,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1442,7 +1456,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1469,6 +1483,7 @@ directCommands: Create a containerapp connection to redis-enterprise. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1513,14 +1528,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1562,7 @@ directCommands: Create a containerapp connection to servicebus. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1592,7 +1608,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1606,7 +1622,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1656,6 +1672,7 @@ directCommands: Create a containerapp connection to signalr. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create signalr [--client-type {dotnet, none}] [--connection] @@ -1700,7 +1717,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1711,7 +1728,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1777,7 @@ directCommands: Create a containerapp connection to sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1807,7 +1825,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1818,7 +1836,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1861,6 +1879,7 @@ directCommands: Create a containerapp connection to storage-blob. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-blob [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -1916,7 +1935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1932,7 +1951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1982,6 +2001,7 @@ directCommands: Create a containerapp connection to storage-file. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-file [--account] [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] @@ -2027,7 +2047,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2038,7 +2058,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2066,6 +2086,7 @@ directCommands: Create a containerapp connection to storage-queue. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-queue [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -2114,7 +2135,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2125,7 +2146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2175,6 +2196,7 @@ directCommands: Create a containerapp connection to storage-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-table [--account] [--client-type {dotnet, java, nodejs, none, python}] @@ -2220,7 +2242,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2231,7 +2253,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2259,6 +2281,7 @@ directCommands: Create a containerapp connection to webpubsub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -2303,7 +2326,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2314,7 +2337,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2406,4 +2429,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Create a connection between a containerapp and a target resource. diff --git a/2017-03-09-profile/docs-ref-autogen/containerapp/connection/update.yml b/2017-03-09-profile/docs-ref-autogen/containerapp/connection/update.yml index 374cae2ad2..11afda4188 100644 --- a/2017-03-09-profile/docs-ref-autogen/containerapp/connection/update.yml +++ b/2017-03-09-profile/docs-ref-autogen/containerapp/connection/update.yml @@ -12,6 +12,7 @@ directCommands: Update a containerapp to appconfig connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update appconfig [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -53,7 +54,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -64,7 +65,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -101,6 +102,7 @@ directCommands: Update a containerapp to confluent-cloud connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update confluent-cloud --connection [--bootstrap-server] @@ -153,14 +155,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -182,6 +184,7 @@ directCommands: Update a containerapp to cosmos-cassandra connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-cassandra [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -224,7 +227,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -235,7 +238,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -276,6 +279,7 @@ directCommands: Update a containerapp to cosmos-gremlin connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-gremlin [--client-type {dotnet, java, nodejs, none, php, python}] [--connection] @@ -318,7 +322,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -329,7 +333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -370,6 +374,7 @@ directCommands: Update a containerapp to cosmos-mongo connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-mongo [--client-type {dotnet, go, java, nodejs, none, springBoot}] [--connection] @@ -412,7 +417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -423,7 +428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -464,6 +469,7 @@ directCommands: Update a containerapp to cosmos-sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-sql [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -506,7 +512,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -517,7 +523,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -558,6 +564,7 @@ directCommands: Update a containerapp to cosmos-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-table [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -600,7 +607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -611,7 +618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,6 +659,7 @@ directCommands: Update a containerapp to eventhub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -694,7 +702,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -705,7 +713,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -746,6 +754,7 @@ directCommands: Update a containerapp to keyvault connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -787,7 +796,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -798,7 +807,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,6 +845,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -875,7 +885,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -886,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -912,6 +922,7 @@ directCommands: Update a containerapp to mysql-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -950,14 +961,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -988,6 +999,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1028,7 +1040,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1039,7 +1051,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1070,6 +1082,7 @@ directCommands: Update a containerapp to postgres-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1108,14 +1121,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,6 +1155,7 @@ directCommands: Update a containerapp to redis connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1180,7 +1194,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1191,7 +1205,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1206,6 +1220,7 @@ directCommands: Update a containerapp to redis-enterprise connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1243,14 +1258,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1265,6 +1280,7 @@ directCommands: Update a containerapp to servicebus connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1307,7 +1323,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1318,7 +1334,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1359,6 +1375,7 @@ directCommands: Update a containerapp to signalr connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update signalr [--client-type {dotnet, none}] [--connection] @@ -1400,7 +1417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1411,7 +1428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1448,6 +1465,7 @@ directCommands: Update a containerapp to sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1488,7 +1506,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1499,7 +1517,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1530,6 +1548,7 @@ directCommands: Update a containerapp to storage-blob connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-blob [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1572,7 +1591,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1583,7 +1602,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1624,6 +1643,7 @@ directCommands: Update a containerapp to storage-file connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-file [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1663,7 +1683,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1674,7 +1694,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1693,6 +1713,7 @@ directCommands: Update a containerapp to storage-queue connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-queue [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1735,7 +1756,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1746,7 +1767,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1787,6 +1808,7 @@ directCommands: Update a containerapp to storage-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-table [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1826,7 +1848,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1837,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1856,6 +1878,7 @@ directCommands: Update a containerapp to webpubsub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1897,7 +1920,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1908,7 +1931,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1988,4 +2011,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Update a containerapp connection. diff --git a/2017-03-09-profile/docs-ref-autogen/deployment.yml b/2017-03-09-profile/docs-ref-autogen/deployment.yml index b16942ca94..6122ba6a2a 100644 --- a/2017-03-09-profile/docs-ref-autogen/deployment.yml +++ b/2017-03-09-profile/docs-ref-autogen/deployment.yml @@ -44,5 +44,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2017-03-09-profile/docs-ref-autogen/deployment/group.yml b/2017-03-09-profile/docs-ref-autogen/deployment/group.yml index a896fda216..a5b8c76962 100644 --- a/2017-03-09-profile/docs-ref-autogen/deployment/group.yml +++ b/2017-03-09-profile/docs-ref-autogen/deployment/group.yml @@ -77,8 +77,8 @@ directCommands: Create a deployment at resource group scope from a template-spec syntax: az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0" - summary: |- - Create a deployment at resource group scope from a bicep template and a bicepparam parameter file - syntax: az deployment group create --resource-group testrg --template-file azuredeploy.bicep --parameters parameters.bicepparam + Create a deployment at resource group scope from a bicepparam parameter file + syntax: az deployment group create --resource-group testrg --parameters parameters.bicepparam - summary: |- Create a deployment at resource group across tenants syntax: >- @@ -124,7 +124,7 @@ directCommands: summary: |- Supply deployment parameter values. description: |- - 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. Also note if you are providing a bicepparam file with a bicep template then you can use this argument only once. + 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. Also note if you are providing a bicepparam file then you can use this argument only once. - name: --query-string -q summary: |- The query string (a SAS token) to be used with the template-uri in the case of linked templates. @@ -396,5 +396,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at resource group. diff --git a/2017-03-09-profile/docs-ref-autogen/deployment/operation.yml b/2017-03-09-profile/docs-ref-autogen/deployment/operation.yml index 4ef7c551e4..33426c4202 100644 --- a/2017-03-09-profile/docs-ref-autogen/deployment/operation.yml +++ b/2017-03-09-profile/docs-ref-autogen/deployment/operation.yml @@ -34,5 +34,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2017-03-09-profile/docs-ref-autogen/deployment/operation/group.yml b/2017-03-09-profile/docs-ref-autogen/deployment/operation/group.yml index c950e10e53..f2ba339664 100644 --- a/2017-03-09-profile/docs-ref-autogen/deployment/operation/group.yml +++ b/2017-03-09-profile/docs-ref-autogen/deployment/operation/group.yml @@ -81,5 +81,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at resource group. diff --git a/2017-03-09-profile/docs-ref-autogen/dt/model.yml b/2017-03-09-profile/docs-ref-autogen/dt/model.yml index a96d5da72b..583a66b870 100644 --- a/2017-03-09-profile/docs-ref-autogen/dt/model.yml +++ b/2017-03-09-profile/docs-ref-autogen/dt/model.yml @@ -132,7 +132,7 @@ directCommands: List model definitions syntax: az dt model list -n {instance_or_hostname} --definition - summary: |- - List dependencies of particular pre-existing model(s). Space seperate dtmi values. + List dependencies of particular pre-existing model(s). Space separate dtmi values. syntax: az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1} requiredParameters: - isRequired: true diff --git a/2017-03-09-profile/docs-ref-autogen/dt/network/private-endpoint/connection.yml b/2017-03-09-profile/docs-ref-autogen/dt/network/private-endpoint/connection.yml index 3d46f29499..c1e786c25d 100644 --- a/2017-03-09-profile/docs-ref-autogen/dt/network/private-endpoint/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/dt/network/private-endpoint/connection.yml @@ -117,7 +117,7 @@ directCommands: Description for the private endpoint connection. - name: --group-ids summary: |- - Space seperated list of group ids that the private endpoint should connect to. + Space separated list of group ids that the private endpoint should connect to. - name: --no-wait defaultValue: "False" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/functionapp/connection.yml b/2017-03-09-profile/docs-ref-autogen/functionapp/connection.yml index 5aa7711ce5..67a0d992a8 100644 --- a/2017-03-09-profile/docs-ref-autogen/functionapp/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/functionapp/connection.yml @@ -43,14 +43,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -79,10 +79,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -117,10 +117,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_list-support-types() name: az functionapp connection list-support-types summary: |- @@ -172,10 +172,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_validate() name: az functionapp connection validate summary: |- @@ -207,10 +207,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_wait() name: az functionapp connection wait summary: |- @@ -262,10 +262,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/functionapp/connection/create.yml b/2017-03-09-profile/docs-ref-autogen/functionapp/connection/create.yml index e92790c539..3767dae0bc 100644 --- a/2017-03-09-profile/docs-ref-autogen/functionapp/connection/create.yml +++ b/2017-03-09-profile/docs-ref-autogen/functionapp/connection/create.yml @@ -60,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -71,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -175,14 +175,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -244,7 +244,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -255,7 +255,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +358,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -369,7 +369,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -468,7 +468,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -479,7 +479,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -578,7 +578,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -589,7 +589,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -685,7 +685,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -696,7 +696,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -791,7 +791,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -805,7 +805,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -903,7 +903,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -919,7 +919,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1012,7 +1012,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1023,7 +1023,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1103,14 +1103,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1194,14 +1194,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1299,7 +1299,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1315,7 +1315,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1410,7 +1410,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1426,7 +1426,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1515,14 +1515,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1604,14 +1604,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1696,7 +1696,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1707,7 +1707,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1775,14 +1775,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1851,7 +1851,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1865,7 +1865,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +1956,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1967,7 +1967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2060,7 +2060,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2071,7 +2071,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2159,7 +2159,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2170,7 +2170,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2269,7 +2269,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2285,7 +2285,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2377,7 +2377,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2388,7 +2388,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2461,7 +2461,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2472,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2564,7 +2564,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2575,7 +2575,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2644,7 +2644,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2655,7 +2655,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/functionapp/connection/update.yml b/2017-03-09-profile/docs-ref-autogen/functionapp/connection/update.yml index 38d4dd2445..5f86ae02ef 100644 --- a/2017-03-09-profile/docs-ref-autogen/functionapp/connection/update.yml +++ b/2017-03-09-profile/docs-ref-autogen/functionapp/connection/update.yml @@ -50,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -61,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -151,14 +151,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -219,7 +219,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -230,7 +230,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,7 +310,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -321,7 +321,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -401,7 +401,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -412,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -492,7 +492,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -503,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -583,7 +583,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -594,7 +594,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -674,7 +674,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -685,7 +685,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -764,7 +764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -775,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -849,7 +849,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -860,7 +860,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -921,14 +921,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -996,7 +996,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1007,7 +1007,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1073,14 +1073,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,7 +1142,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1153,7 +1153,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1202,14 +1202,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1263,7 +1263,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1274,7 +1274,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1353,7 +1353,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1364,7 +1364,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1438,7 +1438,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1449,7 +1449,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1519,7 +1519,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1530,7 +1530,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,7 +1607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1618,7 +1618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1676,7 +1676,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1687,7 +1687,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1764,7 +1764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1775,7 +1775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1832,7 +1832,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1843,7 +1843,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/group.yml b/2017-03-09-profile/docs-ref-autogen/group.yml index 630367797c..6ea310edbd 100644 --- a/2017-03-09-profile/docs-ref-autogen/group.yml +++ b/2017-03-09-profile/docs-ref-autogen/group.yml @@ -292,5 +292,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource groups and template deployments. diff --git a/2017-03-09-profile/docs-ref-autogen/group/deployment.yml b/2017-03-09-profile/docs-ref-autogen/group/deployment.yml index b4663ed3d3..6e85b592cb 100644 --- a/2017-03-09-profile/docs-ref-autogen/group/deployment.yml +++ b/2017-03-09-profile/docs-ref-autogen/group/deployment.yml @@ -372,5 +372,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager deployments. diff --git a/2017-03-09-profile/docs-ref-autogen/group/deployment/operation.yml b/2017-03-09-profile/docs-ref-autogen/group/deployment/operation.yml index 16ee70f061..4dca13f994 100644 --- a/2017-03-09-profile/docs-ref-autogen/group/deployment/operation.yml +++ b/2017-03-09-profile/docs-ref-autogen/group/deployment/operation.yml @@ -88,5 +88,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations. diff --git a/2017-03-09-profile/docs-ref-autogen/group/lock.yml b/2017-03-09-profile/docs-ref-autogen/group/lock.yml index 6190f384ce..9862bfbf29 100644 --- a/2017-03-09-profile/docs-ref-autogen/group/lock.yml +++ b/2017-03-09-profile/docs-ref-autogen/group/lock.yml @@ -178,5 +178,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource group locks. diff --git a/2017-03-09-profile/docs-ref-autogen/iot/du/account.yml b/2017-03-09-profile/docs-ref-autogen/iot/du/account.yml index bb80295b1a..60982b150f 100644 --- a/2017-03-09-profile/docs-ref-autogen/iot/du/account.yml +++ b/2017-03-09-profile/docs-ref-autogen/iot/du/account.yml @@ -43,7 +43,7 @@ directCommands: Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor. syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount - summary: |- - Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-seperated) with a custom specified role. + Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role. syntax: >- az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1 /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2 diff --git a/2017-03-09-profile/docs-ref-autogen/iot/hub/device-identity/children.yml b/2017-03-09-profile/docs-ref-autogen/iot/hub/device-identity/children.yml index 9c24473ee3..ffe8446d6a 100644 --- a/2017-03-09-profile/docs-ref-autogen/iot/hub/device-identity/children.yml +++ b/2017-03-09-profile/docs-ref-autogen/iot/hub/device-identity/children.yml @@ -114,7 +114,7 @@ directCommands: [--resource-group] examples: - summary: |- - Remove a space-seperated list of child devices from a target parent device. + Remove a space-separated list of child devices from a target parent device. syntax: az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name} - summary: |- Remove all child devices from a target parent device. diff --git a/2017-03-09-profile/docs-ref-autogen/lock.yml b/2017-03-09-profile/docs-ref-autogen/lock.yml index eda6357072..16bc620028 100644 --- a/2017-03-09-profile/docs-ref-autogen/lock.yml +++ b/2017-03-09-profile/docs-ref-autogen/lock.yml @@ -284,5 +284,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure locks. diff --git a/2017-03-09-profile/docs-ref-autogen/managedapp.yml b/2017-03-09-profile/docs-ref-autogen/managedapp.yml index eda87aefc3..796ed5b7a6 100644 --- a/2017-03-09-profile/docs-ref-autogen/managedapp.yml +++ b/2017-03-09-profile/docs-ref-autogen/managedapp.yml @@ -187,5 +187,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage template solutions provided and maintained by Independent Software Vendors (ISVs). diff --git a/2017-03-09-profile/docs-ref-autogen/managedapp/definition.yml b/2017-03-09-profile/docs-ref-autogen/managedapp/definition.yml index 4bf603ef13..bff48d2565 100644 --- a/2017-03-09-profile/docs-ref-autogen/managedapp/definition.yml +++ b/2017-03-09-profile/docs-ref-autogen/managedapp/definition.yml @@ -272,5 +272,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Managed Applications. diff --git a/2017-03-09-profile/docs-ref-autogen/policy.yml b/2017-03-09-profile/docs-ref-autogen/policy.yml index 0c984b3d74..b8ac9b4150 100644 --- a/2017-03-09-profile/docs-ref-autogen/policy.yml +++ b/2017-03-09-profile/docs-ref-autogen/policy.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policies. diff --git a/2017-03-09-profile/docs-ref-autogen/policy/assignment.yml b/2017-03-09-profile/docs-ref-autogen/policy/assignment.yml index 9b2036b114..f4f36e3f57 100644 --- a/2017-03-09-profile/docs-ref-autogen/policy/assignment.yml +++ b/2017-03-09-profile/docs-ref-autogen/policy/assignment.yml @@ -208,5 +208,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy assignments. diff --git a/2017-03-09-profile/docs-ref-autogen/policy/definition.yml b/2017-03-09-profile/docs-ref-autogen/policy/definition.yml index cd26e063d0..db131eb7a6 100644 --- a/2017-03-09-profile/docs-ref-autogen/policy/definition.yml +++ b/2017-03-09-profile/docs-ref-autogen/policy/definition.yml @@ -216,5 +216,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy definitions. diff --git a/2017-03-09-profile/docs-ref-autogen/postgres/server-arc/endpoint.yml b/2017-03-09-profile/docs-ref-autogen/postgres/server-arc/endpoint.yml index 9ab9816d44..52b1b32df5 100644 --- a/2017-03-09-profile/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/2017-03-09-profile/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -21,22 +21,20 @@ directCommands: previewOrExperimentalInfo: "Command group 'postgres server-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az postgres server-arc endpoint list --name - [--k8s-namespace] + az postgres server-arc endpoint list [--k8s-namespace] + [--name] [--use-k8s] examples: - summary: |- List Azure Arc enabled PostgreSQL server endpoints. syntax: az postgres server-arc endpoint list --name postgres01 --k8s-namespace namespace --use-k8s - requiredParameters: - - isRequired: true - name: --name -n - summary: |- - Name of the Azure Arc enabled PostgreSQL server. optionalParameters: - name: --k8s-namespace -k summary: |- The Kubernetes namespace where the Azure Arc enabled PostgreSQL server is deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used. + - name: --name -n + summary: |- + Name of the Azure Arc enabled PostgreSQL server. - name: --use-k8s summary: |- Use local Kubernetes APIs to perform this action. diff --git a/2017-03-09-profile/docs-ref-autogen/provider.yml b/2017-03-09-profile/docs-ref-autogen/provider.yml index b855820555..68ff224c3f 100644 --- a/2017-03-09-profile/docs-ref-autogen/provider.yml +++ b/2017-03-09-profile/docs-ref-autogen/provider.yml @@ -139,5 +139,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource providers. diff --git a/2017-03-09-profile/docs-ref-autogen/provider/operation.yml b/2017-03-09-profile/docs-ref-autogen/provider/operation.yml index 518ec011a4..6544ce6305 100644 --- a/2017-03-09-profile/docs-ref-autogen/provider/operation.yml +++ b/2017-03-09-profile/docs-ref-autogen/provider/operation.yml @@ -59,5 +59,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get provider operations metadatas. diff --git a/2017-03-09-profile/docs-ref-autogen/provider/permission.yml b/2017-03-09-profile/docs-ref-autogen/provider/permission.yml index 95846fb713..b5f93b9261 100644 --- a/2017-03-09-profile/docs-ref-autogen/provider/permission.yml +++ b/2017-03-09-profile/docs-ref-autogen/provider/permission.yml @@ -46,5 +46,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage permissions for a provider. diff --git a/2017-03-09-profile/docs-ref-autogen/resource-mover.yml b/2017-03-09-profile/docs-ref-autogen/resource-mover.yml index 3c5aa44f8e..1d9ccf7ffc 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource-mover.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource-mover.yml @@ -4,12 +4,10 @@ name: az resource-mover extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage Resource Mover Service API. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Extension commands: - az_resource-mover_move-collection diff --git a/2017-03-09-profile/docs-ref-autogen/resource-mover/move-collection.yml b/2017-03-09-profile/docs-ref-autogen/resource-mover/move-collection.yml index 6b7c846932..dc729bc40b 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource-mover/move-collection.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource-mover/move-collection.yml @@ -4,31 +4,29 @@ name: az resource-mover move-collection extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-collection. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-collection_bulk-remove(resource-mover) name: az resource-mover move-collection bulk-remove summary: |- - Remove the set of move-resources from move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection bulk-remove [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] [--move-resources] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Remove a move-resource in a move-collection. @@ -40,53 +38,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - Name of the move-collection. + The Move Collection Name. - name: --move-resources summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_commit(resource-mover) name: az resource-mover move-collection commit summary: |- - Commit the set of resources. The commit operation is triggered on the move-resources in the move-state 'CommitPending' or 'CommitFailed', on a successful completion the move-resource's move-state do a transition to Committed. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection commit --move-resources - [--ids] + az resource-mover move-collection commit [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Commit a move-resource. + Commit a move-resource in the move-collection (RegionToRegion) syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Commit resources in the move-collection (RegionToZone) + syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -94,87 +90,100 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_create(resource-mover) name: az resource-mover move-collection create summary: |- - Create a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a move collection. + description: |- + Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- az resource-mover move-collection create --move-collection-name --resource-group [--identity] [--location] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] [--source-region] [--tags] [--target-region] + [--version] examples: - summary: |- - Create a move-collection with system assigned identity. + Create a move-collection with system assigned identity. (RegionToRegion) syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Create a zonal type move-collection with system assigned identity. (RegionToZone) + syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone requiredParameters: - isRequired: true name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + The geo-location where the resource lives. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. - name: --source-region summary: |- - The source region. + Gets or sets the source region. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --target-region summary: |- - The target region. + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_delete(resource-mover) name: az resource-mover move-collection delete summary: |- - Delete a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a move collection. + description: |- + The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection delete [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -188,14 +197,14 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -206,29 +215,24 @@ directCommands: - uid: az_resource-mover_move-collection_discard(resource-mover) name: az resource-mover move-collection discard summary: |- - Discard the set of resources. The discard operation is triggered on the move-resources in the move-state 'CommitPending' or 'DiscardFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection discard --move-resources - [--ids] + az resource-mover move-collection discard [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Discard a remove-resource. syntax: az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -236,50 +240,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_initiate-move(resource-mover) name: az resource-mover move-collection initiate-move summary: |- - Move the set of resources. The move operation is triggered after the move-resources are in the move-state 'MovePending' or 'MoveFailed', on a successful completion the move-resource's move-state do a transition to CommitPending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection initiate-move --move-resources - [--ids] + az resource-mover move-collection initiate-move [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Move the set of resources. + Move the set of resources. (RegionToRegion) syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Move VMs into zonal configuration within the same region (RegionToZone) + syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -287,33 +292,39 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_list(resource-mover) name: az resource-mover move-collection list summary: |- - List details of the move-collections. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List all the Move Collections in the subscription. + description: |- + The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension - syntax: az resource-mover move-collection list [--resource-group] + syntax: >- + az resource-mover move-collection list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all move-collections. @@ -322,94 +333,114 @@ directCommands: List all move-collections by resource group. syntax: az resource-mover move-collection list -g MyResourceGroup optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - uid: az_resource-mover_move-collection_list-required-for(resource-mover) name: az resource-mover move-collection list-required-for summary: |- - List the move-resources for which an arm resource is required for. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List of the move resources for which an arm resource is required for. + description: |- + The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection list-required-for --move-collection-name - --resource-group - --source-id - examples: - - summary: |- - List the move-resources for which an arm resource is required for. - syntax: az resource-mover move-collection list-required-for --name MyMoveCollection --resource-group MyResourceGroup --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/nic1" + az resource-mover move-collection list-required-for --source-id + [--ids] + [--move-collection-name] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true - name: --move-collection-name --name -n + name: --source-id + summary: |- + The sourceId for which the api is invoked. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name --name -n summary: |- The Move Collection Name. - - isRequired: true - name: --resource-group -g + - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --source-id + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --subscription summary: |- - The sourceId for which the api is invoked. + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_list-unresolved-dependency(resource-mover) name: az resource-mover move-collection list-unresolved-dependency summary: |- - List the details of the unresolved dependencies in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Lists a list of unresolved dependencies. + description: |- + The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection list-unresolved-dependency --move-collection-name --resource-group [--dependency-level {Descendant, Direct}] + [--filter] + [--max-items] + [--next-token] + [--orderby] examples: - summary: |- List the unresolved dependencies. syntax: az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --dependency-level parameterValueGroup: "Descendant, Direct" summary: |- - The dependency level. + Defines the dependency level. + - name: --filter + summary: |- + The filter to apply on the operation. For example, $apply=filter(count eq 2). + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. + - name: --orderby + summary: |- + OData order by query option. For example, you can use $orderby=Count desc. - uid: az_resource-mover_move-collection_prepare(resource-mover) name: az resource-mover move-collection prepare summary: |- - Prepare the set of resources. The prepare operation is on the move-resources that are in the move-state 'PreparePending' or 'PrepareFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection prepare --move-resources - [--ids] + az resource-mover move-collection prepare [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Prepare a move-resource. syntax: az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -417,66 +448,72 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_resolve-dependency(resource-mover) name: az resource-mover move-collection resolve-dependency summary: |- - Compute, resolve and validate the dependencies of the move-resources in the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Computes, resolves and validate the dependencies of the moveResources in the move collection. + description: |- + Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection resolve-dependency [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] examples: - summary: |- - Resolve the dependency of the move-resources. + Resolve the dependency of the move-resources. (RegionToRegion) syntax: az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Resolve the dependency of the move-resources. (RegionToZone) + syntax: az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_show(resource-mover) name: az resource-mover move-collection show summary: |- - Get the details of a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the move collection. + description: |- + The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection show [--ids] @@ -493,64 +530,94 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_update(resource-mover) name: az resource-mover move-collection update summary: |- - Update a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Update a move collection. + description: |- + Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection update [--identity] + az resource-mover move-collection update [--add] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--identity] [--ids] [--move-collection-name] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] + [--remove] [--resource-group] + [--set] + [--source-region] [--subscription] [--tags] + [--target-region] + [--version] examples: - summary: |- Update a move-collection. syntax: az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup optionalParameters: + - name: --add + summary: |- + Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --force-string + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. + - name: --remove + summary: |- + Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --set + summary: |- + Update an object by specifying a property path and value to set. Example: --set property1.property2=. + - name: --source-region + summary: |- + Gets or sets the source region. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --target-region + summary: |- + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_wait(resource-mover) name: az resource-mover move-collection wait summary: |- - Place the CLI in a waiting state until a condition of the move-collection is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection wait [--created] @@ -564,13 +631,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully deleted. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --deleted - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully created. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --created optionalParameters: - name: --created defaultValue: "False" @@ -596,10 +656,10 @@ directCommands: Polling interval in seconds. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2017-03-09-profile/docs-ref-autogen/resource-mover/move-resource.yml b/2017-03-09-profile/docs-ref-autogen/resource-mover/move-resource.yml index 3f887cf77d..a1af1c1331 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource-mover/move-resource.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource-mover/move-resource.yml @@ -4,118 +4,86 @@ name: az resource-mover move-resource extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-resource. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-resource_add(resource-mover) name: az resource-mover move-resource add summary: |- - Create or update a move-resource to the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a Move Resource in the move collection. + description: |- + The 'az resource-mover move-resource add' command remains same for both 'RegionToRegion' (default) and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-resource add --move-collection-name - --move-resource-name - --resource-group - [--depends-on-overrides] + az resource-mover move-resource add [--depends-on-overrides] [--existing-target-id] - [--no-wait] + [--ids] + [--move-collection-name] + [--move-resource-name] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] + [--resource-group] [--resource-settings] [--source-id] + [--subscription] examples: - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings '{ - "resourceType": "Microsoft.Network/virtualNetworks", - "targetResourceName": "MyVNet-target" - }' + Add a vNet as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet\" --resource-settings '{ \"resourceType\": \"Microsoft.Network/virtualNetworks\", \"targetResourceName\": \"MyVNet-target\" }'" - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings @resource-settings.json + Add a VM as a move-resource to the move-collection. (RegionToZone) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyZonalMoveCollection --name MyVMMoveResource --source-id \"/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetResourceName\": \"MyVM\", \"targetAvailabilityZone\": \"2\", \"targetVmSize\": \"Standard_B2s\" }'" - summary: |- - Add a VM as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM" - - --depends-on-overrides id="/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" target-id="/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" - - --resource-settings '{ - "resourceType": "Microsoft.Compute/virtualMachines", - "targetAvailabilitySetId": "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet", - "targetAvailabilityZone": "2", - "targetResourceName": "MyVM-target", - "targetVmSize": null, - "userManagedIdentities": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] - }' - requiredParameters: - - isRequired: true - name: --move-collection-name - summary: |- - The move-collection name. - - isRequired: true - name: --move-resource-name --name -n - summary: |- - The move-resource name. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Add a VM as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM\" --depends-on-overrides id=\"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" target-id=\"/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetAvailabilitySetId\": \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet\", \"targetAvailabilityZone\": \"2\", \"targetResourceName\": \"MyVM-target\", \"targetVmSize\": null, \"userManagedIdentities\": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] }'" optionalParameters: - name: --depends-on-overrides summary: |- - The move-resource dependencies overrides. - description: |- - Usage: --depends-on-overrides id=XX target-id=XX - - id: The ARM ID of the dependent resource. - target-id: The resource ARM ID of either the move-resource or the resource ARM ID of the dependent resource. - - Multiple actions can be specified by using more than one --depends-on-overrides argument. + Gets or sets the move resource dependencies overrides. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --existing-target-id summary: |- - The existing target ARM Id of the resource. + Gets or sets the existing target ARM Id of the resource. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name + summary: |- + The Move Collection Name. + - name: --move-resource-name --name -n + summary: |- + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --resource-settings summary: |- - The resource settings. Expected value: json-string/@json-file. + The resource settings. Expected value: json-string/@json-file. Support json-file and yaml-file. - name: --source-id summary: |- - The Source ARM Id of the resource. + Gets or sets the Source ARM Id of the resource. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_delete(resource-mover) name: az resource-mover move-resource delete summary: |- - Delete a move-resource from the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a Move Resource from the move collection. + description: |- + The 'az resource-mover move-resource delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource delete [--ids] [--move-collection-name] [--move-resource-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -129,17 +97,17 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -150,34 +118,47 @@ directCommands: - uid: az_resource-mover_move-resource_list(resource-mover) name: az resource-mover move-resource list summary: |- - List the move-resources in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List the Move Resources in the move collection. + description: |- + The 'az resource-mover move-resource list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource list --move-collection-name --resource-group + [--filter] + [--max-items] + [--next-token] examples: - summary: |- List the move-resources in a move-collection. syntax: az resource-mover move-resource list --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + optionalParameters: + - name: --filter + summary: |- + The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_resource-mover_move-resource_show(resource-mover) name: az resource-mover move-resource show summary: |- - Get the details of a move-resource. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the Move Resource. + description: |- + The 'az resource-mover move-resource show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource show [--ids] @@ -195,23 +176,21 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_wait(resource-mover) name: az resource-mover move-resource wait summary: |- - Place the CLI in a waiting state until a condition of the move-resource is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource wait [--created] @@ -226,13 +205,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully created. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --created - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully deleted. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --deleted optionalParameters: - name: --created defaultValue: "False" @@ -258,13 +230,13 @@ directCommands: Polling interval in seconds. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2017-03-09-profile/docs-ref-autogen/resource.yml b/2017-03-09-profile/docs-ref-autogen/resource.yml index 135aabce03..6b769beb7f 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource.yml @@ -732,5 +732,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resources. diff --git a/2017-03-09-profile/docs-ref-autogen/resource/link.yml b/2017-03-09-profile/docs-ref-autogen/resource/link.yml index f2b488a62a..6be731ae36 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource/link.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource/link.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Linking is a feature of the Resource Manager. It enables declaring relationships between resources even if they do not reside in the same resource group. Linking has no impact on resource usage, billing, or role-based access. It allows for managing multiple resources across groups as a single unit. diff --git a/2017-03-09-profile/docs-ref-autogen/resource/lock.yml b/2017-03-09-profile/docs-ref-autogen/resource/lock.yml index 55f2453025..b542c25008 100644 --- a/2017-03-09-profile/docs-ref-autogen/resource/lock.yml +++ b/2017-03-09-profile/docs-ref-autogen/resource/lock.yml @@ -267,5 +267,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource level locks. diff --git a/2017-03-09-profile/docs-ref-autogen/scvmm.yml b/2017-03-09-profile/docs-ref-autogen/scvmm.yml index c68bc47dce..d32b42e906 100644 --- a/2017-03-09-profile/docs-ref-autogen/scvmm.yml +++ b/2017-03-09-profile/docs-ref-autogen/scvmm.yml @@ -52,6 +52,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2017-03-09-profile/docs-ref-autogen/scvmm/vm.yml b/2017-03-09-profile/docs-ref-autogen/scvmm/vm.yml index 56f846f67d..452bb2d8c2 100644 --- a/2017-03-09-profile/docs-ref-autogen/scvmm/vm.yml +++ b/2017-03-09-profile/docs-ref-autogen/scvmm/vm.yml @@ -22,7 +22,6 @@ directCommands: sourceType: Extension syntax: >- az scvmm vm create --custom-location - --location --name --resource-group [--admin-password] @@ -34,6 +33,7 @@ directCommands: [--dynamic-memory-max] [--dynamic-memory-min] [--inventory-item] + [--location] [--memory-size] [--nic] [--no-wait] @@ -55,10 +55,6 @@ directCommands: name: --custom-location summary: |- Name or ID of the custom location that will manage this resource. - - isRequired: true - name: --location -l - summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - isRequired: true name: --name -n summary: |- @@ -96,6 +92,9 @@ directCommands: - name: --inventory-item -i summary: |- Name or ID of the inventory item. + - name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - name: --memory-size summary: |- Desired memory size in MBs for the vm. @@ -170,13 +169,13 @@ directCommands: previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az scvmm vm delete [--deleteFromHost] + az scvmm vm delete [--delete-from-host] + [--delete-machine] [--force] [--ids] [--name] [--no-wait] [--resource-group] - [--retain] [--subscription] [--yes] examples: @@ -196,12 +195,15 @@ directCommands: Delete the VM from SCVMM syntax: az scvmm vm delete --subscription contoso-sub --resource-group contoso-rg --name contoso-avset --deleteFromHost optionalParameters: - - name: --deleteFromHost + - name: --delete-from-host summary: |- - Delete the VM from the SCVMM. + Delete the VM from the VMware host. + - name: --delete-machine + summary: |- + Delete the parent Microsoft.HybridCompute Machine resource. - name: --force summary: |- - Force the resource to be deleted from azure. + Force delete the azure resource. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -215,9 +217,6 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --retain - summary: |- - Disable the VM from azure but retain the VM in VMM. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -270,8 +269,10 @@ directCommands: name: az scvmm vm list summary: |- Retrieve a list of VMs. - status: Preview + status: Preview and Deprecated + isDeprecated: true isPreview: true + deprecateInfo: This command has been deprecated and will be removed in a future release. Use 'scvmm vm show' instead. previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: az scvmm vm list [--resource-group] @@ -467,7 +468,6 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --skip-shutdown - defaultValue: "False" parameterValueGroup: "false, true" summary: |- Skip shutdown and power-off immediately. @@ -605,6 +605,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2017-03-09-profile/docs-ref-autogen/scvmm/vm/extension.yml b/2017-03-09-profile/docs-ref-autogen/scvmm/vm/extension.yml new file mode 100644 index 0000000000..e868aabd26 --- /dev/null +++ b/2017-03-09-profile/docs-ref-autogen/scvmm/vm/extension.yml @@ -0,0 +1,304 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_extension +name: az scvmm vm extension +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Manage vm extension with scvmm. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_extension_create(scvmm) + name: az scvmm vm extension create + summary: |- + The operation to create the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension create --location + --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Create a VM Extension + syntax: az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +- uid: az_scvmm_vm_extension_delete(scvmm) + name: az scvmm vm extension delete + summary: |- + The operation to delete the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension delete [--ids] + [--name] + [--no-wait] + [--resource-group] + [--subscription] + [--vm-name] + [--yes] + examples: + - summary: |- + Delete a VM Extension + syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm where the extension should be deleted. + - name: --yes -y + defaultValue: "False" + summary: |- + Do not prompt for confirmation. +- uid: az_scvmm_vm_extension_list(scvmm) + name: az scvmm vm extension list + summary: |- + The operation to get all extensions of a non-Azure vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension list --resource-group + --vm-name + [--expand] + examples: + - summary: |- + Get all VM Extensions + syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm containing the extension. + optionalParameters: + - name: --expand + summary: |- + The expand expression to apply on the operation. +- uid: az_scvmm_vm_extension_show(scvmm) + name: az scvmm vm extension show + summary: |- + The operation to get the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension show [--ids] + [--name] + [--resource-group] + [--subscription] + [--vm-name] + examples: + - summary: |- + Get VM Extension + syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm containing the extension. +- uid: az_scvmm_vm_extension_update(scvmm) + name: az scvmm vm extension update + summary: |- + The operation to update the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension update --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Update a VM Extension + syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +commands: +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Manage vm extension with scvmm. diff --git a/2017-03-09-profile/docs-ref-autogen/scvmm/vm/guest-agent.yml b/2017-03-09-profile/docs-ref-autogen/scvmm/vm/guest-agent.yml new file mode 100644 index 0000000000..ff7c276ac9 --- /dev/null +++ b/2017-03-09-profile/docs-ref-autogen/scvmm/vm/guest-agent.yml @@ -0,0 +1,111 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_guest-agent +name: az scvmm vm guest-agent +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Vm guest agent. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_guest-agent_enable(scvmm) + name: az scvmm vm guest-agent enable + summary: |- + Enable guest agent on the vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent enable --password + --resource-group + --username + --vm-name + [--https-proxy] + [--no-wait] + examples: + - summary: |- + Enable guest agent on the vm + syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass --resource-group contoso-rg --subscription contoso-sub --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --password + summary: |- + Username password credentials to use for connecting to the VM. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --username + summary: |- + Username to use for connecting to the vm. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. + optionalParameters: + - name: --https-proxy + summary: |- + HTTPS proxy server url for the VM. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. +- uid: az_scvmm_vm_guest-agent_show(scvmm) + name: az scvmm vm guest-agent show + summary: |- + Get details of a guest agent by guest agent name, resource-group and vm name. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent show --resource-group + --vm-name + examples: + - summary: |- + Get details of a guest agent + syntax: az scvmm vm guest-agent show --resource-group contoso-rg --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. +commands: +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Vm guest agent. diff --git a/2017-03-09-profile/docs-ref-autogen/service-page/Stack HCI VM.yml b/2017-03-09-profile/docs-ref-autogen/service-page/Stack HCI VM.yml deleted file mode 100644 index 4a4347faaa..0000000000 --- a/2017-03-09-profile/docs-ref-autogen/service-page/Stack HCI VM.yml +++ /dev/null @@ -1,6 +0,0 @@ -### YamlMime:AzureCLIGroup -uid: sp-Stack_HCI_VM -name: Stack HCI VM -commands: -- az_stack-hci-vm -metadata: {} diff --git a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection.yml b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection.yml index 7a19d9b2dc..b8f3501d17 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection.yml @@ -38,14 +38,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -55,10 +57,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -90,17 +92,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -132,23 +136,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_list-support-types() name: az spring-cloud connection list-support-types summary: |- @@ -198,23 +204,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_validate() name: az spring-cloud connection validate summary: |- @@ -243,23 +251,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_wait() name: az spring-cloud connection wait summary: |- @@ -289,7 +299,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. @@ -307,7 +317,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -321,10 +333,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/create.yml b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/create.yml index 789af0ef1a..a36f6ca536 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/create.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/create.yml @@ -48,7 +48,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -65,7 +65,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -76,7 +78,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -84,7 +86,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -176,7 +178,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -190,17 +192,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -252,7 +256,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -266,7 +270,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -280,7 +286,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -288,7 +294,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -373,7 +379,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -390,7 +396,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -404,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -412,7 +420,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -496,7 +504,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -513,7 +521,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -524,7 +534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -532,7 +542,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -616,7 +626,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +643,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -644,7 +656,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,7 +664,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +748,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -750,7 +762,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -761,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -769,7 +783,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -852,7 +866,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -866,7 +880,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -880,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -888,7 +904,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -974,7 +990,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -988,7 +1004,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1004,10 +1022,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1088,7 +1106,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1105,7 +1123,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1116,7 +1136,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1134,7 +1154,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1189,7 +1209,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1206,14 +1226,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1231,7 +1253,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1298,7 +1320,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1315,7 +1337,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1331,7 +1355,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1349,7 +1373,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1409,7 +1433,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1426,14 +1450,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1451,7 +1477,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1507,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1524,7 +1550,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1535,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1546,7 +1574,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1596,7 +1624,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1613,14 +1641,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1631,7 +1661,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1685,7 +1715,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1699,7 +1729,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1713,7 +1745,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1721,7 +1753,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1800,7 +1832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1814,7 +1846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1825,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1833,7 +1867,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1911,7 +1945,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1928,7 +1962,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1939,7 +1975,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1957,7 +1993,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2030,7 +2066,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2044,7 +2080,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2060,7 +2098,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2068,7 +2106,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2148,7 +2186,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2162,7 +2200,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2173,7 +2213,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2181,7 +2221,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2242,7 +2282,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2256,7 +2296,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2267,7 +2309,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2275,7 +2317,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2355,7 +2397,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2369,7 +2411,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2380,7 +2424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2388,7 +2432,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2445,7 +2489,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2459,7 +2503,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2470,7 +2516,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2478,7 +2524,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/update.yml b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/update.yml index 153e6b0b18..2dfdbef869 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/update.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring-cloud/connection/update.yml @@ -42,7 +42,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -56,7 +56,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -70,7 +72,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -78,7 +80,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -150,7 +152,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -164,7 +166,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -177,7 +181,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -189,7 +193,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -231,7 +235,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -245,7 +249,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -259,7 +265,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -267,7 +273,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -332,7 +338,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -346,7 +352,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -360,7 +368,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -368,7 +376,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -433,7 +441,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -447,7 +455,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -461,7 +471,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -469,7 +479,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -534,7 +544,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -548,7 +558,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -562,7 +574,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -570,7 +582,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -635,7 +647,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -649,7 +661,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -663,7 +677,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -671,7 +685,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +750,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -750,7 +764,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -764,7 +780,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -772,7 +788,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,7 +852,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -850,7 +866,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -864,10 +882,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -929,7 +947,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -943,7 +961,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -957,7 +977,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -972,7 +992,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1011,7 +1031,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1025,7 +1045,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1035,7 +1057,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1050,7 +1072,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1094,7 +1116,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1108,7 +1130,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1122,7 +1146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1137,7 +1161,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1181,7 +1205,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1195,7 +1219,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1205,7 +1231,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1220,7 +1246,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1260,7 +1286,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1274,7 +1300,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1288,7 +1316,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1296,7 +1324,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1330,7 +1358,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1344,7 +1372,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1354,7 +1384,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1362,7 +1392,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1401,7 +1431,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1415,7 +1445,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1429,7 +1461,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1437,7 +1469,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1501,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1515,7 +1547,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1529,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1537,7 +1571,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1596,7 +1630,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1610,7 +1644,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1624,7 +1660,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1639,7 +1675,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1687,7 +1723,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1701,7 +1737,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1715,7 +1753,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1723,7 +1761,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1785,7 +1823,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1799,7 +1837,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1813,7 +1853,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1821,7 +1861,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1864,7 +1904,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1878,7 +1918,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1892,7 +1934,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1900,7 +1942,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1962,7 +2004,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1976,7 +2018,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1990,7 +2034,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1998,7 +2042,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2040,7 +2084,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2054,7 +2098,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2068,7 +2114,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,7 +2122,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/spring.yml b/2017-03-09-profile/docs-ref-autogen/spring.yml index 485ae7f209..65749e42df 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring.yml @@ -301,6 +301,30 @@ directCommands: - summary: |- List all plans. syntax: az spring list-marketplace-plan -o table +- uid: az_spring_list-support-server-versions(spring) + name: az spring list-support-server-versions + summary: |- + (Standard and Basic Tier Only) List supported server versions. + status: Preview + isPreview: true + previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + sourceType: Extension + syntax: >- + az spring list-support-server-versions --resource-group + --service + examples: + - summary: |- + List supported server versions. + syntax: az spring list-support-server-versions -o table -s MyService -g MyResourceGroup + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. - uid: az_spring_show(spring) name: az spring show summary: |- @@ -566,6 +590,7 @@ commands: - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) - az_spring_config-server - az_spring_config-server_clear(spring) - az_spring_config-server_disable(spring) @@ -675,6 +700,7 @@ commands: - az_spring_gateway_update(spring) - az_spring_list(spring) - az_spring_list-marketplace-plan(spring) +- az_spring_list-support-server-versions(spring) - az_spring_service-registry - az_spring_service-registry_bind(spring) - az_spring_service-registry_create(spring) diff --git a/2017-03-09-profile/docs-ref-autogen/spring/app.yml b/2017-03-09-profile/docs-ref-autogen/spring/app.yml index ab25b24e0f..1cd618bab9 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/app.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/app.yml @@ -415,6 +415,7 @@ directCommands: [--registry-password] [--registry-username] [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}] + [--server-version] [--source-path] [--startup-probe-config] [--target-module] @@ -426,6 +427,9 @@ directCommands: - summary: |- Deploy a pre-built jar to an app with jvm options and environment variables. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar + - summary: |- + Deploy a pre-built war to an app with server version, jvm options and environment variables (Standard and Basic Tiers Only). + syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar - summary: |- Deploy source code to a specific deployment of an app. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path @@ -460,7 +464,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -563,6 +567,9 @@ directCommands: parameterValueGroup: "Java_11, Java_17, Java_8, NetCore_31" summary: |- Runtime version of used language. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --source-path summary: |- Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided. diff --git a/2017-03-09-profile/docs-ref-autogen/spring/app/deployment.yml b/2017-03-09-profile/docs-ref-autogen/spring/app/deployment.yml index dcc3191376..71c8bd02fb 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/app/deployment.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/app/deployment.yml @@ -58,6 +58,7 @@ directCommands: [--scale-rule-metadata] [--scale-rule-name] [--scale-rule-type] + [--server-version] [--skip-clone-settings] [--source-path] [--startup-probe-config] @@ -99,7 +100,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -223,6 +224,9 @@ directCommands: - name: --scale-rule-type --srt summary: |- The type of the scale rule. Default: http. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --skip-clone-settings defaultValue: "False" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml b/2017-03-09-profile/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml index 13f8eaec64..61a4e22133 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml @@ -28,6 +28,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -35,6 +36,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -80,6 +82,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -102,6 +107,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. @@ -238,6 +247,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -245,6 +255,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -290,6 +301,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -312,6 +326,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. diff --git a/2017-03-09-profile/docs-ref-autogen/spring/certificate.yml b/2017-03-09-profile/docs-ref-autogen/spring/certificate.yml index 5ed4bdbe1d..4c6a781f4d 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/certificate.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/certificate.yml @@ -20,6 +20,7 @@ directCommands: az spring certificate add --name --resource-group --service + [--enable-auto-sync {false, true}] [--only-public-cert {false, true}] [--public-certificate-file] [--vault-certificate-name] @@ -42,6 +43,11 @@ directCommands: summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. optionalParameters: + - name: --enable-auto-sync + defaultValue: "False" + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. - name: --only-public-cert defaultValue: "False" parameterValueGroup: "false, true" @@ -157,12 +163,49 @@ directCommands: name: --service -s summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. +- uid: az_spring_certificate_update(spring) + name: az spring certificate update + summary: |- + Update a certificate in Azure Spring Apps. + status: GA + sourceType: Extension + syntax: >- + az spring certificate update --name + --resource-group + --service + [--enable-auto-sync {false, true}] + examples: + - summary: |- + Enable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true + - summary: |- + Disable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false + requiredParameters: + - isRequired: true + name: --name -n + summary: |- + Name of certificate. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. + optionalParameters: + - name: --enable-auto-sync + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. commands: - az_spring_certificate_add(spring) - az_spring_certificate_list(spring) - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) globalParameters: - name: --debug summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/spring/connection.yml b/2017-03-09-profile/docs-ref-autogen/spring/connection.yml index f6c6051669..176dcc3111 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/connection.yml @@ -34,14 +34,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -51,10 +53,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -84,17 +86,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -124,23 +128,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_list-support-types() name: az spring connection list-support-types summary: |- @@ -186,23 +192,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_validate() name: az spring connection validate summary: |- @@ -229,23 +237,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_wait() name: az spring connection wait summary: |- @@ -273,7 +283,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. @@ -291,7 +301,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -305,10 +317,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/spring/connection/create.yml b/2017-03-09-profile/docs-ref-autogen/spring/connection/create.yml index a8cb097cd1..29ca0fbf26 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/connection/create.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/connection/create.yml @@ -44,7 +44,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -61,7 +61,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -72,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -80,7 +82,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -170,7 +172,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -184,17 +186,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -244,7 +248,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -258,7 +262,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -272,7 +278,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -280,7 +286,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -363,7 +369,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -380,7 +386,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -394,7 +402,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -402,7 +410,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -484,7 +492,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -501,7 +509,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -512,7 +522,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -520,7 +530,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -602,7 +612,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -619,7 +629,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -630,7 +642,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -638,7 +650,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -720,7 +732,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -734,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -745,7 +759,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -753,7 +767,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -834,7 +848,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -848,7 +862,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -862,7 +878,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -870,7 +886,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -954,7 +970,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -968,7 +984,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -984,10 +1002,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1068,7 +1086,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1085,7 +1103,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1096,7 +1116,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1114,7 +1134,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1167,7 +1187,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1184,14 +1204,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1209,7 +1231,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1276,7 +1298,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1293,7 +1315,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1309,7 +1333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1327,7 +1351,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1385,7 +1409,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1402,14 +1426,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1427,7 +1453,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1481,7 +1507,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1498,7 +1524,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1509,7 +1537,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1520,7 +1548,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1568,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1585,14 +1613,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1603,7 +1633,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1655,7 +1685,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1669,7 +1699,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1683,7 +1715,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1691,7 +1723,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1768,7 +1800,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1782,7 +1814,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1793,7 +1827,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1801,7 +1835,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1877,7 +1911,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1894,7 +1928,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1905,7 +1941,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1923,7 +1959,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1994,7 +2030,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2008,7 +2044,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2024,7 +2062,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2070,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2110,7 +2148,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2124,7 +2162,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2135,7 +2175,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2143,7 +2183,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2202,7 +2242,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2216,7 +2256,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2227,7 +2269,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2235,7 +2277,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2313,7 +2355,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2327,7 +2369,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2338,7 +2382,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2346,7 +2390,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2401,7 +2445,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2415,7 +2459,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2426,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2434,7 +2480,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/spring/connection/update.yml b/2017-03-09-profile/docs-ref-autogen/spring/connection/update.yml index 66da61e2e7..1684f816cd 100644 --- a/2017-03-09-profile/docs-ref-autogen/spring/connection/update.yml +++ b/2017-03-09-profile/docs-ref-autogen/spring/connection/update.yml @@ -38,7 +38,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -52,7 +52,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -66,7 +68,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -74,7 +76,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -144,7 +146,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -158,7 +160,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -171,7 +175,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -183,7 +187,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -223,7 +227,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -237,7 +241,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -251,7 +257,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -259,7 +265,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -322,7 +328,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -336,7 +342,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -350,7 +358,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +366,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -421,7 +429,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -435,7 +443,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -449,7 +459,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -457,7 +467,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -520,7 +530,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -534,7 +544,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -548,7 +560,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -556,7 +568,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -619,7 +631,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +645,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -647,7 +661,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -655,7 +669,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -718,7 +732,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -732,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -746,7 +762,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -754,7 +770,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -816,7 +832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -830,7 +846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -844,10 +862,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -909,7 +927,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -923,7 +941,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -937,7 +957,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -952,7 +972,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -989,7 +1009,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1003,7 +1023,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1013,7 +1035,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1028,7 +1050,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1072,7 +1094,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1086,7 +1108,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1100,7 +1124,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1115,7 +1139,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1157,7 +1181,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1171,7 +1195,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1181,7 +1207,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1196,7 +1222,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1234,7 +1260,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1248,7 +1274,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1262,7 +1290,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1270,7 +1298,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1302,7 +1330,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1316,7 +1344,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1326,7 +1356,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1334,7 +1364,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1371,7 +1401,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1385,7 +1415,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1399,7 +1431,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1407,7 +1439,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1469,7 +1501,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1483,7 +1515,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1497,7 +1531,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1505,7 +1539,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1562,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1576,7 +1610,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1590,7 +1626,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1605,7 +1641,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1651,7 +1687,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1665,7 +1701,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1679,7 +1717,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1687,7 +1725,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1747,7 +1785,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1761,7 +1799,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1775,7 +1815,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1783,7 +1823,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1824,7 +1864,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1838,7 +1878,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1852,7 +1894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1860,7 +1902,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1920,7 +1962,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1934,7 +1976,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1948,7 +1992,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +2000,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1996,7 +2040,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2010,7 +2054,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2024,7 +2070,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2078,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2017-03-09-profile/docs-ref-autogen/storage/blob/directory.yml b/2017-03-09-profile/docs-ref-autogen/storage/blob/directory.yml index fd2d12feca..7ea3e81023 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage/blob/directory.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage/blob/directory.yml @@ -573,7 +573,7 @@ directCommands: - isRequired: true name: --destination-path -d summary: |- - The upload destination directory path. It should be an absolute path to container. If the specified destination path does not exist, a new directory path will be created. + The destination path that will be prepended to the blob name. - isRequired: true name: --source -s summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/tag.yml b/2017-03-09-profile/docs-ref-autogen/tag.yml index 8ca7b76ab9..0c490f7338 100644 --- a/2017-03-09-profile/docs-ref-autogen/tag.yml +++ b/2017-03-09-profile/docs-ref-autogen/tag.yml @@ -164,5 +164,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Tag Management on a resource. diff --git a/2017-03-09-profile/docs-ref-autogen/webapp/connection.yml b/2017-03-09-profile/docs-ref-autogen/webapp/connection.yml index 5cb6b4634d..3768e89313 100644 --- a/2017-03-09-profile/docs-ref-autogen/webapp/connection.yml +++ b/2017-03-09-profile/docs-ref-autogen/webapp/connection.yml @@ -22,6 +22,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--yes] examples: - summary: |- @@ -42,14 +43,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --yes -y defaultValue: "False" summary: |- @@ -63,6 +67,7 @@ directCommands: syntax: >- az webapp connection list [--name] [--resource-group] + [--slot] [--source-id] examples: - summary: |- @@ -77,10 +82,13 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -95,6 +103,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- List a connection's source configurations interactively @@ -114,10 +123,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_list-support-types() name: az webapp connection list-support-types summary: |- @@ -148,6 +160,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Get a connection interactively @@ -167,10 +180,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_validate() name: az webapp connection validate summary: |- @@ -182,6 +198,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Validate a connection interactively @@ -201,10 +218,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_wait() name: az webapp connection wait summary: |- @@ -221,6 +241,7 @@ directCommands: [--interval] [--name] [--resource-group] + [--slot] [--timeout] [--updated] examples: @@ -255,10 +276,13 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2017-03-09-profile/docs-ref-autogen/webapp/connection/create.yml b/2017-03-09-profile/docs-ref-autogen/webapp/connection/create.yml index abe31f256d..58170d03b6 100644 --- a/2017-03-09-profile/docs-ref-autogen/webapp/connection/create.yml +++ b/2017-03-09-profile/docs-ref-autogen/webapp/connection/create.yml @@ -27,6 +27,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -40,6 +41,9 @@ directCommands: - summary: |- Create a connection between webapp and appconfig with resource name syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --tg AppconfigRG --app-config MyConfigStore --system-identity + - summary: |- + Create a connection between webapp slot and appconfig with resource name + syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --slot MySlot --tg AppconfigRG --app-config MyConfigStore --system-identity - summary: |- Create a connection between webapp and appconfig with resource id syntax: az webapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity @@ -59,7 +63,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -85,6 +89,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -129,6 +136,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--source-id] [--vault-id] examples: @@ -173,14 +181,17 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -206,6 +217,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -219,6 +231,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-cassandra with resource name syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-cassandra with resource name + syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity - summary: |- Create a connection between webapp and cosmos-cassandra with resource id syntax: az webapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity @@ -241,7 +256,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -252,7 +267,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -271,6 +286,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -316,6 +334,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -329,6 +348,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-gremlin with resource name syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-gremlin with resource name + syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity - summary: |- Create a connection between webapp and cosmos-gremlin with resource id syntax: az webapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity @@ -354,7 +376,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -365,7 +387,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -384,6 +406,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -428,6 +453,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -441,6 +467,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-mongo with resource name syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-mongo with resource name + syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-mongo with resource id syntax: az webapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity @@ -463,7 +492,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -474,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -493,6 +522,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -537,6 +569,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -550,6 +583,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-sql with resource name syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-sql with resource name + syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-sql with resource id syntax: az webapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity @@ -572,7 +608,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -583,7 +619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -602,6 +638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -645,6 +684,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--table] @@ -659,6 +699,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-table with resource name syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --table MyTable --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-table with resource name + syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --table MyTable --system-identity - summary: |- Create a connection between webapp and cosmos-table with resource id syntax: az webapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity @@ -678,7 +721,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -689,7 +732,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -708,6 +751,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -754,6 +800,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -767,6 +814,9 @@ directCommands: - summary: |- Create a connection between webapp and eventhub with resource name syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --tg EventhubRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and eventhub with resource name + syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --slot MySlot --tg EventhubRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and eventhub with resource id syntax: az webapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity @@ -783,7 +833,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -797,7 +847,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -816,6 +866,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -858,6 +911,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -872,6 +926,9 @@ directCommands: - summary: |- Create a connection between webapp and keyvault with resource name syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --tg KeyvaultRG --vault MyVault --system-identity + - summary: |- + Create a connection between webapp slot and keyvault with resource name + syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --slot MySlot --tg KeyvaultRG --vault MyVault --system-identity - summary: |- Create a connection between webapp and keyvault with resource id syntax: az webapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity @@ -894,7 +951,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -910,7 +967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -924,6 +981,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -973,6 +1033,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -984,6 +1045,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql with resource name syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql with resource name + syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql with resource id syntax: az webapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1009,7 +1073,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1020,7 +1084,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1040,6 +1104,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1069,6 +1136,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1081,6 +1149,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql-flexible with resource name syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql-flexible with resource name + syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql-flexible with resource id syntax: az webapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1106,14 +1177,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1129,6 +1200,9 @@ directCommands: - name: --server summary: |- Name of the mysql flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1206,14 +1280,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1293,6 +1367,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1305,6 +1380,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres with resource name syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres with resource name + syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres with resource id syntax: az webapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1336,7 +1414,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1352,7 +1430,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1372,6 +1450,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1456,7 +1537,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1472,7 +1553,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1628,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1559,6 +1641,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres-flexible with resource name syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres-flexible with resource name + syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres-flexible with resource id syntax: az webapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1584,14 +1669,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,6 +1692,9 @@ directCommands: - name: --server summary: |- Name of postgres flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1682,14 +1770,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1848,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1771,6 +1860,9 @@ directCommands: - summary: |- Create a connection between webapp and redis with resource name syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis with resource name + syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis with resource id syntax: az webapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret @@ -1790,7 +1882,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1801,7 +1893,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1810,6 +1902,9 @@ directCommands: - name: --server summary: |- Name of the redis server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1838,6 +1933,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1849,6 +1945,9 @@ directCommands: - summary: |- Create a connection between webapp and redis-enterprise with resource name syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis-enterprise with resource name + syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis-enterprise with resource id syntax: az webapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret @@ -1868,14 +1967,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1884,6 +1983,9 @@ directCommands: - name: --server summary: |- Name of the redis enterprise server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1914,6 +2016,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1927,6 +2030,9 @@ directCommands: - summary: |- Create a connection between webapp and servicebus with resource name syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --tg ServicebusRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and servicebus with resource name + syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --slot MySlot --tg ServicebusRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and servicebus with resource id syntax: az webapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity @@ -1943,7 +2049,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1957,7 +2063,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1976,6 +2082,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2018,6 +2127,7 @@ directCommands: [--secret] [--service-principal] [--signalr] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2031,6 +2141,9 @@ directCommands: - summary: |- Create a connection between webapp and signalr with resource name syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --tg SignalrRG --signalr MySignalR --system-identity + - summary: |- + Create a connection between webapp slot and signalr with resource name + syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --slot MySlot --tg SignalrRG --signalr MySignalR --system-identity - summary: |- Create a connection between webapp and signalr with resource id syntax: az webapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity @@ -2047,7 +2160,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2058,7 +2171,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,6 +2189,9 @@ directCommands: - name: --signalr summary: |- Name of the signalr service. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2120,6 +2236,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2132,6 +2249,9 @@ directCommands: - summary: |- Create a connection between webapp and sql with resource name syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and sql with resource name + syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --slot MySlot --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and sql with resource id syntax: az webapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -2157,7 +2277,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2168,7 +2288,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2188,6 +2308,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2265,7 +2388,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2276,7 +2399,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2353,6 +2476,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2366,6 +2490,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-blob with resource name syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-blob with resource name + syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-blob with resource id syntax: az webapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity @@ -2391,7 +2518,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2407,7 +2534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2426,6 +2553,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2468,6 +2598,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2479,6 +2610,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-file with resource name syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-file with resource name + syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-file with resource id syntax: az webapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret @@ -2498,7 +2632,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2509,7 +2643,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2519,6 +2653,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2549,6 +2686,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2562,6 +2700,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-queue with resource name syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-queue with resource name + syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-queue with resource id syntax: az webapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity @@ -2581,7 +2722,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2592,7 +2733,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2611,6 +2752,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2653,6 +2797,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2664,6 +2809,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-table with resource name syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-table with resource name + syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-table with resource id syntax: az webapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret @@ -2683,7 +2831,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2694,7 +2842,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2704,6 +2852,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2732,6 +2883,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2746,6 +2898,9 @@ directCommands: - summary: |- Create a connection between webapp and webpubsub with resource name syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity + - summary: |- + Create a connection between webapp slot and webpubsub with resource name + syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --slot MySlot --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity - summary: |- Create a connection between webapp and webpubsub with resource id syntax: az webapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity @@ -2762,7 +2917,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2773,7 +2928,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2788,6 +2943,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. diff --git a/2017-03-09-profile/docs-ref-autogen/webapp/connection/update.yml b/2017-03-09-profile/docs-ref-autogen/webapp/connection/update.yml index 5e3a0a9a07..5c31692daf 100644 --- a/2017-03-09-profile/docs-ref-autogen/webapp/connection/update.yml +++ b/2017-03-09-profile/docs-ref-autogen/webapp/connection/update.yml @@ -23,6 +23,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -49,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -60,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -75,6 +76,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -110,6 +114,7 @@ directCommands: [--schema-key] [--schema-registry] [--schema-secret] + [--slot] [--source-id] [--vault-id] examples: @@ -149,14 +154,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -166,6 +171,9 @@ directCommands: - name: --schema-secret summary: |- Schema registry API-Key (secret). + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -190,6 +198,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -216,7 +225,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -227,7 +236,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -246,6 +255,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -280,6 +292,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -306,7 +319,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -317,7 +330,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -336,6 +349,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -370,6 +386,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -396,7 +413,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -407,7 +424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -426,6 +443,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -460,6 +480,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -486,7 +507,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -497,7 +518,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -516,6 +537,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -550,6 +574,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -576,7 +601,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -587,7 +612,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -606,6 +631,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -640,6 +668,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -666,7 +695,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -677,7 +706,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -696,6 +725,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -729,6 +761,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -755,7 +788,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -766,7 +799,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -780,6 +813,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -816,6 +852,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -846,7 +883,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -857,7 +894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -874,6 +911,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -893,6 +933,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -924,14 +965,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -944,6 +985,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -974,6 +1018,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1005,7 +1050,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1016,7 +1061,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1033,6 +1078,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1057,6 +1105,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -1088,14 +1137,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1108,6 +1157,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1132,6 +1184,7 @@ directCommands: [--private-endpoint {false, true}] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1156,7 +1209,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1167,12 +1220,15 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1191,6 +1247,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1215,19 +1272,22 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1249,6 +1309,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1275,7 +1336,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1286,7 +1347,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1305,6 +1366,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1338,6 +1402,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1364,7 +1429,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1375,7 +1440,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1390,6 +1455,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1424,6 +1492,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1455,7 +1524,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1466,7 +1535,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1483,6 +1552,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1509,6 +1581,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1535,7 +1608,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1546,7 +1619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1565,6 +1638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1598,6 +1674,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1622,7 +1699,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1633,7 +1710,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1643,6 +1720,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1664,6 +1744,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1690,7 +1771,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1701,7 +1782,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1720,6 +1801,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1753,6 +1837,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1777,7 +1862,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1788,7 +1873,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1798,6 +1883,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1818,6 +1906,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1844,7 +1933,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1855,7 +1944,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1870,6 +1959,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/TOC.yml b/2018-03-01-hybrid/docs-ref-autogen/TOC.yml index 6cec8ad9c3..5b82280b8a 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/TOC.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/TOC.yml @@ -434,6 +434,14 @@ uid: az_scvmm_vm_disk displayName: az scvmm vm disk items: [] + - name: extension + uid: az_scvmm_vm_extension + displayName: az scvmm vm extension + items: [] + - name: guest-agent + uid: az_scvmm_vm_guest-agent + displayName: az scvmm vm guest-agent + items: [] - name: nic uid: az_scvmm_vm_nic displayName: az scvmm vm nic @@ -3462,6 +3470,10 @@ uid: az_aks_egress-endpoints displayName: az aks egress-endpoints items: [] + - name: machine + uid: az_aks_machine + displayName: az aks machine + items: [] - name: maintenanceconfiguration uid: az_aks_maintenanceconfiguration displayName: az aks maintenanceconfiguration @@ -6706,10 +6718,6 @@ uid: az_stack-hci_extension displayName: az stack-hci extension items: [] - - name: Stack HCI VM - uid: sp-Stack_HCI_VM - displayName: Stack HCI VM - items: [] - name: Storage items: - name: Summary diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/lock.yml b/2018-03-01-hybrid/docs-ref-autogen/account/lock.yml index 8868f4e99e..65cc8fbba7 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/lock.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/lock.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure subscription level locks. diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/management-group.yml b/2018-03-01-hybrid/docs-ref-autogen/account/management-group.yml index 4581a2922b..697a9365b8 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/management-group.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/management-group.yml @@ -257,5 +257,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure Management Groups. diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml index 216e0bf65c..4e4e45263a 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml @@ -47,5 +47,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Entity operations (Management Group and Subscriptions) for Management Groups. diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml index 1765ca90da..8273695000 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml @@ -177,5 +177,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy. diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml index 572dfc76f3..523464ad76 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml @@ -130,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Subscription operations for Management Groups. diff --git a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml index 037d92a58d..8d240dd236 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml @@ -62,5 +62,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Backfill Tenant Subscription Operations for Management Groups. diff --git a/2018-03-01-hybrid/docs-ref-autogen/aks.yml b/2018-03-01-hybrid/docs-ref-autogen/aks.yml index 6a1c17ad6e..b4342d6872 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/aks.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/aks.yml @@ -148,6 +148,7 @@ directCommands: [--http-proxy-config] [--image-cleaner-interval-hours] [--ip-families] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -206,7 +207,7 @@ directCommands: [--snapshot-id] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--vm-set-type] [--vnet-subnet-id] [--windows-admin-password] @@ -683,6 +684,10 @@ directCommands: A comma separated list of IP versions to use for cluster networking. description: |- Each IP version should be in the format IPvN. For example, IPv4. + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -932,7 +937,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA. - name: --vm-set-type @@ -1664,6 +1669,7 @@ directCommands: [--guardrails-version] [--http-proxy-config] [--image-cleaner-interval-hours] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -1691,7 +1697,7 @@ directCommands: [--rotation-poll-interval] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--update-cluster-autoscaler] [--upgrade-override-until] [--windows-admin-password] @@ -2138,6 +2144,10 @@ directCommands: summary: |- ImageCleaner scanning interval. isPreview: true + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -2256,7 +2266,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' changes a standard managed cluster to a free one. - name: --update-cluster-autoscaler -u @@ -2488,6 +2498,9 @@ commands: - az_aks_kanalyze(aks-preview) - az_aks_kollect(aks-preview) - az_aks_list(aks-preview) +- az_aks_machine +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) - az_aks_maintenanceconfiguration - az_aks_maintenanceconfiguration_add(aks-preview) - az_aks_maintenanceconfiguration_delete(aks-preview) diff --git a/2018-03-01-hybrid/docs-ref-autogen/aks/machine.yml b/2018-03-01-hybrid/docs-ref-autogen/aks/machine.yml new file mode 100644 index 0000000000..0562e9ba0f --- /dev/null +++ b/2018-03-01-hybrid/docs-ref-autogen/aks/machine.yml @@ -0,0 +1,92 @@ +### YamlMime:AzureCLIGroup +uid: az_aks_machine +name: az aks machine +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **aks-preview** extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an **az aks machine** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Get information about machines in a nodepool of a managed clusters. +status: GA +sourceType: Extension +directCommands: +- uid: az_aks_machine_list(aks-preview) + name: az aks machine list + summary: |- + Get information about IP Addresses, Hostname for all machines in an agentpool. + status: GA + sourceType: Extension + syntax: >- + az aks machine list --cluster-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_aks_machine_show(aks-preview) + name: az aks machine show + summary: |- + Show IP Addresses, Hostname for a specific machine in an agentpool for a managedcluster. + status: GA + sourceType: Extension + syntax: >- + az aks machine show --cluster-name + --machine-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --machine-name + summary: |- + Get IP Addresses, Hostname for a specific machine in an agentpool. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +commands: +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Get information about machines in a nodepool of a managed clusters. diff --git a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml index c65eca91b8..62f0fe7ed2 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml @@ -12,6 +12,7 @@ directCommands: Delete a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection delete [--connection] [--id] @@ -38,14 +39,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -56,6 +57,7 @@ directCommands: List connections of a containerapp. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list [--name] [--resource-group] @@ -73,10 +75,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -86,6 +88,7 @@ directCommands: List source configurations of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list-configuration [--connection] [--id] @@ -110,16 +113,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_list-support-types() name: az containerapp connection list-support-types summary: |- List client types and auth types supported by containerapp connections. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: az containerapp connection list-support-types [--target-type {appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}] examples: - summary: |- @@ -139,6 +143,7 @@ directCommands: Get the details of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection show [--connection] [--id] @@ -163,16 +168,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_validate() name: az containerapp connection validate summary: |- Validate a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection validate [--connection] [--id] @@ -197,16 +203,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_wait() name: az containerapp connection wait summary: |- Place the CLI in a waiting state until a condition of the connection is met. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection wait [--connection] [--created] @@ -251,10 +258,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- @@ -344,4 +351,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Commands to manage containerapp connections. diff --git a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml index b07b1e4f10..28f82f023d 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml @@ -12,6 +12,7 @@ directCommands: Create a containerapp connection to appconfig. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create appconfig [--app-config] [--client-type {dotnet, java, nodejs, none, python}] @@ -59,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -116,6 +117,7 @@ directCommands: Create a containerapp connection to confluent-cloud. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create confluent-cloud --bootstrap-server --kafka-key @@ -177,14 +179,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -197,6 +199,7 @@ directCommands: Create a containerapp connection to cosmos-cassandra. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-cassandra [--account] [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] @@ -249,7 +252,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -260,7 +263,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,6 +313,7 @@ directCommands: Create a containerapp connection to cosmos-gremlin. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-gremlin [--account] [--client-type {dotnet, java, nodejs, none, php, python}] @@ -366,7 +370,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -377,7 +381,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -427,6 +431,7 @@ directCommands: Create a containerapp connection to cosmos-mongo. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-mongo [--account] [--client-type {dotnet, go, java, nodejs, none, springBoot}] @@ -479,7 +484,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -490,7 +495,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -540,6 +545,7 @@ directCommands: Create a containerapp connection to cosmos-sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-sql [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -592,7 +598,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -603,7 +609,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -653,6 +659,7 @@ directCommands: Create a containerapp connection to cosmos-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-table [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -702,7 +709,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -713,7 +720,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -766,6 +773,7 @@ directCommands: Create a containerapp connection to eventhub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -811,7 +819,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -825,7 +833,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -875,6 +883,7 @@ directCommands: Create a containerapp connection to keyvault. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -926,7 +935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -942,7 +951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -992,6 +1001,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1038,7 +1048,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1049,7 +1059,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1087,6 +1097,7 @@ directCommands: Create a containerapp connection to mysql-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1132,14 +1143,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1182,6 +1193,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1236,7 +1248,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1252,7 +1264,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1295,6 +1307,7 @@ directCommands: Create a containerapp connection to postgres-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1340,14 +1353,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1386,6 +1399,7 @@ directCommands: Create a containerapp connection to redis. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1431,7 +1445,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1442,7 +1456,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1469,6 +1483,7 @@ directCommands: Create a containerapp connection to redis-enterprise. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1513,14 +1528,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1562,7 @@ directCommands: Create a containerapp connection to servicebus. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1592,7 +1608,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1606,7 +1622,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1656,6 +1672,7 @@ directCommands: Create a containerapp connection to signalr. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create signalr [--client-type {dotnet, none}] [--connection] @@ -1700,7 +1717,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1711,7 +1728,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1777,7 @@ directCommands: Create a containerapp connection to sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1807,7 +1825,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1818,7 +1836,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1861,6 +1879,7 @@ directCommands: Create a containerapp connection to storage-blob. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-blob [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -1916,7 +1935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1932,7 +1951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1982,6 +2001,7 @@ directCommands: Create a containerapp connection to storage-file. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-file [--account] [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] @@ -2027,7 +2047,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2038,7 +2058,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2066,6 +2086,7 @@ directCommands: Create a containerapp connection to storage-queue. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-queue [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -2114,7 +2135,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2125,7 +2146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2175,6 +2196,7 @@ directCommands: Create a containerapp connection to storage-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-table [--account] [--client-type {dotnet, java, nodejs, none, python}] @@ -2220,7 +2242,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2231,7 +2253,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2259,6 +2281,7 @@ directCommands: Create a containerapp connection to webpubsub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -2303,7 +2326,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2314,7 +2337,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2406,4 +2429,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Create a connection between a containerapp and a target resource. diff --git a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml index 374cae2ad2..11afda4188 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml @@ -12,6 +12,7 @@ directCommands: Update a containerapp to appconfig connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update appconfig [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -53,7 +54,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -64,7 +65,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -101,6 +102,7 @@ directCommands: Update a containerapp to confluent-cloud connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update confluent-cloud --connection [--bootstrap-server] @@ -153,14 +155,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -182,6 +184,7 @@ directCommands: Update a containerapp to cosmos-cassandra connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-cassandra [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -224,7 +227,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -235,7 +238,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -276,6 +279,7 @@ directCommands: Update a containerapp to cosmos-gremlin connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-gremlin [--client-type {dotnet, java, nodejs, none, php, python}] [--connection] @@ -318,7 +322,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -329,7 +333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -370,6 +374,7 @@ directCommands: Update a containerapp to cosmos-mongo connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-mongo [--client-type {dotnet, go, java, nodejs, none, springBoot}] [--connection] @@ -412,7 +417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -423,7 +428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -464,6 +469,7 @@ directCommands: Update a containerapp to cosmos-sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-sql [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -506,7 +512,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -517,7 +523,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -558,6 +564,7 @@ directCommands: Update a containerapp to cosmos-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-table [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -600,7 +607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -611,7 +618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,6 +659,7 @@ directCommands: Update a containerapp to eventhub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -694,7 +702,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -705,7 +713,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -746,6 +754,7 @@ directCommands: Update a containerapp to keyvault connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -787,7 +796,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -798,7 +807,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,6 +845,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -875,7 +885,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -886,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -912,6 +922,7 @@ directCommands: Update a containerapp to mysql-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -950,14 +961,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -988,6 +999,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1028,7 +1040,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1039,7 +1051,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1070,6 +1082,7 @@ directCommands: Update a containerapp to postgres-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1108,14 +1121,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,6 +1155,7 @@ directCommands: Update a containerapp to redis connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1180,7 +1194,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1191,7 +1205,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1206,6 +1220,7 @@ directCommands: Update a containerapp to redis-enterprise connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1243,14 +1258,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1265,6 +1280,7 @@ directCommands: Update a containerapp to servicebus connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1307,7 +1323,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1318,7 +1334,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1359,6 +1375,7 @@ directCommands: Update a containerapp to signalr connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update signalr [--client-type {dotnet, none}] [--connection] @@ -1400,7 +1417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1411,7 +1428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1448,6 +1465,7 @@ directCommands: Update a containerapp to sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1488,7 +1506,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1499,7 +1517,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1530,6 +1548,7 @@ directCommands: Update a containerapp to storage-blob connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-blob [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1572,7 +1591,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1583,7 +1602,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1624,6 +1643,7 @@ directCommands: Update a containerapp to storage-file connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-file [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1663,7 +1683,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1674,7 +1694,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1693,6 +1713,7 @@ directCommands: Update a containerapp to storage-queue connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-queue [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1735,7 +1756,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1746,7 +1767,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1787,6 +1808,7 @@ directCommands: Update a containerapp to storage-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-table [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1826,7 +1848,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1837,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1856,6 +1878,7 @@ directCommands: Update a containerapp to webpubsub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1897,7 +1920,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1908,7 +1931,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1988,4 +2011,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Update a containerapp connection. diff --git a/2018-03-01-hybrid/docs-ref-autogen/deployment.yml b/2018-03-01-hybrid/docs-ref-autogen/deployment.yml index b16942ca94..6122ba6a2a 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/deployment.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/deployment.yml @@ -44,5 +44,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2018-03-01-hybrid/docs-ref-autogen/deployment/group.yml b/2018-03-01-hybrid/docs-ref-autogen/deployment/group.yml index a896fda216..a5b8c76962 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/deployment/group.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/deployment/group.yml @@ -77,8 +77,8 @@ directCommands: Create a deployment at resource group scope from a template-spec syntax: az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0" - summary: |- - Create a deployment at resource group scope from a bicep template and a bicepparam parameter file - syntax: az deployment group create --resource-group testrg --template-file azuredeploy.bicep --parameters parameters.bicepparam + Create a deployment at resource group scope from a bicepparam parameter file + syntax: az deployment group create --resource-group testrg --parameters parameters.bicepparam - summary: |- Create a deployment at resource group across tenants syntax: >- @@ -124,7 +124,7 @@ directCommands: summary: |- Supply deployment parameter values. description: |- - 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. Also note if you are providing a bicepparam file with a bicep template then you can use this argument only once. + 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. Also note if you are providing a bicepparam file then you can use this argument only once. - name: --query-string -q summary: |- The query string (a SAS token) to be used with the template-uri in the case of linked templates. @@ -396,5 +396,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at resource group. diff --git a/2018-03-01-hybrid/docs-ref-autogen/deployment/operation.yml b/2018-03-01-hybrid/docs-ref-autogen/deployment/operation.yml index 4ef7c551e4..33426c4202 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/deployment/operation.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/deployment/operation.yml @@ -34,5 +34,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2018-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml b/2018-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml index c950e10e53..f2ba339664 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml @@ -81,5 +81,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at resource group. diff --git a/2018-03-01-hybrid/docs-ref-autogen/dt/model.yml b/2018-03-01-hybrid/docs-ref-autogen/dt/model.yml index a96d5da72b..583a66b870 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/dt/model.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/dt/model.yml @@ -132,7 +132,7 @@ directCommands: List model definitions syntax: az dt model list -n {instance_or_hostname} --definition - summary: |- - List dependencies of particular pre-existing model(s). Space seperate dtmi values. + List dependencies of particular pre-existing model(s). Space separate dtmi values. syntax: az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1} requiredParameters: - isRequired: true diff --git a/2018-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml index 3d46f29499..c1e786c25d 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml @@ -117,7 +117,7 @@ directCommands: Description for the private endpoint connection. - name: --group-ids summary: |- - Space seperated list of group ids that the private endpoint should connect to. + Space separated list of group ids that the private endpoint should connect to. - name: --no-wait defaultValue: "False" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml index 5aa7711ce5..67a0d992a8 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml @@ -43,14 +43,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -79,10 +79,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -117,10 +117,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_list-support-types() name: az functionapp connection list-support-types summary: |- @@ -172,10 +172,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_validate() name: az functionapp connection validate summary: |- @@ -207,10 +207,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_wait() name: az functionapp connection wait summary: |- @@ -262,10 +262,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml index e92790c539..3767dae0bc 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml @@ -60,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -71,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -175,14 +175,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -244,7 +244,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -255,7 +255,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +358,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -369,7 +369,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -468,7 +468,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -479,7 +479,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -578,7 +578,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -589,7 +589,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -685,7 +685,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -696,7 +696,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -791,7 +791,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -805,7 +805,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -903,7 +903,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -919,7 +919,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1012,7 +1012,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1023,7 +1023,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1103,14 +1103,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1194,14 +1194,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1299,7 +1299,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1315,7 +1315,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1410,7 +1410,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1426,7 +1426,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1515,14 +1515,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1604,14 +1604,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1696,7 +1696,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1707,7 +1707,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1775,14 +1775,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1851,7 +1851,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1865,7 +1865,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +1956,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1967,7 +1967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2060,7 +2060,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2071,7 +2071,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2159,7 +2159,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2170,7 +2170,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2269,7 +2269,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2285,7 +2285,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2377,7 +2377,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2388,7 +2388,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2461,7 +2461,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2472,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2564,7 +2564,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2575,7 +2575,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2644,7 +2644,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2655,7 +2655,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml index 38d4dd2445..5f86ae02ef 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml @@ -50,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -61,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -151,14 +151,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -219,7 +219,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -230,7 +230,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,7 +310,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -321,7 +321,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -401,7 +401,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -412,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -492,7 +492,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -503,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -583,7 +583,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -594,7 +594,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -674,7 +674,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -685,7 +685,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -764,7 +764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -775,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -849,7 +849,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -860,7 +860,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -921,14 +921,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -996,7 +996,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1007,7 +1007,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1073,14 +1073,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,7 +1142,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1153,7 +1153,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1202,14 +1202,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1263,7 +1263,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1274,7 +1274,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1353,7 +1353,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1364,7 +1364,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1438,7 +1438,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1449,7 +1449,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1519,7 +1519,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1530,7 +1530,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,7 +1607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1618,7 +1618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1676,7 +1676,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1687,7 +1687,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1764,7 +1764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1775,7 +1775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1832,7 +1832,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1843,7 +1843,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/group.yml b/2018-03-01-hybrid/docs-ref-autogen/group.yml index 846b577ecc..b450511a56 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/group.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/group.yml @@ -296,5 +296,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource groups and template deployments. diff --git a/2018-03-01-hybrid/docs-ref-autogen/group/deployment.yml b/2018-03-01-hybrid/docs-ref-autogen/group/deployment.yml index bdb6506b2b..845f03e2c5 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/group/deployment.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/group/deployment.yml @@ -376,5 +376,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager deployments. diff --git a/2018-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml b/2018-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml index 3a10ee2996..1a816fc7b6 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml @@ -88,5 +88,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations. diff --git a/2018-03-01-hybrid/docs-ref-autogen/group/lock.yml b/2018-03-01-hybrid/docs-ref-autogen/group/lock.yml index 6190f384ce..9862bfbf29 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/group/lock.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/group/lock.yml @@ -178,5 +178,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource group locks. diff --git a/2018-03-01-hybrid/docs-ref-autogen/iot/du/account.yml b/2018-03-01-hybrid/docs-ref-autogen/iot/du/account.yml index bb80295b1a..60982b150f 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/iot/du/account.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/iot/du/account.yml @@ -43,7 +43,7 @@ directCommands: Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor. syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount - summary: |- - Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-seperated) with a custom specified role. + Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role. syntax: >- az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1 /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2 diff --git a/2018-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml b/2018-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml index 9c24473ee3..ffe8446d6a 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml @@ -114,7 +114,7 @@ directCommands: [--resource-group] examples: - summary: |- - Remove a space-seperated list of child devices from a target parent device. + Remove a space-separated list of child devices from a target parent device. syntax: az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name} - summary: |- Remove all child devices from a target parent device. diff --git a/2018-03-01-hybrid/docs-ref-autogen/lock.yml b/2018-03-01-hybrid/docs-ref-autogen/lock.yml index eda6357072..16bc620028 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/lock.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/lock.yml @@ -284,5 +284,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure locks. diff --git a/2018-03-01-hybrid/docs-ref-autogen/managedapp.yml b/2018-03-01-hybrid/docs-ref-autogen/managedapp.yml index eda87aefc3..796ed5b7a6 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/managedapp.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/managedapp.yml @@ -187,5 +187,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage template solutions provided and maintained by Independent Software Vendors (ISVs). diff --git a/2018-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml b/2018-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml index 4bf603ef13..bff48d2565 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml @@ -272,5 +272,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Managed Applications. diff --git a/2018-03-01-hybrid/docs-ref-autogen/policy.yml b/2018-03-01-hybrid/docs-ref-autogen/policy.yml index 0c984b3d74..b8ac9b4150 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/policy.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/policy.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policies. diff --git a/2018-03-01-hybrid/docs-ref-autogen/policy/assignment.yml b/2018-03-01-hybrid/docs-ref-autogen/policy/assignment.yml index 751eee6c86..9c8344043e 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/policy/assignment.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/policy/assignment.yml @@ -224,5 +224,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy assignments. diff --git a/2018-03-01-hybrid/docs-ref-autogen/policy/definition.yml b/2018-03-01-hybrid/docs-ref-autogen/policy/definition.yml index e0eb4690e8..72abf35404 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/policy/definition.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/policy/definition.yml @@ -232,5 +232,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy definitions. diff --git a/2018-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml b/2018-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml index 9ab9816d44..52b1b32df5 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -21,22 +21,20 @@ directCommands: previewOrExperimentalInfo: "Command group 'postgres server-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az postgres server-arc endpoint list --name - [--k8s-namespace] + az postgres server-arc endpoint list [--k8s-namespace] + [--name] [--use-k8s] examples: - summary: |- List Azure Arc enabled PostgreSQL server endpoints. syntax: az postgres server-arc endpoint list --name postgres01 --k8s-namespace namespace --use-k8s - requiredParameters: - - isRequired: true - name: --name -n - summary: |- - Name of the Azure Arc enabled PostgreSQL server. optionalParameters: - name: --k8s-namespace -k summary: |- The Kubernetes namespace where the Azure Arc enabled PostgreSQL server is deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used. + - name: --name -n + summary: |- + Name of the Azure Arc enabled PostgreSQL server. - name: --use-k8s summary: |- Use local Kubernetes APIs to perform this action. diff --git a/2018-03-01-hybrid/docs-ref-autogen/provider.yml b/2018-03-01-hybrid/docs-ref-autogen/provider.yml index 5898a00528..cd5a602cb6 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/provider.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/provider.yml @@ -139,5 +139,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource providers. diff --git a/2018-03-01-hybrid/docs-ref-autogen/provider/operation.yml b/2018-03-01-hybrid/docs-ref-autogen/provider/operation.yml index 518ec011a4..6544ce6305 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/provider/operation.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/provider/operation.yml @@ -59,5 +59,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get provider operations metadatas. diff --git a/2018-03-01-hybrid/docs-ref-autogen/provider/permission.yml b/2018-03-01-hybrid/docs-ref-autogen/provider/permission.yml index 95846fb713..b5f93b9261 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/provider/permission.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/provider/permission.yml @@ -46,5 +46,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage permissions for a provider. diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource-mover.yml b/2018-03-01-hybrid/docs-ref-autogen/resource-mover.yml index 3c5aa44f8e..1d9ccf7ffc 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource-mover.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource-mover.yml @@ -4,12 +4,10 @@ name: az resource-mover extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage Resource Mover Service API. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Extension commands: - az_resource-mover_move-collection diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml b/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml index 6b7c846932..dc729bc40b 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml @@ -4,31 +4,29 @@ name: az resource-mover move-collection extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-collection. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-collection_bulk-remove(resource-mover) name: az resource-mover move-collection bulk-remove summary: |- - Remove the set of move-resources from move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection bulk-remove [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] [--move-resources] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Remove a move-resource in a move-collection. @@ -40,53 +38,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - Name of the move-collection. + The Move Collection Name. - name: --move-resources summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_commit(resource-mover) name: az resource-mover move-collection commit summary: |- - Commit the set of resources. The commit operation is triggered on the move-resources in the move-state 'CommitPending' or 'CommitFailed', on a successful completion the move-resource's move-state do a transition to Committed. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection commit --move-resources - [--ids] + az resource-mover move-collection commit [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Commit a move-resource. + Commit a move-resource in the move-collection (RegionToRegion) syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Commit resources in the move-collection (RegionToZone) + syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -94,87 +90,100 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_create(resource-mover) name: az resource-mover move-collection create summary: |- - Create a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a move collection. + description: |- + Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- az resource-mover move-collection create --move-collection-name --resource-group [--identity] [--location] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] [--source-region] [--tags] [--target-region] + [--version] examples: - summary: |- - Create a move-collection with system assigned identity. + Create a move-collection with system assigned identity. (RegionToRegion) syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Create a zonal type move-collection with system assigned identity. (RegionToZone) + syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone requiredParameters: - isRequired: true name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + The geo-location where the resource lives. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. - name: --source-region summary: |- - The source region. + Gets or sets the source region. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --target-region summary: |- - The target region. + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_delete(resource-mover) name: az resource-mover move-collection delete summary: |- - Delete a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a move collection. + description: |- + The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection delete [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -188,14 +197,14 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -206,29 +215,24 @@ directCommands: - uid: az_resource-mover_move-collection_discard(resource-mover) name: az resource-mover move-collection discard summary: |- - Discard the set of resources. The discard operation is triggered on the move-resources in the move-state 'CommitPending' or 'DiscardFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection discard --move-resources - [--ids] + az resource-mover move-collection discard [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Discard a remove-resource. syntax: az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -236,50 +240,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_initiate-move(resource-mover) name: az resource-mover move-collection initiate-move summary: |- - Move the set of resources. The move operation is triggered after the move-resources are in the move-state 'MovePending' or 'MoveFailed', on a successful completion the move-resource's move-state do a transition to CommitPending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection initiate-move --move-resources - [--ids] + az resource-mover move-collection initiate-move [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Move the set of resources. + Move the set of resources. (RegionToRegion) syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Move VMs into zonal configuration within the same region (RegionToZone) + syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -287,33 +292,39 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_list(resource-mover) name: az resource-mover move-collection list summary: |- - List details of the move-collections. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List all the Move Collections in the subscription. + description: |- + The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension - syntax: az resource-mover move-collection list [--resource-group] + syntax: >- + az resource-mover move-collection list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all move-collections. @@ -322,94 +333,114 @@ directCommands: List all move-collections by resource group. syntax: az resource-mover move-collection list -g MyResourceGroup optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - uid: az_resource-mover_move-collection_list-required-for(resource-mover) name: az resource-mover move-collection list-required-for summary: |- - List the move-resources for which an arm resource is required for. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List of the move resources for which an arm resource is required for. + description: |- + The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection list-required-for --move-collection-name - --resource-group - --source-id - examples: - - summary: |- - List the move-resources for which an arm resource is required for. - syntax: az resource-mover move-collection list-required-for --name MyMoveCollection --resource-group MyResourceGroup --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/nic1" + az resource-mover move-collection list-required-for --source-id + [--ids] + [--move-collection-name] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true - name: --move-collection-name --name -n + name: --source-id + summary: |- + The sourceId for which the api is invoked. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name --name -n summary: |- The Move Collection Name. - - isRequired: true - name: --resource-group -g + - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --source-id + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --subscription summary: |- - The sourceId for which the api is invoked. + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_list-unresolved-dependency(resource-mover) name: az resource-mover move-collection list-unresolved-dependency summary: |- - List the details of the unresolved dependencies in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Lists a list of unresolved dependencies. + description: |- + The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection list-unresolved-dependency --move-collection-name --resource-group [--dependency-level {Descendant, Direct}] + [--filter] + [--max-items] + [--next-token] + [--orderby] examples: - summary: |- List the unresolved dependencies. syntax: az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --dependency-level parameterValueGroup: "Descendant, Direct" summary: |- - The dependency level. + Defines the dependency level. + - name: --filter + summary: |- + The filter to apply on the operation. For example, $apply=filter(count eq 2). + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. + - name: --orderby + summary: |- + OData order by query option. For example, you can use $orderby=Count desc. - uid: az_resource-mover_move-collection_prepare(resource-mover) name: az resource-mover move-collection prepare summary: |- - Prepare the set of resources. The prepare operation is on the move-resources that are in the move-state 'PreparePending' or 'PrepareFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection prepare --move-resources - [--ids] + az resource-mover move-collection prepare [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Prepare a move-resource. syntax: az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -417,66 +448,72 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_resolve-dependency(resource-mover) name: az resource-mover move-collection resolve-dependency summary: |- - Compute, resolve and validate the dependencies of the move-resources in the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Computes, resolves and validate the dependencies of the moveResources in the move collection. + description: |- + Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection resolve-dependency [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] examples: - summary: |- - Resolve the dependency of the move-resources. + Resolve the dependency of the move-resources. (RegionToRegion) syntax: az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Resolve the dependency of the move-resources. (RegionToZone) + syntax: az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_show(resource-mover) name: az resource-mover move-collection show summary: |- - Get the details of a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the move collection. + description: |- + The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection show [--ids] @@ -493,64 +530,94 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_update(resource-mover) name: az resource-mover move-collection update summary: |- - Update a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Update a move collection. + description: |- + Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection update [--identity] + az resource-mover move-collection update [--add] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--identity] [--ids] [--move-collection-name] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] + [--remove] [--resource-group] + [--set] + [--source-region] [--subscription] [--tags] + [--target-region] + [--version] examples: - summary: |- Update a move-collection. syntax: az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup optionalParameters: + - name: --add + summary: |- + Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --force-string + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. + - name: --remove + summary: |- + Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --set + summary: |- + Update an object by specifying a property path and value to set. Example: --set property1.property2=. + - name: --source-region + summary: |- + Gets or sets the source region. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --target-region + summary: |- + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_wait(resource-mover) name: az resource-mover move-collection wait summary: |- - Place the CLI in a waiting state until a condition of the move-collection is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection wait [--created] @@ -564,13 +631,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully deleted. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --deleted - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully created. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --created optionalParameters: - name: --created defaultValue: "False" @@ -596,10 +656,10 @@ directCommands: Polling interval in seconds. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml b/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml index 3f887cf77d..a1af1c1331 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml @@ -4,118 +4,86 @@ name: az resource-mover move-resource extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-resource. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-resource_add(resource-mover) name: az resource-mover move-resource add summary: |- - Create or update a move-resource to the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a Move Resource in the move collection. + description: |- + The 'az resource-mover move-resource add' command remains same for both 'RegionToRegion' (default) and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-resource add --move-collection-name - --move-resource-name - --resource-group - [--depends-on-overrides] + az resource-mover move-resource add [--depends-on-overrides] [--existing-target-id] - [--no-wait] + [--ids] + [--move-collection-name] + [--move-resource-name] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] + [--resource-group] [--resource-settings] [--source-id] + [--subscription] examples: - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings '{ - "resourceType": "Microsoft.Network/virtualNetworks", - "targetResourceName": "MyVNet-target" - }' + Add a vNet as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet\" --resource-settings '{ \"resourceType\": \"Microsoft.Network/virtualNetworks\", \"targetResourceName\": \"MyVNet-target\" }'" - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings @resource-settings.json + Add a VM as a move-resource to the move-collection. (RegionToZone) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyZonalMoveCollection --name MyVMMoveResource --source-id \"/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetResourceName\": \"MyVM\", \"targetAvailabilityZone\": \"2\", \"targetVmSize\": \"Standard_B2s\" }'" - summary: |- - Add a VM as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM" - - --depends-on-overrides id="/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" target-id="/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" - - --resource-settings '{ - "resourceType": "Microsoft.Compute/virtualMachines", - "targetAvailabilitySetId": "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet", - "targetAvailabilityZone": "2", - "targetResourceName": "MyVM-target", - "targetVmSize": null, - "userManagedIdentities": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] - }' - requiredParameters: - - isRequired: true - name: --move-collection-name - summary: |- - The move-collection name. - - isRequired: true - name: --move-resource-name --name -n - summary: |- - The move-resource name. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Add a VM as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM\" --depends-on-overrides id=\"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" target-id=\"/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetAvailabilitySetId\": \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet\", \"targetAvailabilityZone\": \"2\", \"targetResourceName\": \"MyVM-target\", \"targetVmSize\": null, \"userManagedIdentities\": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] }'" optionalParameters: - name: --depends-on-overrides summary: |- - The move-resource dependencies overrides. - description: |- - Usage: --depends-on-overrides id=XX target-id=XX - - id: The ARM ID of the dependent resource. - target-id: The resource ARM ID of either the move-resource or the resource ARM ID of the dependent resource. - - Multiple actions can be specified by using more than one --depends-on-overrides argument. + Gets or sets the move resource dependencies overrides. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --existing-target-id summary: |- - The existing target ARM Id of the resource. + Gets or sets the existing target ARM Id of the resource. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name + summary: |- + The Move Collection Name. + - name: --move-resource-name --name -n + summary: |- + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --resource-settings summary: |- - The resource settings. Expected value: json-string/@json-file. + The resource settings. Expected value: json-string/@json-file. Support json-file and yaml-file. - name: --source-id summary: |- - The Source ARM Id of the resource. + Gets or sets the Source ARM Id of the resource. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_delete(resource-mover) name: az resource-mover move-resource delete summary: |- - Delete a move-resource from the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a Move Resource from the move collection. + description: |- + The 'az resource-mover move-resource delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource delete [--ids] [--move-collection-name] [--move-resource-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -129,17 +97,17 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -150,34 +118,47 @@ directCommands: - uid: az_resource-mover_move-resource_list(resource-mover) name: az resource-mover move-resource list summary: |- - List the move-resources in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List the Move Resources in the move collection. + description: |- + The 'az resource-mover move-resource list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource list --move-collection-name --resource-group + [--filter] + [--max-items] + [--next-token] examples: - summary: |- List the move-resources in a move-collection. syntax: az resource-mover move-resource list --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + optionalParameters: + - name: --filter + summary: |- + The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_resource-mover_move-resource_show(resource-mover) name: az resource-mover move-resource show summary: |- - Get the details of a move-resource. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the Move Resource. + description: |- + The 'az resource-mover move-resource show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource show [--ids] @@ -195,23 +176,21 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_wait(resource-mover) name: az resource-mover move-resource wait summary: |- - Place the CLI in a waiting state until a condition of the move-resource is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource wait [--created] @@ -226,13 +205,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully created. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --created - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully deleted. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --deleted optionalParameters: - name: --created defaultValue: "False" @@ -258,13 +230,13 @@ directCommands: Polling interval in seconds. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource.yml b/2018-03-01-hybrid/docs-ref-autogen/resource.yml index 135aabce03..6b769beb7f 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource.yml @@ -732,5 +732,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resources. diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource/link.yml b/2018-03-01-hybrid/docs-ref-autogen/resource/link.yml index f2b488a62a..6be731ae36 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource/link.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource/link.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Linking is a feature of the Resource Manager. It enables declaring relationships between resources even if they do not reside in the same resource group. Linking has no impact on resource usage, billing, or role-based access. It allows for managing multiple resources across groups as a single unit. diff --git a/2018-03-01-hybrid/docs-ref-autogen/resource/lock.yml b/2018-03-01-hybrid/docs-ref-autogen/resource/lock.yml index 55f2453025..b542c25008 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/resource/lock.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/resource/lock.yml @@ -267,5 +267,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource level locks. diff --git a/2018-03-01-hybrid/docs-ref-autogen/scvmm.yml b/2018-03-01-hybrid/docs-ref-autogen/scvmm.yml index c68bc47dce..d32b42e906 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/scvmm.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/scvmm.yml @@ -52,6 +52,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml index 56f846f67d..452bb2d8c2 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml @@ -22,7 +22,6 @@ directCommands: sourceType: Extension syntax: >- az scvmm vm create --custom-location - --location --name --resource-group [--admin-password] @@ -34,6 +33,7 @@ directCommands: [--dynamic-memory-max] [--dynamic-memory-min] [--inventory-item] + [--location] [--memory-size] [--nic] [--no-wait] @@ -55,10 +55,6 @@ directCommands: name: --custom-location summary: |- Name or ID of the custom location that will manage this resource. - - isRequired: true - name: --location -l - summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - isRequired: true name: --name -n summary: |- @@ -96,6 +92,9 @@ directCommands: - name: --inventory-item -i summary: |- Name or ID of the inventory item. + - name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - name: --memory-size summary: |- Desired memory size in MBs for the vm. @@ -170,13 +169,13 @@ directCommands: previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az scvmm vm delete [--deleteFromHost] + az scvmm vm delete [--delete-from-host] + [--delete-machine] [--force] [--ids] [--name] [--no-wait] [--resource-group] - [--retain] [--subscription] [--yes] examples: @@ -196,12 +195,15 @@ directCommands: Delete the VM from SCVMM syntax: az scvmm vm delete --subscription contoso-sub --resource-group contoso-rg --name contoso-avset --deleteFromHost optionalParameters: - - name: --deleteFromHost + - name: --delete-from-host summary: |- - Delete the VM from the SCVMM. + Delete the VM from the VMware host. + - name: --delete-machine + summary: |- + Delete the parent Microsoft.HybridCompute Machine resource. - name: --force summary: |- - Force the resource to be deleted from azure. + Force delete the azure resource. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -215,9 +217,6 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --retain - summary: |- - Disable the VM from azure but retain the VM in VMM. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -270,8 +269,10 @@ directCommands: name: az scvmm vm list summary: |- Retrieve a list of VMs. - status: Preview + status: Preview and Deprecated + isDeprecated: true isPreview: true + deprecateInfo: This command has been deprecated and will be removed in a future release. Use 'scvmm vm show' instead. previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: az scvmm vm list [--resource-group] @@ -467,7 +468,6 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --skip-shutdown - defaultValue: "False" parameterValueGroup: "false, true" summary: |- Skip shutdown and power-off immediately. @@ -605,6 +605,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml new file mode 100644 index 0000000000..e868aabd26 --- /dev/null +++ b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml @@ -0,0 +1,304 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_extension +name: az scvmm vm extension +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Manage vm extension with scvmm. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_extension_create(scvmm) + name: az scvmm vm extension create + summary: |- + The operation to create the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension create --location + --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Create a VM Extension + syntax: az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +- uid: az_scvmm_vm_extension_delete(scvmm) + name: az scvmm vm extension delete + summary: |- + The operation to delete the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension delete [--ids] + [--name] + [--no-wait] + [--resource-group] + [--subscription] + [--vm-name] + [--yes] + examples: + - summary: |- + Delete a VM Extension + syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm where the extension should be deleted. + - name: --yes -y + defaultValue: "False" + summary: |- + Do not prompt for confirmation. +- uid: az_scvmm_vm_extension_list(scvmm) + name: az scvmm vm extension list + summary: |- + The operation to get all extensions of a non-Azure vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension list --resource-group + --vm-name + [--expand] + examples: + - summary: |- + Get all VM Extensions + syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm containing the extension. + optionalParameters: + - name: --expand + summary: |- + The expand expression to apply on the operation. +- uid: az_scvmm_vm_extension_show(scvmm) + name: az scvmm vm extension show + summary: |- + The operation to get the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension show [--ids] + [--name] + [--resource-group] + [--subscription] + [--vm-name] + examples: + - summary: |- + Get VM Extension + syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm containing the extension. +- uid: az_scvmm_vm_extension_update(scvmm) + name: az scvmm vm extension update + summary: |- + The operation to update the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension update --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Update a VM Extension + syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +commands: +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Manage vm extension with scvmm. diff --git a/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml new file mode 100644 index 0000000000..ff7c276ac9 --- /dev/null +++ b/2018-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml @@ -0,0 +1,111 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_guest-agent +name: az scvmm vm guest-agent +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Vm guest agent. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_guest-agent_enable(scvmm) + name: az scvmm vm guest-agent enable + summary: |- + Enable guest agent on the vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent enable --password + --resource-group + --username + --vm-name + [--https-proxy] + [--no-wait] + examples: + - summary: |- + Enable guest agent on the vm + syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass --resource-group contoso-rg --subscription contoso-sub --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --password + summary: |- + Username password credentials to use for connecting to the VM. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --username + summary: |- + Username to use for connecting to the vm. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. + optionalParameters: + - name: --https-proxy + summary: |- + HTTPS proxy server url for the VM. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. +- uid: az_scvmm_vm_guest-agent_show(scvmm) + name: az scvmm vm guest-agent show + summary: |- + Get details of a guest agent by guest agent name, resource-group and vm name. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent show --resource-group + --vm-name + examples: + - summary: |- + Get details of a guest agent + syntax: az scvmm vm guest-agent show --resource-group contoso-rg --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. +commands: +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Vm guest agent. diff --git a/2018-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml b/2018-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml deleted file mode 100644 index 4a4347faaa..0000000000 --- a/2018-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml +++ /dev/null @@ -1,6 +0,0 @@ -### YamlMime:AzureCLIGroup -uid: sp-Stack_HCI_VM -name: Stack HCI VM -commands: -- az_stack-hci-vm -metadata: {} diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml index 7a19d9b2dc..b8f3501d17 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml @@ -38,14 +38,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -55,10 +57,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -90,17 +92,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -132,23 +136,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_list-support-types() name: az spring-cloud connection list-support-types summary: |- @@ -198,23 +204,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_validate() name: az spring-cloud connection validate summary: |- @@ -243,23 +251,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_wait() name: az spring-cloud connection wait summary: |- @@ -289,7 +299,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. @@ -307,7 +317,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -321,10 +333,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml index 789af0ef1a..a36f6ca536 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml @@ -48,7 +48,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -65,7 +65,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -76,7 +78,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -84,7 +86,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -176,7 +178,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -190,17 +192,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -252,7 +256,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -266,7 +270,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -280,7 +286,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -288,7 +294,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -373,7 +379,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -390,7 +396,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -404,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -412,7 +420,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -496,7 +504,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -513,7 +521,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -524,7 +534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -532,7 +542,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -616,7 +626,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +643,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -644,7 +656,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,7 +664,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +748,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -750,7 +762,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -761,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -769,7 +783,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -852,7 +866,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -866,7 +880,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -880,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -888,7 +904,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -974,7 +990,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -988,7 +1004,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1004,10 +1022,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1088,7 +1106,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1105,7 +1123,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1116,7 +1136,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1134,7 +1154,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1189,7 +1209,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1206,14 +1226,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1231,7 +1253,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1298,7 +1320,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1315,7 +1337,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1331,7 +1355,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1349,7 +1373,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1409,7 +1433,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1426,14 +1450,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1451,7 +1477,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1507,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1524,7 +1550,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1535,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1546,7 +1574,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1596,7 +1624,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1613,14 +1641,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1631,7 +1661,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1685,7 +1715,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1699,7 +1729,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1713,7 +1745,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1721,7 +1753,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1800,7 +1832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1814,7 +1846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1825,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1833,7 +1867,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1911,7 +1945,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1928,7 +1962,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1939,7 +1975,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1957,7 +1993,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2030,7 +2066,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2044,7 +2080,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2060,7 +2098,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2068,7 +2106,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2148,7 +2186,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2162,7 +2200,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2173,7 +2213,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2181,7 +2221,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2242,7 +2282,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2256,7 +2296,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2267,7 +2309,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2275,7 +2317,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2355,7 +2397,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2369,7 +2411,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2380,7 +2424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2388,7 +2432,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2445,7 +2489,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2459,7 +2503,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2470,7 +2516,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2478,7 +2524,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml index 153e6b0b18..2dfdbef869 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml @@ -42,7 +42,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -56,7 +56,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -70,7 +72,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -78,7 +80,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -150,7 +152,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -164,7 +166,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -177,7 +181,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -189,7 +193,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -231,7 +235,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -245,7 +249,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -259,7 +265,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -267,7 +273,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -332,7 +338,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -346,7 +352,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -360,7 +368,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -368,7 +376,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -433,7 +441,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -447,7 +455,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -461,7 +471,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -469,7 +479,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -534,7 +544,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -548,7 +558,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -562,7 +574,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -570,7 +582,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -635,7 +647,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -649,7 +661,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -663,7 +677,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -671,7 +685,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +750,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -750,7 +764,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -764,7 +780,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -772,7 +788,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,7 +852,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -850,7 +866,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -864,10 +882,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -929,7 +947,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -943,7 +961,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -957,7 +977,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -972,7 +992,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1011,7 +1031,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1025,7 +1045,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1035,7 +1057,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1050,7 +1072,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1094,7 +1116,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1108,7 +1130,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1122,7 +1146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1137,7 +1161,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1181,7 +1205,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1195,7 +1219,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1205,7 +1231,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1220,7 +1246,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1260,7 +1286,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1274,7 +1300,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1288,7 +1316,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1296,7 +1324,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1330,7 +1358,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1344,7 +1372,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1354,7 +1384,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1362,7 +1392,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1401,7 +1431,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1415,7 +1445,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1429,7 +1461,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1437,7 +1469,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1501,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1515,7 +1547,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1529,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1537,7 +1571,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1596,7 +1630,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1610,7 +1644,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1624,7 +1660,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1639,7 +1675,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1687,7 +1723,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1701,7 +1737,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1715,7 +1753,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1723,7 +1761,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1785,7 +1823,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1799,7 +1837,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1813,7 +1853,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1821,7 +1861,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1864,7 +1904,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1878,7 +1918,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1892,7 +1934,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1900,7 +1942,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1962,7 +2004,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1976,7 +2018,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1990,7 +2034,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1998,7 +2042,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2040,7 +2084,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2054,7 +2098,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2068,7 +2114,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,7 +2122,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring.yml b/2018-03-01-hybrid/docs-ref-autogen/spring.yml index 485ae7f209..65749e42df 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring.yml @@ -301,6 +301,30 @@ directCommands: - summary: |- List all plans. syntax: az spring list-marketplace-plan -o table +- uid: az_spring_list-support-server-versions(spring) + name: az spring list-support-server-versions + summary: |- + (Standard and Basic Tier Only) List supported server versions. + status: Preview + isPreview: true + previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + sourceType: Extension + syntax: >- + az spring list-support-server-versions --resource-group + --service + examples: + - summary: |- + List supported server versions. + syntax: az spring list-support-server-versions -o table -s MyService -g MyResourceGroup + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. - uid: az_spring_show(spring) name: az spring show summary: |- @@ -566,6 +590,7 @@ commands: - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) - az_spring_config-server - az_spring_config-server_clear(spring) - az_spring_config-server_disable(spring) @@ -675,6 +700,7 @@ commands: - az_spring_gateway_update(spring) - az_spring_list(spring) - az_spring_list-marketplace-plan(spring) +- az_spring_list-support-server-versions(spring) - az_spring_service-registry - az_spring_service-registry_bind(spring) - az_spring_service-registry_create(spring) diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/app.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/app.yml index ab25b24e0f..1cd618bab9 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/app.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/app.yml @@ -415,6 +415,7 @@ directCommands: [--registry-password] [--registry-username] [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}] + [--server-version] [--source-path] [--startup-probe-config] [--target-module] @@ -426,6 +427,9 @@ directCommands: - summary: |- Deploy a pre-built jar to an app with jvm options and environment variables. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar + - summary: |- + Deploy a pre-built war to an app with server version, jvm options and environment variables (Standard and Basic Tiers Only). + syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar - summary: |- Deploy source code to a specific deployment of an app. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path @@ -460,7 +464,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -563,6 +567,9 @@ directCommands: parameterValueGroup: "Java_11, Java_17, Java_8, NetCore_31" summary: |- Runtime version of used language. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --source-path summary: |- Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided. diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml index dcc3191376..71c8bd02fb 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml @@ -58,6 +58,7 @@ directCommands: [--scale-rule-metadata] [--scale-rule-name] [--scale-rule-type] + [--server-version] [--skip-clone-settings] [--source-path] [--startup-probe-config] @@ -99,7 +100,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -223,6 +224,9 @@ directCommands: - name: --scale-rule-type --srt summary: |- The type of the scale rule. Default: http. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --skip-clone-settings defaultValue: "False" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml index 13f8eaec64..61a4e22133 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml @@ -28,6 +28,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -35,6 +36,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -80,6 +82,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -102,6 +107,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. @@ -238,6 +247,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -245,6 +255,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -290,6 +301,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -312,6 +326,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/certificate.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/certificate.yml index 5ed4bdbe1d..4c6a781f4d 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/certificate.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/certificate.yml @@ -20,6 +20,7 @@ directCommands: az spring certificate add --name --resource-group --service + [--enable-auto-sync {false, true}] [--only-public-cert {false, true}] [--public-certificate-file] [--vault-certificate-name] @@ -42,6 +43,11 @@ directCommands: summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. optionalParameters: + - name: --enable-auto-sync + defaultValue: "False" + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. - name: --only-public-cert defaultValue: "False" parameterValueGroup: "false, true" @@ -157,12 +163,49 @@ directCommands: name: --service -s summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. +- uid: az_spring_certificate_update(spring) + name: az spring certificate update + summary: |- + Update a certificate in Azure Spring Apps. + status: GA + sourceType: Extension + syntax: >- + az spring certificate update --name + --resource-group + --service + [--enable-auto-sync {false, true}] + examples: + - summary: |- + Enable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true + - summary: |- + Disable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false + requiredParameters: + - isRequired: true + name: --name -n + summary: |- + Name of certificate. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. + optionalParameters: + - name: --enable-auto-sync + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. commands: - az_spring_certificate_add(spring) - az_spring_certificate_list(spring) - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) globalParameters: - name: --debug summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/connection.yml index f6c6051669..176dcc3111 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/connection.yml @@ -34,14 +34,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -51,10 +53,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -84,17 +86,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -124,23 +128,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_list-support-types() name: az spring connection list-support-types summary: |- @@ -186,23 +192,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_validate() name: az spring connection validate summary: |- @@ -229,23 +237,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_wait() name: az spring connection wait summary: |- @@ -273,7 +283,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. @@ -291,7 +301,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -305,10 +317,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml index a8cb097cd1..29ca0fbf26 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml @@ -44,7 +44,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -61,7 +61,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -72,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -80,7 +82,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -170,7 +172,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -184,17 +186,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -244,7 +248,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -258,7 +262,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -272,7 +278,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -280,7 +286,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -363,7 +369,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -380,7 +386,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -394,7 +402,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -402,7 +410,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -484,7 +492,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -501,7 +509,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -512,7 +522,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -520,7 +530,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -602,7 +612,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -619,7 +629,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -630,7 +642,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -638,7 +650,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -720,7 +732,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -734,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -745,7 +759,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -753,7 +767,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -834,7 +848,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -848,7 +862,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -862,7 +878,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -870,7 +886,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -954,7 +970,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -968,7 +984,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -984,10 +1002,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1068,7 +1086,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1085,7 +1103,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1096,7 +1116,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1114,7 +1134,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1167,7 +1187,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1184,14 +1204,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1209,7 +1231,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1276,7 +1298,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1293,7 +1315,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1309,7 +1333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1327,7 +1351,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1385,7 +1409,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1402,14 +1426,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1427,7 +1453,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1481,7 +1507,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1498,7 +1524,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1509,7 +1537,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1520,7 +1548,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1568,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1585,14 +1613,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1603,7 +1633,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1655,7 +1685,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1669,7 +1699,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1683,7 +1715,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1691,7 +1723,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1768,7 +1800,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1782,7 +1814,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1793,7 +1827,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1801,7 +1835,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1877,7 +1911,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1894,7 +1928,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1905,7 +1941,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1923,7 +1959,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1994,7 +2030,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2008,7 +2044,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2024,7 +2062,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2070,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2110,7 +2148,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2124,7 +2162,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2135,7 +2175,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2143,7 +2183,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2202,7 +2242,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2216,7 +2256,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2227,7 +2269,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2235,7 +2277,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2313,7 +2355,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2327,7 +2369,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2338,7 +2382,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2346,7 +2390,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2401,7 +2445,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2415,7 +2459,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2426,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2434,7 +2480,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml b/2018-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml index 66da61e2e7..1684f816cd 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml @@ -38,7 +38,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -52,7 +52,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -66,7 +68,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -74,7 +76,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -144,7 +146,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -158,7 +160,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -171,7 +175,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -183,7 +187,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -223,7 +227,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -237,7 +241,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -251,7 +257,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -259,7 +265,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -322,7 +328,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -336,7 +342,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -350,7 +358,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +366,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -421,7 +429,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -435,7 +443,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -449,7 +459,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -457,7 +467,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -520,7 +530,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -534,7 +544,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -548,7 +560,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -556,7 +568,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -619,7 +631,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +645,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -647,7 +661,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -655,7 +669,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -718,7 +732,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -732,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -746,7 +762,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -754,7 +770,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -816,7 +832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -830,7 +846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -844,10 +862,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -909,7 +927,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -923,7 +941,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -937,7 +957,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -952,7 +972,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -989,7 +1009,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1003,7 +1023,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1013,7 +1035,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1028,7 +1050,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1072,7 +1094,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1086,7 +1108,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1100,7 +1124,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1115,7 +1139,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1157,7 +1181,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1171,7 +1195,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1181,7 +1207,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1196,7 +1222,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1234,7 +1260,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1248,7 +1274,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1262,7 +1290,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1270,7 +1298,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1302,7 +1330,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1316,7 +1344,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1326,7 +1356,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1334,7 +1364,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1371,7 +1401,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1385,7 +1415,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1399,7 +1431,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1407,7 +1439,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1469,7 +1501,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1483,7 +1515,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1497,7 +1531,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1505,7 +1539,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1562,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1576,7 +1610,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1590,7 +1626,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1605,7 +1641,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1651,7 +1687,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1665,7 +1701,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1679,7 +1717,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1687,7 +1725,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1747,7 +1785,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1761,7 +1799,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1775,7 +1815,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1783,7 +1823,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1824,7 +1864,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1838,7 +1878,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1852,7 +1894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1860,7 +1902,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1920,7 +1962,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1934,7 +1976,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1948,7 +1992,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +2000,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1996,7 +2040,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2010,7 +2054,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2024,7 +2070,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2078,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml b/2018-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml index fd2d12feca..7ea3e81023 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml @@ -573,7 +573,7 @@ directCommands: - isRequired: true name: --destination-path -d summary: |- - The upload destination directory path. It should be an absolute path to container. If the specified destination path does not exist, a new directory path will be created. + The destination path that will be prepended to the blob name. - isRequired: true name: --source -s summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/tag.yml b/2018-03-01-hybrid/docs-ref-autogen/tag.yml index 431111437e..0f95578f9e 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/tag.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/tag.yml @@ -164,5 +164,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Tag Management on a resource. diff --git a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection.yml b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection.yml index 5cb6b4634d..3768e89313 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection.yml @@ -22,6 +22,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--yes] examples: - summary: |- @@ -42,14 +43,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --yes -y defaultValue: "False" summary: |- @@ -63,6 +67,7 @@ directCommands: syntax: >- az webapp connection list [--name] [--resource-group] + [--slot] [--source-id] examples: - summary: |- @@ -77,10 +82,13 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -95,6 +103,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- List a connection's source configurations interactively @@ -114,10 +123,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_list-support-types() name: az webapp connection list-support-types summary: |- @@ -148,6 +160,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Get a connection interactively @@ -167,10 +180,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_validate() name: az webapp connection validate summary: |- @@ -182,6 +198,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Validate a connection interactively @@ -201,10 +218,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_wait() name: az webapp connection wait summary: |- @@ -221,6 +241,7 @@ directCommands: [--interval] [--name] [--resource-group] + [--slot] [--timeout] [--updated] examples: @@ -255,10 +276,13 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml index abe31f256d..58170d03b6 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml @@ -27,6 +27,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -40,6 +41,9 @@ directCommands: - summary: |- Create a connection between webapp and appconfig with resource name syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --tg AppconfigRG --app-config MyConfigStore --system-identity + - summary: |- + Create a connection between webapp slot and appconfig with resource name + syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --slot MySlot --tg AppconfigRG --app-config MyConfigStore --system-identity - summary: |- Create a connection between webapp and appconfig with resource id syntax: az webapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity @@ -59,7 +63,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -85,6 +89,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -129,6 +136,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--source-id] [--vault-id] examples: @@ -173,14 +181,17 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -206,6 +217,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -219,6 +231,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-cassandra with resource name syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-cassandra with resource name + syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity - summary: |- Create a connection between webapp and cosmos-cassandra with resource id syntax: az webapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity @@ -241,7 +256,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -252,7 +267,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -271,6 +286,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -316,6 +334,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -329,6 +348,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-gremlin with resource name syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-gremlin with resource name + syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity - summary: |- Create a connection between webapp and cosmos-gremlin with resource id syntax: az webapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity @@ -354,7 +376,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -365,7 +387,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -384,6 +406,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -428,6 +453,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -441,6 +467,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-mongo with resource name syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-mongo with resource name + syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-mongo with resource id syntax: az webapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity @@ -463,7 +492,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -474,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -493,6 +522,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -537,6 +569,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -550,6 +583,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-sql with resource name syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-sql with resource name + syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-sql with resource id syntax: az webapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity @@ -572,7 +608,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -583,7 +619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -602,6 +638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -645,6 +684,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--table] @@ -659,6 +699,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-table with resource name syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --table MyTable --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-table with resource name + syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --table MyTable --system-identity - summary: |- Create a connection between webapp and cosmos-table with resource id syntax: az webapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity @@ -678,7 +721,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -689,7 +732,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -708,6 +751,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -754,6 +800,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -767,6 +814,9 @@ directCommands: - summary: |- Create a connection between webapp and eventhub with resource name syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --tg EventhubRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and eventhub with resource name + syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --slot MySlot --tg EventhubRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and eventhub with resource id syntax: az webapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity @@ -783,7 +833,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -797,7 +847,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -816,6 +866,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -858,6 +911,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -872,6 +926,9 @@ directCommands: - summary: |- Create a connection between webapp and keyvault with resource name syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --tg KeyvaultRG --vault MyVault --system-identity + - summary: |- + Create a connection between webapp slot and keyvault with resource name + syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --slot MySlot --tg KeyvaultRG --vault MyVault --system-identity - summary: |- Create a connection between webapp and keyvault with resource id syntax: az webapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity @@ -894,7 +951,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -910,7 +967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -924,6 +981,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -973,6 +1033,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -984,6 +1045,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql with resource name syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql with resource name + syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql with resource id syntax: az webapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1009,7 +1073,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1020,7 +1084,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1040,6 +1104,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1069,6 +1136,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1081,6 +1149,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql-flexible with resource name syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql-flexible with resource name + syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql-flexible with resource id syntax: az webapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1106,14 +1177,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1129,6 +1200,9 @@ directCommands: - name: --server summary: |- Name of the mysql flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1206,14 +1280,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1293,6 +1367,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1305,6 +1380,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres with resource name syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres with resource name + syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres with resource id syntax: az webapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1336,7 +1414,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1352,7 +1430,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1372,6 +1450,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1456,7 +1537,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1472,7 +1553,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1628,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1559,6 +1641,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres-flexible with resource name syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres-flexible with resource name + syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres-flexible with resource id syntax: az webapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1584,14 +1669,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,6 +1692,9 @@ directCommands: - name: --server summary: |- Name of postgres flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1682,14 +1770,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1848,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1771,6 +1860,9 @@ directCommands: - summary: |- Create a connection between webapp and redis with resource name syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis with resource name + syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis with resource id syntax: az webapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret @@ -1790,7 +1882,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1801,7 +1893,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1810,6 +1902,9 @@ directCommands: - name: --server summary: |- Name of the redis server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1838,6 +1933,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1849,6 +1945,9 @@ directCommands: - summary: |- Create a connection between webapp and redis-enterprise with resource name syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis-enterprise with resource name + syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis-enterprise with resource id syntax: az webapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret @@ -1868,14 +1967,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1884,6 +1983,9 @@ directCommands: - name: --server summary: |- Name of the redis enterprise server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1914,6 +2016,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1927,6 +2030,9 @@ directCommands: - summary: |- Create a connection between webapp and servicebus with resource name syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --tg ServicebusRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and servicebus with resource name + syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --slot MySlot --tg ServicebusRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and servicebus with resource id syntax: az webapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity @@ -1943,7 +2049,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1957,7 +2063,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1976,6 +2082,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2018,6 +2127,7 @@ directCommands: [--secret] [--service-principal] [--signalr] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2031,6 +2141,9 @@ directCommands: - summary: |- Create a connection between webapp and signalr with resource name syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --tg SignalrRG --signalr MySignalR --system-identity + - summary: |- + Create a connection between webapp slot and signalr with resource name + syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --slot MySlot --tg SignalrRG --signalr MySignalR --system-identity - summary: |- Create a connection between webapp and signalr with resource id syntax: az webapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity @@ -2047,7 +2160,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2058,7 +2171,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,6 +2189,9 @@ directCommands: - name: --signalr summary: |- Name of the signalr service. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2120,6 +2236,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2132,6 +2249,9 @@ directCommands: - summary: |- Create a connection between webapp and sql with resource name syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and sql with resource name + syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --slot MySlot --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and sql with resource id syntax: az webapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -2157,7 +2277,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2168,7 +2288,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2188,6 +2308,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2265,7 +2388,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2276,7 +2399,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2353,6 +2476,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2366,6 +2490,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-blob with resource name syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-blob with resource name + syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-blob with resource id syntax: az webapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity @@ -2391,7 +2518,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2407,7 +2534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2426,6 +2553,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2468,6 +2598,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2479,6 +2610,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-file with resource name syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-file with resource name + syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-file with resource id syntax: az webapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret @@ -2498,7 +2632,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2509,7 +2643,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2519,6 +2653,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2549,6 +2686,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2562,6 +2700,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-queue with resource name syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-queue with resource name + syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-queue with resource id syntax: az webapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity @@ -2581,7 +2722,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2592,7 +2733,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2611,6 +2752,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2653,6 +2797,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2664,6 +2809,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-table with resource name syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-table with resource name + syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-table with resource id syntax: az webapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret @@ -2683,7 +2831,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2694,7 +2842,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2704,6 +2852,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2732,6 +2883,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2746,6 +2898,9 @@ directCommands: - summary: |- Create a connection between webapp and webpubsub with resource name syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity + - summary: |- + Create a connection between webapp slot and webpubsub with resource name + syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --slot MySlot --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity - summary: |- Create a connection between webapp and webpubsub with resource id syntax: az webapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity @@ -2762,7 +2917,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2773,7 +2928,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2788,6 +2943,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. diff --git a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml index 5e3a0a9a07..5c31692daf 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml @@ -23,6 +23,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -49,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -60,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -75,6 +76,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -110,6 +114,7 @@ directCommands: [--schema-key] [--schema-registry] [--schema-secret] + [--slot] [--source-id] [--vault-id] examples: @@ -149,14 +154,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -166,6 +171,9 @@ directCommands: - name: --schema-secret summary: |- Schema registry API-Key (secret). + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -190,6 +198,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -216,7 +225,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -227,7 +236,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -246,6 +255,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -280,6 +292,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -306,7 +319,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -317,7 +330,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -336,6 +349,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -370,6 +386,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -396,7 +413,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -407,7 +424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -426,6 +443,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -460,6 +480,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -486,7 +507,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -497,7 +518,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -516,6 +537,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -550,6 +574,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -576,7 +601,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -587,7 +612,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -606,6 +631,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -640,6 +668,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -666,7 +695,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -677,7 +706,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -696,6 +725,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -729,6 +761,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -755,7 +788,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -766,7 +799,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -780,6 +813,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -816,6 +852,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -846,7 +883,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -857,7 +894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -874,6 +911,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -893,6 +933,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -924,14 +965,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -944,6 +985,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -974,6 +1018,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1005,7 +1050,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1016,7 +1061,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1033,6 +1078,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1057,6 +1105,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -1088,14 +1137,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1108,6 +1157,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1132,6 +1184,7 @@ directCommands: [--private-endpoint {false, true}] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1156,7 +1209,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1167,12 +1220,15 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1191,6 +1247,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1215,19 +1272,22 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1249,6 +1309,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1275,7 +1336,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1286,7 +1347,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1305,6 +1366,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1338,6 +1402,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1364,7 +1429,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1375,7 +1440,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1390,6 +1455,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1424,6 +1492,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1455,7 +1524,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1466,7 +1535,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1483,6 +1552,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1509,6 +1581,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1535,7 +1608,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1546,7 +1619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1565,6 +1638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1598,6 +1674,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1622,7 +1699,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1633,7 +1710,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1643,6 +1720,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1664,6 +1744,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1690,7 +1771,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1701,7 +1782,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1720,6 +1801,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1753,6 +1837,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1777,7 +1862,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1788,7 +1873,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1798,6 +1883,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1818,6 +1906,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1844,7 +1933,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1855,7 +1944,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1870,6 +1959,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/TOC.yml b/2019-03-01-hybrid/docs-ref-autogen/TOC.yml index b23d8f34da..22e5bc5176 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/TOC.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/TOC.yml @@ -580,6 +580,14 @@ uid: az_scvmm_vm_disk displayName: az scvmm vm disk items: [] + - name: extension + uid: az_scvmm_vm_extension + displayName: az scvmm vm extension + items: [] + - name: guest-agent + uid: az_scvmm_vm_guest-agent + displayName: az scvmm vm guest-agent + items: [] - name: nic uid: az_scvmm_vm_nic displayName: az scvmm vm nic @@ -3825,6 +3833,10 @@ uid: az_aks_egress-endpoints displayName: az aks egress-endpoints items: [] + - name: machine + uid: az_aks_machine + displayName: az aks machine + items: [] - name: maintenanceconfiguration uid: az_aks_maintenanceconfiguration displayName: az aks maintenanceconfiguration @@ -7158,10 +7170,6 @@ uid: az_stack-hci_extension displayName: az stack-hci extension items: [] - - name: Stack HCI VM - uid: sp-Stack_HCI_VM - displayName: Stack HCI VM - items: [] - name: Storage items: - name: Summary diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/lock.yml b/2019-03-01-hybrid/docs-ref-autogen/account/lock.yml index 8868f4e99e..65cc8fbba7 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/lock.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/lock.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure subscription level locks. diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/management-group.yml b/2019-03-01-hybrid/docs-ref-autogen/account/management-group.yml index 4581a2922b..697a9365b8 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/management-group.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/management-group.yml @@ -257,5 +257,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure Management Groups. diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml index 216e0bf65c..4e4e45263a 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/entities.yml @@ -47,5 +47,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Entity operations (Management Group and Subscriptions) for Management Groups. diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml index 1765ca90da..8273695000 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml @@ -177,5 +177,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy. diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml index 572dfc76f3..523464ad76 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml @@ -130,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Subscription operations for Management Groups. diff --git a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml index 037d92a58d..8d240dd236 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml @@ -62,5 +62,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Backfill Tenant Subscription Operations for Management Groups. diff --git a/2019-03-01-hybrid/docs-ref-autogen/aks.yml b/2019-03-01-hybrid/docs-ref-autogen/aks.yml index 6a1c17ad6e..b4342d6872 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/aks.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/aks.yml @@ -148,6 +148,7 @@ directCommands: [--http-proxy-config] [--image-cleaner-interval-hours] [--ip-families] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -206,7 +207,7 @@ directCommands: [--snapshot-id] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--vm-set-type] [--vnet-subnet-id] [--windows-admin-password] @@ -683,6 +684,10 @@ directCommands: A comma separated list of IP versions to use for cluster networking. description: |- Each IP version should be in the format IPvN. For example, IPv4. + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -932,7 +937,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA. - name: --vm-set-type @@ -1664,6 +1669,7 @@ directCommands: [--guardrails-version] [--http-proxy-config] [--image-cleaner-interval-hours] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -1691,7 +1697,7 @@ directCommands: [--rotation-poll-interval] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--update-cluster-autoscaler] [--upgrade-override-until] [--windows-admin-password] @@ -2138,6 +2144,10 @@ directCommands: summary: |- ImageCleaner scanning interval. isPreview: true + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -2256,7 +2266,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' changes a standard managed cluster to a free one. - name: --update-cluster-autoscaler -u @@ -2488,6 +2498,9 @@ commands: - az_aks_kanalyze(aks-preview) - az_aks_kollect(aks-preview) - az_aks_list(aks-preview) +- az_aks_machine +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) - az_aks_maintenanceconfiguration - az_aks_maintenanceconfiguration_add(aks-preview) - az_aks_maintenanceconfiguration_delete(aks-preview) diff --git a/2019-03-01-hybrid/docs-ref-autogen/aks/machine.yml b/2019-03-01-hybrid/docs-ref-autogen/aks/machine.yml new file mode 100644 index 0000000000..0562e9ba0f --- /dev/null +++ b/2019-03-01-hybrid/docs-ref-autogen/aks/machine.yml @@ -0,0 +1,92 @@ +### YamlMime:AzureCLIGroup +uid: az_aks_machine +name: az aks machine +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **aks-preview** extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an **az aks machine** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Get information about machines in a nodepool of a managed clusters. +status: GA +sourceType: Extension +directCommands: +- uid: az_aks_machine_list(aks-preview) + name: az aks machine list + summary: |- + Get information about IP Addresses, Hostname for all machines in an agentpool. + status: GA + sourceType: Extension + syntax: >- + az aks machine list --cluster-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_aks_machine_show(aks-preview) + name: az aks machine show + summary: |- + Show IP Addresses, Hostname for a specific machine in an agentpool for a managedcluster. + status: GA + sourceType: Extension + syntax: >- + az aks machine show --cluster-name + --machine-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --machine-name + summary: |- + Get IP Addresses, Hostname for a specific machine in an agentpool. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +commands: +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Get information about machines in a nodepool of a managed clusters. diff --git a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml index c65eca91b8..62f0fe7ed2 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection.yml @@ -12,6 +12,7 @@ directCommands: Delete a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection delete [--connection] [--id] @@ -38,14 +39,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -56,6 +57,7 @@ directCommands: List connections of a containerapp. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list [--name] [--resource-group] @@ -73,10 +75,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -86,6 +88,7 @@ directCommands: List source configurations of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list-configuration [--connection] [--id] @@ -110,16 +113,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_list-support-types() name: az containerapp connection list-support-types summary: |- List client types and auth types supported by containerapp connections. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: az containerapp connection list-support-types [--target-type {appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}] examples: - summary: |- @@ -139,6 +143,7 @@ directCommands: Get the details of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection show [--connection] [--id] @@ -163,16 +168,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_validate() name: az containerapp connection validate summary: |- Validate a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection validate [--connection] [--id] @@ -197,16 +203,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_wait() name: az containerapp connection wait summary: |- Place the CLI in a waiting state until a condition of the connection is met. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection wait [--connection] [--created] @@ -251,10 +258,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- @@ -344,4 +351,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Commands to manage containerapp connections. diff --git a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml index b07b1e4f10..28f82f023d 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml @@ -12,6 +12,7 @@ directCommands: Create a containerapp connection to appconfig. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create appconfig [--app-config] [--client-type {dotnet, java, nodejs, none, python}] @@ -59,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -116,6 +117,7 @@ directCommands: Create a containerapp connection to confluent-cloud. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create confluent-cloud --bootstrap-server --kafka-key @@ -177,14 +179,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -197,6 +199,7 @@ directCommands: Create a containerapp connection to cosmos-cassandra. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-cassandra [--account] [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] @@ -249,7 +252,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -260,7 +263,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,6 +313,7 @@ directCommands: Create a containerapp connection to cosmos-gremlin. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-gremlin [--account] [--client-type {dotnet, java, nodejs, none, php, python}] @@ -366,7 +370,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -377,7 +381,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -427,6 +431,7 @@ directCommands: Create a containerapp connection to cosmos-mongo. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-mongo [--account] [--client-type {dotnet, go, java, nodejs, none, springBoot}] @@ -479,7 +484,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -490,7 +495,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -540,6 +545,7 @@ directCommands: Create a containerapp connection to cosmos-sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-sql [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -592,7 +598,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -603,7 +609,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -653,6 +659,7 @@ directCommands: Create a containerapp connection to cosmos-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-table [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -702,7 +709,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -713,7 +720,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -766,6 +773,7 @@ directCommands: Create a containerapp connection to eventhub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -811,7 +819,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -825,7 +833,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -875,6 +883,7 @@ directCommands: Create a containerapp connection to keyvault. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -926,7 +935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -942,7 +951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -992,6 +1001,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1038,7 +1048,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1049,7 +1059,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1087,6 +1097,7 @@ directCommands: Create a containerapp connection to mysql-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1132,14 +1143,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1182,6 +1193,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1236,7 +1248,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1252,7 +1264,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1295,6 +1307,7 @@ directCommands: Create a containerapp connection to postgres-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1340,14 +1353,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1386,6 +1399,7 @@ directCommands: Create a containerapp connection to redis. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1431,7 +1445,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1442,7 +1456,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1469,6 +1483,7 @@ directCommands: Create a containerapp connection to redis-enterprise. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1513,14 +1528,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1562,7 @@ directCommands: Create a containerapp connection to servicebus. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1592,7 +1608,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1606,7 +1622,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1656,6 +1672,7 @@ directCommands: Create a containerapp connection to signalr. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create signalr [--client-type {dotnet, none}] [--connection] @@ -1700,7 +1717,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1711,7 +1728,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1777,7 @@ directCommands: Create a containerapp connection to sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1807,7 +1825,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1818,7 +1836,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1861,6 +1879,7 @@ directCommands: Create a containerapp connection to storage-blob. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-blob [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -1916,7 +1935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1932,7 +1951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1982,6 +2001,7 @@ directCommands: Create a containerapp connection to storage-file. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-file [--account] [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] @@ -2027,7 +2047,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2038,7 +2058,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2066,6 +2086,7 @@ directCommands: Create a containerapp connection to storage-queue. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-queue [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -2114,7 +2135,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2125,7 +2146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2175,6 +2196,7 @@ directCommands: Create a containerapp connection to storage-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-table [--account] [--client-type {dotnet, java, nodejs, none, python}] @@ -2220,7 +2242,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2231,7 +2253,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2259,6 +2281,7 @@ directCommands: Create a containerapp connection to webpubsub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -2303,7 +2326,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2314,7 +2337,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2406,4 +2429,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Create a connection between a containerapp and a target resource. diff --git a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml index 374cae2ad2..11afda4188 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml @@ -12,6 +12,7 @@ directCommands: Update a containerapp to appconfig connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update appconfig [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -53,7 +54,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -64,7 +65,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -101,6 +102,7 @@ directCommands: Update a containerapp to confluent-cloud connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update confluent-cloud --connection [--bootstrap-server] @@ -153,14 +155,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -182,6 +184,7 @@ directCommands: Update a containerapp to cosmos-cassandra connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-cassandra [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -224,7 +227,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -235,7 +238,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -276,6 +279,7 @@ directCommands: Update a containerapp to cosmos-gremlin connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-gremlin [--client-type {dotnet, java, nodejs, none, php, python}] [--connection] @@ -318,7 +322,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -329,7 +333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -370,6 +374,7 @@ directCommands: Update a containerapp to cosmos-mongo connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-mongo [--client-type {dotnet, go, java, nodejs, none, springBoot}] [--connection] @@ -412,7 +417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -423,7 +428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -464,6 +469,7 @@ directCommands: Update a containerapp to cosmos-sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-sql [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -506,7 +512,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -517,7 +523,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -558,6 +564,7 @@ directCommands: Update a containerapp to cosmos-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-table [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -600,7 +607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -611,7 +618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,6 +659,7 @@ directCommands: Update a containerapp to eventhub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -694,7 +702,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -705,7 +713,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -746,6 +754,7 @@ directCommands: Update a containerapp to keyvault connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -787,7 +796,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -798,7 +807,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,6 +845,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -875,7 +885,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -886,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -912,6 +922,7 @@ directCommands: Update a containerapp to mysql-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -950,14 +961,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -988,6 +999,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1028,7 +1040,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1039,7 +1051,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1070,6 +1082,7 @@ directCommands: Update a containerapp to postgres-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1108,14 +1121,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,6 +1155,7 @@ directCommands: Update a containerapp to redis connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1180,7 +1194,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1191,7 +1205,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1206,6 +1220,7 @@ directCommands: Update a containerapp to redis-enterprise connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1243,14 +1258,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1265,6 +1280,7 @@ directCommands: Update a containerapp to servicebus connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1307,7 +1323,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1318,7 +1334,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1359,6 +1375,7 @@ directCommands: Update a containerapp to signalr connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update signalr [--client-type {dotnet, none}] [--connection] @@ -1400,7 +1417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1411,7 +1428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1448,6 +1465,7 @@ directCommands: Update a containerapp to sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1488,7 +1506,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1499,7 +1517,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1530,6 +1548,7 @@ directCommands: Update a containerapp to storage-blob connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-blob [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1572,7 +1591,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1583,7 +1602,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1624,6 +1643,7 @@ directCommands: Update a containerapp to storage-file connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-file [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1663,7 +1683,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1674,7 +1694,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1693,6 +1713,7 @@ directCommands: Update a containerapp to storage-queue connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-queue [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1735,7 +1756,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1746,7 +1767,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1787,6 +1808,7 @@ directCommands: Update a containerapp to storage-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-table [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1826,7 +1848,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1837,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1856,6 +1878,7 @@ directCommands: Update a containerapp to webpubsub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1897,7 +1920,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1908,7 +1931,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1988,4 +2011,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Update a containerapp connection. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment.yml index 7d9786a60a..73357083ed 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment.yml @@ -356,5 +356,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment/group.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment/group.yml index a896fda216..a5b8c76962 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment/group.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment/group.yml @@ -77,8 +77,8 @@ directCommands: Create a deployment at resource group scope from a template-spec syntax: az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0" - summary: |- - Create a deployment at resource group scope from a bicep template and a bicepparam parameter file - syntax: az deployment group create --resource-group testrg --template-file azuredeploy.bicep --parameters parameters.bicepparam + Create a deployment at resource group scope from a bicepparam parameter file + syntax: az deployment group create --resource-group testrg --parameters parameters.bicepparam - summary: |- Create a deployment at resource group across tenants syntax: >- @@ -124,7 +124,7 @@ directCommands: summary: |- Supply deployment parameter values. description: |- - 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. Also note if you are providing a bicepparam file with a bicep template then you can use this argument only once. + 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. Also note if you are providing a bicepparam file then you can use this argument only once. - name: --query-string -q summary: |- The query string (a SAS token) to be used with the template-uri in the case of linked templates. @@ -396,5 +396,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at resource group. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation.yml index 40b0f125fb..b2ab425431 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation.yml @@ -80,5 +80,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml index c950e10e53..f2ba339664 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/group.yml @@ -81,5 +81,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at resource group. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml index eedad853e1..5060c4afd8 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2019-03-01-hybrid/docs-ref-autogen/deployment/sub.yml b/2019-03-01-hybrid/docs-ref-autogen/deployment/sub.yml index 0bac771567..05eeb90fe3 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/deployment/sub.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/deployment/sub.yml @@ -313,5 +313,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2019-03-01-hybrid/docs-ref-autogen/dt/model.yml b/2019-03-01-hybrid/docs-ref-autogen/dt/model.yml index a96d5da72b..583a66b870 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/dt/model.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/dt/model.yml @@ -132,7 +132,7 @@ directCommands: List model definitions syntax: az dt model list -n {instance_or_hostname} --definition - summary: |- - List dependencies of particular pre-existing model(s). Space seperate dtmi values. + List dependencies of particular pre-existing model(s). Space separate dtmi values. syntax: az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1} requiredParameters: - isRequired: true diff --git a/2019-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml index 3d46f29499..c1e786c25d 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml @@ -117,7 +117,7 @@ directCommands: Description for the private endpoint connection. - name: --group-ids summary: |- - Space seperated list of group ids that the private endpoint should connect to. + Space separated list of group ids that the private endpoint should connect to. - name: --no-wait defaultValue: "False" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml index 5aa7711ce5..67a0d992a8 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection.yml @@ -43,14 +43,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -79,10 +79,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -117,10 +117,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_list-support-types() name: az functionapp connection list-support-types summary: |- @@ -172,10 +172,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_validate() name: az functionapp connection validate summary: |- @@ -207,10 +207,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_wait() name: az functionapp connection wait summary: |- @@ -262,10 +262,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml index e92790c539..3767dae0bc 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml @@ -60,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -71,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -175,14 +175,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -244,7 +244,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -255,7 +255,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +358,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -369,7 +369,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -468,7 +468,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -479,7 +479,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -578,7 +578,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -589,7 +589,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -685,7 +685,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -696,7 +696,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -791,7 +791,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -805,7 +805,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -903,7 +903,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -919,7 +919,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1012,7 +1012,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1023,7 +1023,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1103,14 +1103,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1194,14 +1194,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1299,7 +1299,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1315,7 +1315,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1410,7 +1410,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1426,7 +1426,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1515,14 +1515,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1604,14 +1604,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1696,7 +1696,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1707,7 +1707,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1775,14 +1775,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1851,7 +1851,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1865,7 +1865,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +1956,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1967,7 +1967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2060,7 +2060,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2071,7 +2071,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2159,7 +2159,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2170,7 +2170,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2269,7 +2269,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2285,7 +2285,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2377,7 +2377,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2388,7 +2388,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2461,7 +2461,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2472,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2564,7 +2564,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2575,7 +2575,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2644,7 +2644,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2655,7 +2655,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml index 38d4dd2445..5f86ae02ef 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml @@ -50,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -61,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -151,14 +151,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -219,7 +219,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -230,7 +230,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,7 +310,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -321,7 +321,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -401,7 +401,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -412,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -492,7 +492,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -503,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -583,7 +583,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -594,7 +594,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -674,7 +674,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -685,7 +685,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -764,7 +764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -775,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -849,7 +849,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -860,7 +860,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -921,14 +921,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -996,7 +996,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1007,7 +1007,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1073,14 +1073,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,7 +1142,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1153,7 +1153,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1202,14 +1202,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1263,7 +1263,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1274,7 +1274,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1353,7 +1353,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1364,7 +1364,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1438,7 +1438,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1449,7 +1449,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1519,7 +1519,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1530,7 +1530,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,7 +1607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1618,7 +1618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1676,7 +1676,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1687,7 +1687,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1764,7 +1764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1775,7 +1775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1832,7 +1832,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1843,7 +1843,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/group.yml b/2019-03-01-hybrid/docs-ref-autogen/group.yml index 846b577ecc..b450511a56 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/group.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/group.yml @@ -296,5 +296,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource groups and template deployments. diff --git a/2019-03-01-hybrid/docs-ref-autogen/group/deployment.yml b/2019-03-01-hybrid/docs-ref-autogen/group/deployment.yml index bdb6506b2b..845f03e2c5 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/group/deployment.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/group/deployment.yml @@ -376,5 +376,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager deployments. diff --git a/2019-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml b/2019-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml index 3a10ee2996..1a816fc7b6 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/group/deployment/operation.yml @@ -88,5 +88,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations. diff --git a/2019-03-01-hybrid/docs-ref-autogen/group/lock.yml b/2019-03-01-hybrid/docs-ref-autogen/group/lock.yml index 6190f384ce..9862bfbf29 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/group/lock.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/group/lock.yml @@ -178,5 +178,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource group locks. diff --git a/2019-03-01-hybrid/docs-ref-autogen/iot/du/account.yml b/2019-03-01-hybrid/docs-ref-autogen/iot/du/account.yml index bb80295b1a..60982b150f 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/iot/du/account.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/iot/du/account.yml @@ -43,7 +43,7 @@ directCommands: Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor. syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount - summary: |- - Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-seperated) with a custom specified role. + Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role. syntax: >- az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1 /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2 diff --git a/2019-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml b/2019-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml index 9c24473ee3..ffe8446d6a 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml @@ -114,7 +114,7 @@ directCommands: [--resource-group] examples: - summary: |- - Remove a space-seperated list of child devices from a target parent device. + Remove a space-separated list of child devices from a target parent device. syntax: az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name} - summary: |- Remove all child devices from a target parent device. diff --git a/2019-03-01-hybrid/docs-ref-autogen/lock.yml b/2019-03-01-hybrid/docs-ref-autogen/lock.yml index eda6357072..16bc620028 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/lock.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/lock.yml @@ -284,5 +284,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure locks. diff --git a/2019-03-01-hybrid/docs-ref-autogen/managedapp.yml b/2019-03-01-hybrid/docs-ref-autogen/managedapp.yml index eda87aefc3..796ed5b7a6 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/managedapp.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/managedapp.yml @@ -187,5 +187,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage template solutions provided and maintained by Independent Software Vendors (ISVs). diff --git a/2019-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml b/2019-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml index 4bf603ef13..bff48d2565 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/managedapp/definition.yml @@ -272,5 +272,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Managed Applications. diff --git a/2019-03-01-hybrid/docs-ref-autogen/policy.yml b/2019-03-01-hybrid/docs-ref-autogen/policy.yml index 0c984b3d74..b8ac9b4150 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/policy.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/policy.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policies. diff --git a/2019-03-01-hybrid/docs-ref-autogen/policy/assignment.yml b/2019-03-01-hybrid/docs-ref-autogen/policy/assignment.yml index 751eee6c86..9c8344043e 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/policy/assignment.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/policy/assignment.yml @@ -224,5 +224,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy assignments. diff --git a/2019-03-01-hybrid/docs-ref-autogen/policy/definition.yml b/2019-03-01-hybrid/docs-ref-autogen/policy/definition.yml index e0eb4690e8..72abf35404 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/policy/definition.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/policy/definition.yml @@ -232,5 +232,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy definitions. diff --git a/2019-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml b/2019-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml index 9ab9816d44..52b1b32df5 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -21,22 +21,20 @@ directCommands: previewOrExperimentalInfo: "Command group 'postgres server-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az postgres server-arc endpoint list --name - [--k8s-namespace] + az postgres server-arc endpoint list [--k8s-namespace] + [--name] [--use-k8s] examples: - summary: |- List Azure Arc enabled PostgreSQL server endpoints. syntax: az postgres server-arc endpoint list --name postgres01 --k8s-namespace namespace --use-k8s - requiredParameters: - - isRequired: true - name: --name -n - summary: |- - Name of the Azure Arc enabled PostgreSQL server. optionalParameters: - name: --k8s-namespace -k summary: |- The Kubernetes namespace where the Azure Arc enabled PostgreSQL server is deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used. + - name: --name -n + summary: |- + Name of the Azure Arc enabled PostgreSQL server. - name: --use-k8s summary: |- Use local Kubernetes APIs to perform this action. diff --git a/2019-03-01-hybrid/docs-ref-autogen/provider.yml b/2019-03-01-hybrid/docs-ref-autogen/provider.yml index 5898a00528..cd5a602cb6 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/provider.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/provider.yml @@ -139,5 +139,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource providers. diff --git a/2019-03-01-hybrid/docs-ref-autogen/provider/operation.yml b/2019-03-01-hybrid/docs-ref-autogen/provider/operation.yml index 518ec011a4..6544ce6305 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/provider/operation.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/provider/operation.yml @@ -59,5 +59,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get provider operations metadatas. diff --git a/2019-03-01-hybrid/docs-ref-autogen/provider/permission.yml b/2019-03-01-hybrid/docs-ref-autogen/provider/permission.yml index 95846fb713..b5f93b9261 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/provider/permission.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/provider/permission.yml @@ -46,5 +46,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage permissions for a provider. diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource-mover.yml b/2019-03-01-hybrid/docs-ref-autogen/resource-mover.yml index 3c5aa44f8e..1d9ccf7ffc 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource-mover.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource-mover.yml @@ -4,12 +4,10 @@ name: az resource-mover extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage Resource Mover Service API. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Extension commands: - az_resource-mover_move-collection diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml b/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml index 6b7c846932..dc729bc40b 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml @@ -4,31 +4,29 @@ name: az resource-mover move-collection extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-collection. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-collection_bulk-remove(resource-mover) name: az resource-mover move-collection bulk-remove summary: |- - Remove the set of move-resources from move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection bulk-remove [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] [--move-resources] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Remove a move-resource in a move-collection. @@ -40,53 +38,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - Name of the move-collection. + The Move Collection Name. - name: --move-resources summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_commit(resource-mover) name: az resource-mover move-collection commit summary: |- - Commit the set of resources. The commit operation is triggered on the move-resources in the move-state 'CommitPending' or 'CommitFailed', on a successful completion the move-resource's move-state do a transition to Committed. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection commit --move-resources - [--ids] + az resource-mover move-collection commit [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Commit a move-resource. + Commit a move-resource in the move-collection (RegionToRegion) syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Commit resources in the move-collection (RegionToZone) + syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -94,87 +90,100 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_create(resource-mover) name: az resource-mover move-collection create summary: |- - Create a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a move collection. + description: |- + Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- az resource-mover move-collection create --move-collection-name --resource-group [--identity] [--location] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] [--source-region] [--tags] [--target-region] + [--version] examples: - summary: |- - Create a move-collection with system assigned identity. + Create a move-collection with system assigned identity. (RegionToRegion) syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Create a zonal type move-collection with system assigned identity. (RegionToZone) + syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone requiredParameters: - isRequired: true name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + The geo-location where the resource lives. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. - name: --source-region summary: |- - The source region. + Gets or sets the source region. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --target-region summary: |- - The target region. + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_delete(resource-mover) name: az resource-mover move-collection delete summary: |- - Delete a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a move collection. + description: |- + The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection delete [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -188,14 +197,14 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -206,29 +215,24 @@ directCommands: - uid: az_resource-mover_move-collection_discard(resource-mover) name: az resource-mover move-collection discard summary: |- - Discard the set of resources. The discard operation is triggered on the move-resources in the move-state 'CommitPending' or 'DiscardFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection discard --move-resources - [--ids] + az resource-mover move-collection discard [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Discard a remove-resource. syntax: az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -236,50 +240,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_initiate-move(resource-mover) name: az resource-mover move-collection initiate-move summary: |- - Move the set of resources. The move operation is triggered after the move-resources are in the move-state 'MovePending' or 'MoveFailed', on a successful completion the move-resource's move-state do a transition to CommitPending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection initiate-move --move-resources - [--ids] + az resource-mover move-collection initiate-move [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Move the set of resources. + Move the set of resources. (RegionToRegion) syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Move VMs into zonal configuration within the same region (RegionToZone) + syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -287,33 +292,39 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_list(resource-mover) name: az resource-mover move-collection list summary: |- - List details of the move-collections. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List all the Move Collections in the subscription. + description: |- + The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension - syntax: az resource-mover move-collection list [--resource-group] + syntax: >- + az resource-mover move-collection list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all move-collections. @@ -322,94 +333,114 @@ directCommands: List all move-collections by resource group. syntax: az resource-mover move-collection list -g MyResourceGroup optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - uid: az_resource-mover_move-collection_list-required-for(resource-mover) name: az resource-mover move-collection list-required-for summary: |- - List the move-resources for which an arm resource is required for. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List of the move resources for which an arm resource is required for. + description: |- + The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection list-required-for --move-collection-name - --resource-group - --source-id - examples: - - summary: |- - List the move-resources for which an arm resource is required for. - syntax: az resource-mover move-collection list-required-for --name MyMoveCollection --resource-group MyResourceGroup --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/nic1" + az resource-mover move-collection list-required-for --source-id + [--ids] + [--move-collection-name] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true - name: --move-collection-name --name -n + name: --source-id + summary: |- + The sourceId for which the api is invoked. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name --name -n summary: |- The Move Collection Name. - - isRequired: true - name: --resource-group -g + - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --source-id + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --subscription summary: |- - The sourceId for which the api is invoked. + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_list-unresolved-dependency(resource-mover) name: az resource-mover move-collection list-unresolved-dependency summary: |- - List the details of the unresolved dependencies in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Lists a list of unresolved dependencies. + description: |- + The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection list-unresolved-dependency --move-collection-name --resource-group [--dependency-level {Descendant, Direct}] + [--filter] + [--max-items] + [--next-token] + [--orderby] examples: - summary: |- List the unresolved dependencies. syntax: az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --dependency-level parameterValueGroup: "Descendant, Direct" summary: |- - The dependency level. + Defines the dependency level. + - name: --filter + summary: |- + The filter to apply on the operation. For example, $apply=filter(count eq 2). + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. + - name: --orderby + summary: |- + OData order by query option. For example, you can use $orderby=Count desc. - uid: az_resource-mover_move-collection_prepare(resource-mover) name: az resource-mover move-collection prepare summary: |- - Prepare the set of resources. The prepare operation is on the move-resources that are in the move-state 'PreparePending' or 'PrepareFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection prepare --move-resources - [--ids] + az resource-mover move-collection prepare [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Prepare a move-resource. syntax: az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -417,66 +448,72 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_resolve-dependency(resource-mover) name: az resource-mover move-collection resolve-dependency summary: |- - Compute, resolve and validate the dependencies of the move-resources in the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Computes, resolves and validate the dependencies of the moveResources in the move collection. + description: |- + Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection resolve-dependency [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] examples: - summary: |- - Resolve the dependency of the move-resources. + Resolve the dependency of the move-resources. (RegionToRegion) syntax: az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Resolve the dependency of the move-resources. (RegionToZone) + syntax: az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_show(resource-mover) name: az resource-mover move-collection show summary: |- - Get the details of a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the move collection. + description: |- + The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection show [--ids] @@ -493,64 +530,94 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_update(resource-mover) name: az resource-mover move-collection update summary: |- - Update a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Update a move collection. + description: |- + Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection update [--identity] + az resource-mover move-collection update [--add] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--identity] [--ids] [--move-collection-name] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] + [--remove] [--resource-group] + [--set] + [--source-region] [--subscription] [--tags] + [--target-region] + [--version] examples: - summary: |- Update a move-collection. syntax: az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup optionalParameters: + - name: --add + summary: |- + Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --force-string + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. + - name: --remove + summary: |- + Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --set + summary: |- + Update an object by specifying a property path and value to set. Example: --set property1.property2=. + - name: --source-region + summary: |- + Gets or sets the source region. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --target-region + summary: |- + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_wait(resource-mover) name: az resource-mover move-collection wait summary: |- - Place the CLI in a waiting state until a condition of the move-collection is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection wait [--created] @@ -564,13 +631,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully deleted. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --deleted - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully created. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --created optionalParameters: - name: --created defaultValue: "False" @@ -596,10 +656,10 @@ directCommands: Polling interval in seconds. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml b/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml index 3f887cf77d..a1af1c1331 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml @@ -4,118 +4,86 @@ name: az resource-mover move-resource extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-resource. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-resource_add(resource-mover) name: az resource-mover move-resource add summary: |- - Create or update a move-resource to the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a Move Resource in the move collection. + description: |- + The 'az resource-mover move-resource add' command remains same for both 'RegionToRegion' (default) and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-resource add --move-collection-name - --move-resource-name - --resource-group - [--depends-on-overrides] + az resource-mover move-resource add [--depends-on-overrides] [--existing-target-id] - [--no-wait] + [--ids] + [--move-collection-name] + [--move-resource-name] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] + [--resource-group] [--resource-settings] [--source-id] + [--subscription] examples: - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings '{ - "resourceType": "Microsoft.Network/virtualNetworks", - "targetResourceName": "MyVNet-target" - }' + Add a vNet as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet\" --resource-settings '{ \"resourceType\": \"Microsoft.Network/virtualNetworks\", \"targetResourceName\": \"MyVNet-target\" }'" - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings @resource-settings.json + Add a VM as a move-resource to the move-collection. (RegionToZone) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyZonalMoveCollection --name MyVMMoveResource --source-id \"/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetResourceName\": \"MyVM\", \"targetAvailabilityZone\": \"2\", \"targetVmSize\": \"Standard_B2s\" }'" - summary: |- - Add a VM as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM" - - --depends-on-overrides id="/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" target-id="/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" - - --resource-settings '{ - "resourceType": "Microsoft.Compute/virtualMachines", - "targetAvailabilitySetId": "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet", - "targetAvailabilityZone": "2", - "targetResourceName": "MyVM-target", - "targetVmSize": null, - "userManagedIdentities": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] - }' - requiredParameters: - - isRequired: true - name: --move-collection-name - summary: |- - The move-collection name. - - isRequired: true - name: --move-resource-name --name -n - summary: |- - The move-resource name. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Add a VM as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM\" --depends-on-overrides id=\"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" target-id=\"/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetAvailabilitySetId\": \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet\", \"targetAvailabilityZone\": \"2\", \"targetResourceName\": \"MyVM-target\", \"targetVmSize\": null, \"userManagedIdentities\": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] }'" optionalParameters: - name: --depends-on-overrides summary: |- - The move-resource dependencies overrides. - description: |- - Usage: --depends-on-overrides id=XX target-id=XX - - id: The ARM ID of the dependent resource. - target-id: The resource ARM ID of either the move-resource or the resource ARM ID of the dependent resource. - - Multiple actions can be specified by using more than one --depends-on-overrides argument. + Gets or sets the move resource dependencies overrides. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --existing-target-id summary: |- - The existing target ARM Id of the resource. + Gets or sets the existing target ARM Id of the resource. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name + summary: |- + The Move Collection Name. + - name: --move-resource-name --name -n + summary: |- + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --resource-settings summary: |- - The resource settings. Expected value: json-string/@json-file. + The resource settings. Expected value: json-string/@json-file. Support json-file and yaml-file. - name: --source-id summary: |- - The Source ARM Id of the resource. + Gets or sets the Source ARM Id of the resource. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_delete(resource-mover) name: az resource-mover move-resource delete summary: |- - Delete a move-resource from the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a Move Resource from the move collection. + description: |- + The 'az resource-mover move-resource delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource delete [--ids] [--move-collection-name] [--move-resource-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -129,17 +97,17 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -150,34 +118,47 @@ directCommands: - uid: az_resource-mover_move-resource_list(resource-mover) name: az resource-mover move-resource list summary: |- - List the move-resources in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List the Move Resources in the move collection. + description: |- + The 'az resource-mover move-resource list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource list --move-collection-name --resource-group + [--filter] + [--max-items] + [--next-token] examples: - summary: |- List the move-resources in a move-collection. syntax: az resource-mover move-resource list --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + optionalParameters: + - name: --filter + summary: |- + The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_resource-mover_move-resource_show(resource-mover) name: az resource-mover move-resource show summary: |- - Get the details of a move-resource. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the Move Resource. + description: |- + The 'az resource-mover move-resource show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource show [--ids] @@ -195,23 +176,21 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_wait(resource-mover) name: az resource-mover move-resource wait summary: |- - Place the CLI in a waiting state until a condition of the move-resource is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource wait [--created] @@ -226,13 +205,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully created. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --created - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully deleted. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --deleted optionalParameters: - name: --created defaultValue: "False" @@ -258,13 +230,13 @@ directCommands: Polling interval in seconds. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource.yml b/2019-03-01-hybrid/docs-ref-autogen/resource.yml index 135aabce03..6b769beb7f 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource.yml @@ -732,5 +732,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resources. diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource/link.yml b/2019-03-01-hybrid/docs-ref-autogen/resource/link.yml index f2b488a62a..6be731ae36 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource/link.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource/link.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Linking is a feature of the Resource Manager. It enables declaring relationships between resources even if they do not reside in the same resource group. Linking has no impact on resource usage, billing, or role-based access. It allows for managing multiple resources across groups as a single unit. diff --git a/2019-03-01-hybrid/docs-ref-autogen/resource/lock.yml b/2019-03-01-hybrid/docs-ref-autogen/resource/lock.yml index 55f2453025..b542c25008 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/resource/lock.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/resource/lock.yml @@ -267,5 +267,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource level locks. diff --git a/2019-03-01-hybrid/docs-ref-autogen/scvmm.yml b/2019-03-01-hybrid/docs-ref-autogen/scvmm.yml index c68bc47dce..d32b42e906 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/scvmm.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/scvmm.yml @@ -52,6 +52,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml index 56f846f67d..452bb2d8c2 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm.yml @@ -22,7 +22,6 @@ directCommands: sourceType: Extension syntax: >- az scvmm vm create --custom-location - --location --name --resource-group [--admin-password] @@ -34,6 +33,7 @@ directCommands: [--dynamic-memory-max] [--dynamic-memory-min] [--inventory-item] + [--location] [--memory-size] [--nic] [--no-wait] @@ -55,10 +55,6 @@ directCommands: name: --custom-location summary: |- Name or ID of the custom location that will manage this resource. - - isRequired: true - name: --location -l - summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - isRequired: true name: --name -n summary: |- @@ -96,6 +92,9 @@ directCommands: - name: --inventory-item -i summary: |- Name or ID of the inventory item. + - name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - name: --memory-size summary: |- Desired memory size in MBs for the vm. @@ -170,13 +169,13 @@ directCommands: previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az scvmm vm delete [--deleteFromHost] + az scvmm vm delete [--delete-from-host] + [--delete-machine] [--force] [--ids] [--name] [--no-wait] [--resource-group] - [--retain] [--subscription] [--yes] examples: @@ -196,12 +195,15 @@ directCommands: Delete the VM from SCVMM syntax: az scvmm vm delete --subscription contoso-sub --resource-group contoso-rg --name contoso-avset --deleteFromHost optionalParameters: - - name: --deleteFromHost + - name: --delete-from-host summary: |- - Delete the VM from the SCVMM. + Delete the VM from the VMware host. + - name: --delete-machine + summary: |- + Delete the parent Microsoft.HybridCompute Machine resource. - name: --force summary: |- - Force the resource to be deleted from azure. + Force delete the azure resource. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -215,9 +217,6 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --retain - summary: |- - Disable the VM from azure but retain the VM in VMM. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -270,8 +269,10 @@ directCommands: name: az scvmm vm list summary: |- Retrieve a list of VMs. - status: Preview + status: Preview and Deprecated + isDeprecated: true isPreview: true + deprecateInfo: This command has been deprecated and will be removed in a future release. Use 'scvmm vm show' instead. previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: az scvmm vm list [--resource-group] @@ -467,7 +468,6 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --skip-shutdown - defaultValue: "False" parameterValueGroup: "false, true" summary: |- Skip shutdown and power-off immediately. @@ -605,6 +605,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml new file mode 100644 index 0000000000..e868aabd26 --- /dev/null +++ b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml @@ -0,0 +1,304 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_extension +name: az scvmm vm extension +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Manage vm extension with scvmm. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_extension_create(scvmm) + name: az scvmm vm extension create + summary: |- + The operation to create the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension create --location + --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Create a VM Extension + syntax: az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +- uid: az_scvmm_vm_extension_delete(scvmm) + name: az scvmm vm extension delete + summary: |- + The operation to delete the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension delete [--ids] + [--name] + [--no-wait] + [--resource-group] + [--subscription] + [--vm-name] + [--yes] + examples: + - summary: |- + Delete a VM Extension + syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm where the extension should be deleted. + - name: --yes -y + defaultValue: "False" + summary: |- + Do not prompt for confirmation. +- uid: az_scvmm_vm_extension_list(scvmm) + name: az scvmm vm extension list + summary: |- + The operation to get all extensions of a non-Azure vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension list --resource-group + --vm-name + [--expand] + examples: + - summary: |- + Get all VM Extensions + syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm containing the extension. + optionalParameters: + - name: --expand + summary: |- + The expand expression to apply on the operation. +- uid: az_scvmm_vm_extension_show(scvmm) + name: az scvmm vm extension show + summary: |- + The operation to get the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension show [--ids] + [--name] + [--resource-group] + [--subscription] + [--vm-name] + examples: + - summary: |- + Get VM Extension + syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm containing the extension. +- uid: az_scvmm_vm_extension_update(scvmm) + name: az scvmm vm extension update + summary: |- + The operation to update the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension update --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Update a VM Extension + syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +commands: +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Manage vm extension with scvmm. diff --git a/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml new file mode 100644 index 0000000000..ff7c276ac9 --- /dev/null +++ b/2019-03-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml @@ -0,0 +1,111 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_guest-agent +name: az scvmm vm guest-agent +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Vm guest agent. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_guest-agent_enable(scvmm) + name: az scvmm vm guest-agent enable + summary: |- + Enable guest agent on the vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent enable --password + --resource-group + --username + --vm-name + [--https-proxy] + [--no-wait] + examples: + - summary: |- + Enable guest agent on the vm + syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass --resource-group contoso-rg --subscription contoso-sub --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --password + summary: |- + Username password credentials to use for connecting to the VM. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --username + summary: |- + Username to use for connecting to the vm. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. + optionalParameters: + - name: --https-proxy + summary: |- + HTTPS proxy server url for the VM. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. +- uid: az_scvmm_vm_guest-agent_show(scvmm) + name: az scvmm vm guest-agent show + summary: |- + Get details of a guest agent by guest agent name, resource-group and vm name. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent show --resource-group + --vm-name + examples: + - summary: |- + Get details of a guest agent + syntax: az scvmm vm guest-agent show --resource-group contoso-rg --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. +commands: +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Vm guest agent. diff --git a/2019-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml b/2019-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml deleted file mode 100644 index 4a4347faaa..0000000000 --- a/2019-03-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml +++ /dev/null @@ -1,6 +0,0 @@ -### YamlMime:AzureCLIGroup -uid: sp-Stack_HCI_VM -name: Stack HCI VM -commands: -- az_stack-hci-vm -metadata: {} diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml index 7a19d9b2dc..b8f3501d17 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml @@ -38,14 +38,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -55,10 +57,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -90,17 +92,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -132,23 +136,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_list-support-types() name: az spring-cloud connection list-support-types summary: |- @@ -198,23 +204,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_validate() name: az spring-cloud connection validate summary: |- @@ -243,23 +251,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_wait() name: az spring-cloud connection wait summary: |- @@ -289,7 +299,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. @@ -307,7 +317,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -321,10 +333,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml index 789af0ef1a..a36f6ca536 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml @@ -48,7 +48,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -65,7 +65,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -76,7 +78,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -84,7 +86,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -176,7 +178,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -190,17 +192,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -252,7 +256,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -266,7 +270,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -280,7 +286,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -288,7 +294,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -373,7 +379,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -390,7 +396,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -404,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -412,7 +420,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -496,7 +504,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -513,7 +521,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -524,7 +534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -532,7 +542,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -616,7 +626,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +643,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -644,7 +656,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,7 +664,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +748,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -750,7 +762,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -761,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -769,7 +783,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -852,7 +866,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -866,7 +880,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -880,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -888,7 +904,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -974,7 +990,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -988,7 +1004,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1004,10 +1022,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1088,7 +1106,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1105,7 +1123,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1116,7 +1136,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1134,7 +1154,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1189,7 +1209,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1206,14 +1226,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1231,7 +1253,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1298,7 +1320,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1315,7 +1337,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1331,7 +1355,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1349,7 +1373,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1409,7 +1433,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1426,14 +1450,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1451,7 +1477,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1507,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1524,7 +1550,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1535,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1546,7 +1574,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1596,7 +1624,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1613,14 +1641,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1631,7 +1661,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1685,7 +1715,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1699,7 +1729,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1713,7 +1745,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1721,7 +1753,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1800,7 +1832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1814,7 +1846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1825,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1833,7 +1867,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1911,7 +1945,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1928,7 +1962,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1939,7 +1975,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1957,7 +1993,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2030,7 +2066,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2044,7 +2080,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2060,7 +2098,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2068,7 +2106,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2148,7 +2186,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2162,7 +2200,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2173,7 +2213,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2181,7 +2221,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2242,7 +2282,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2256,7 +2296,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2267,7 +2309,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2275,7 +2317,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2355,7 +2397,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2369,7 +2411,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2380,7 +2424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2388,7 +2432,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2445,7 +2489,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2459,7 +2503,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2470,7 +2516,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2478,7 +2524,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml index 153e6b0b18..2dfdbef869 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml @@ -42,7 +42,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -56,7 +56,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -70,7 +72,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -78,7 +80,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -150,7 +152,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -164,7 +166,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -177,7 +181,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -189,7 +193,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -231,7 +235,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -245,7 +249,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -259,7 +265,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -267,7 +273,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -332,7 +338,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -346,7 +352,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -360,7 +368,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -368,7 +376,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -433,7 +441,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -447,7 +455,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -461,7 +471,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -469,7 +479,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -534,7 +544,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -548,7 +558,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -562,7 +574,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -570,7 +582,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -635,7 +647,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -649,7 +661,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -663,7 +677,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -671,7 +685,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +750,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -750,7 +764,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -764,7 +780,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -772,7 +788,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,7 +852,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -850,7 +866,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -864,10 +882,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -929,7 +947,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -943,7 +961,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -957,7 +977,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -972,7 +992,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1011,7 +1031,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1025,7 +1045,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1035,7 +1057,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1050,7 +1072,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1094,7 +1116,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1108,7 +1130,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1122,7 +1146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1137,7 +1161,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1181,7 +1205,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1195,7 +1219,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1205,7 +1231,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1220,7 +1246,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1260,7 +1286,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1274,7 +1300,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1288,7 +1316,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1296,7 +1324,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1330,7 +1358,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1344,7 +1372,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1354,7 +1384,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1362,7 +1392,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1401,7 +1431,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1415,7 +1445,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1429,7 +1461,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1437,7 +1469,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1501,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1515,7 +1547,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1529,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1537,7 +1571,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1596,7 +1630,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1610,7 +1644,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1624,7 +1660,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1639,7 +1675,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1687,7 +1723,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1701,7 +1737,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1715,7 +1753,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1723,7 +1761,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1785,7 +1823,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1799,7 +1837,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1813,7 +1853,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1821,7 +1861,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1864,7 +1904,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1878,7 +1918,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1892,7 +1934,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1900,7 +1942,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1962,7 +2004,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1976,7 +2018,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1990,7 +2034,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1998,7 +2042,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2040,7 +2084,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2054,7 +2098,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2068,7 +2114,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,7 +2122,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring.yml b/2019-03-01-hybrid/docs-ref-autogen/spring.yml index 485ae7f209..65749e42df 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring.yml @@ -301,6 +301,30 @@ directCommands: - summary: |- List all plans. syntax: az spring list-marketplace-plan -o table +- uid: az_spring_list-support-server-versions(spring) + name: az spring list-support-server-versions + summary: |- + (Standard and Basic Tier Only) List supported server versions. + status: Preview + isPreview: true + previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + sourceType: Extension + syntax: >- + az spring list-support-server-versions --resource-group + --service + examples: + - summary: |- + List supported server versions. + syntax: az spring list-support-server-versions -o table -s MyService -g MyResourceGroup + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. - uid: az_spring_show(spring) name: az spring show summary: |- @@ -566,6 +590,7 @@ commands: - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) - az_spring_config-server - az_spring_config-server_clear(spring) - az_spring_config-server_disable(spring) @@ -675,6 +700,7 @@ commands: - az_spring_gateway_update(spring) - az_spring_list(spring) - az_spring_list-marketplace-plan(spring) +- az_spring_list-support-server-versions(spring) - az_spring_service-registry - az_spring_service-registry_bind(spring) - az_spring_service-registry_create(spring) diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/app.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/app.yml index ab25b24e0f..1cd618bab9 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/app.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/app.yml @@ -415,6 +415,7 @@ directCommands: [--registry-password] [--registry-username] [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}] + [--server-version] [--source-path] [--startup-probe-config] [--target-module] @@ -426,6 +427,9 @@ directCommands: - summary: |- Deploy a pre-built jar to an app with jvm options and environment variables. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar + - summary: |- + Deploy a pre-built war to an app with server version, jvm options and environment variables (Standard and Basic Tiers Only). + syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar - summary: |- Deploy source code to a specific deployment of an app. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path @@ -460,7 +464,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -563,6 +567,9 @@ directCommands: parameterValueGroup: "Java_11, Java_17, Java_8, NetCore_31" summary: |- Runtime version of used language. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --source-path summary: |- Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided. diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml index dcc3191376..71c8bd02fb 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/app/deployment.yml @@ -58,6 +58,7 @@ directCommands: [--scale-rule-metadata] [--scale-rule-name] [--scale-rule-type] + [--server-version] [--skip-clone-settings] [--source-path] [--startup-probe-config] @@ -99,7 +100,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -223,6 +224,9 @@ directCommands: - name: --scale-rule-type --srt summary: |- The type of the scale rule. Default: http. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --skip-clone-settings defaultValue: "False" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml index 13f8eaec64..61a4e22133 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml @@ -28,6 +28,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -35,6 +36,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -80,6 +82,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -102,6 +107,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. @@ -238,6 +247,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -245,6 +255,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -290,6 +301,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -312,6 +326,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/certificate.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/certificate.yml index 5ed4bdbe1d..4c6a781f4d 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/certificate.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/certificate.yml @@ -20,6 +20,7 @@ directCommands: az spring certificate add --name --resource-group --service + [--enable-auto-sync {false, true}] [--only-public-cert {false, true}] [--public-certificate-file] [--vault-certificate-name] @@ -42,6 +43,11 @@ directCommands: summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. optionalParameters: + - name: --enable-auto-sync + defaultValue: "False" + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. - name: --only-public-cert defaultValue: "False" parameterValueGroup: "false, true" @@ -157,12 +163,49 @@ directCommands: name: --service -s summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. +- uid: az_spring_certificate_update(spring) + name: az spring certificate update + summary: |- + Update a certificate in Azure Spring Apps. + status: GA + sourceType: Extension + syntax: >- + az spring certificate update --name + --resource-group + --service + [--enable-auto-sync {false, true}] + examples: + - summary: |- + Enable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true + - summary: |- + Disable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false + requiredParameters: + - isRequired: true + name: --name -n + summary: |- + Name of certificate. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. + optionalParameters: + - name: --enable-auto-sync + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. commands: - az_spring_certificate_add(spring) - az_spring_certificate_list(spring) - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) globalParameters: - name: --debug summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/connection.yml index f6c6051669..176dcc3111 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/connection.yml @@ -34,14 +34,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -51,10 +53,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -84,17 +86,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -124,23 +128,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_list-support-types() name: az spring connection list-support-types summary: |- @@ -186,23 +192,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_validate() name: az spring connection validate summary: |- @@ -229,23 +237,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_wait() name: az spring connection wait summary: |- @@ -273,7 +283,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. @@ -291,7 +301,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -305,10 +317,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml index a8cb097cd1..29ca0fbf26 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/connection/create.yml @@ -44,7 +44,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -61,7 +61,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -72,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -80,7 +82,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -170,7 +172,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -184,17 +186,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -244,7 +248,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -258,7 +262,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -272,7 +278,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -280,7 +286,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -363,7 +369,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -380,7 +386,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -394,7 +402,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -402,7 +410,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -484,7 +492,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -501,7 +509,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -512,7 +522,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -520,7 +530,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -602,7 +612,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -619,7 +629,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -630,7 +642,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -638,7 +650,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -720,7 +732,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -734,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -745,7 +759,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -753,7 +767,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -834,7 +848,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -848,7 +862,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -862,7 +878,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -870,7 +886,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -954,7 +970,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -968,7 +984,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -984,10 +1002,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1068,7 +1086,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1085,7 +1103,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1096,7 +1116,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1114,7 +1134,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1167,7 +1187,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1184,14 +1204,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1209,7 +1231,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1276,7 +1298,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1293,7 +1315,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1309,7 +1333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1327,7 +1351,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1385,7 +1409,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1402,14 +1426,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1427,7 +1453,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1481,7 +1507,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1498,7 +1524,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1509,7 +1537,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1520,7 +1548,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1568,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1585,14 +1613,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1603,7 +1633,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1655,7 +1685,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1669,7 +1699,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1683,7 +1715,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1691,7 +1723,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1768,7 +1800,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1782,7 +1814,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1793,7 +1827,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1801,7 +1835,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1877,7 +1911,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1894,7 +1928,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1905,7 +1941,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1923,7 +1959,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1994,7 +2030,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2008,7 +2044,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2024,7 +2062,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2070,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2110,7 +2148,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2124,7 +2162,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2135,7 +2175,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2143,7 +2183,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2202,7 +2242,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2216,7 +2256,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2227,7 +2269,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2235,7 +2277,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2313,7 +2355,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2327,7 +2369,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2338,7 +2382,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2346,7 +2390,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2401,7 +2445,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2415,7 +2459,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2426,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2434,7 +2480,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml b/2019-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml index 66da61e2e7..1684f816cd 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/spring/connection/update.yml @@ -38,7 +38,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -52,7 +52,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -66,7 +68,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -74,7 +76,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -144,7 +146,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -158,7 +160,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -171,7 +175,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -183,7 +187,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -223,7 +227,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -237,7 +241,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -251,7 +257,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -259,7 +265,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -322,7 +328,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -336,7 +342,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -350,7 +358,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +366,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -421,7 +429,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -435,7 +443,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -449,7 +459,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -457,7 +467,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -520,7 +530,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -534,7 +544,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -548,7 +560,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -556,7 +568,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -619,7 +631,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +645,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -647,7 +661,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -655,7 +669,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -718,7 +732,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -732,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -746,7 +762,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -754,7 +770,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -816,7 +832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -830,7 +846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -844,10 +862,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -909,7 +927,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -923,7 +941,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -937,7 +957,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -952,7 +972,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -989,7 +1009,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1003,7 +1023,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1013,7 +1035,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1028,7 +1050,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1072,7 +1094,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1086,7 +1108,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1100,7 +1124,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1115,7 +1139,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1157,7 +1181,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1171,7 +1195,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1181,7 +1207,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1196,7 +1222,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1234,7 +1260,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1248,7 +1274,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1262,7 +1290,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1270,7 +1298,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1302,7 +1330,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1316,7 +1344,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1326,7 +1356,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1334,7 +1364,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1371,7 +1401,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1385,7 +1415,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1399,7 +1431,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1407,7 +1439,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1469,7 +1501,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1483,7 +1515,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1497,7 +1531,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1505,7 +1539,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1562,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1576,7 +1610,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1590,7 +1626,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1605,7 +1641,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1651,7 +1687,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1665,7 +1701,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1679,7 +1717,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1687,7 +1725,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1747,7 +1785,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1761,7 +1799,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1775,7 +1815,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1783,7 +1823,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1824,7 +1864,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1838,7 +1878,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1852,7 +1894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1860,7 +1902,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1920,7 +1962,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1934,7 +1976,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1948,7 +1992,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +2000,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1996,7 +2040,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2010,7 +2054,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2024,7 +2070,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2078,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml b/2019-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml index fd2d12feca..7ea3e81023 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage/blob/directory.yml @@ -573,7 +573,7 @@ directCommands: - isRequired: true name: --destination-path -d summary: |- - The upload destination directory path. It should be an absolute path to container. If the specified destination path does not exist, a new directory path will be created. + The destination path that will be prepended to the blob name. - isRequired: true name: --source -s summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/tag.yml b/2019-03-01-hybrid/docs-ref-autogen/tag.yml index 431111437e..0f95578f9e 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/tag.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/tag.yml @@ -164,5 +164,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Tag Management on a resource. diff --git a/2019-03-01-hybrid/docs-ref-autogen/webapp.yml b/2019-03-01-hybrid/docs-ref-autogen/webapp.yml index 839c4b700d..f494bb2847 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/webapp.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/webapp.yml @@ -393,9 +393,7 @@ directCommands: name: az webapp deploy summary: |- Deploys a provided artifact to Azure Web Apps. - status: Preview - isPreview: true - previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + status: GA sourceType: Core syntax: >- az webapp deploy [--async {false, true}] diff --git a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection.yml b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection.yml index 5cb6b4634d..3768e89313 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection.yml @@ -22,6 +22,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--yes] examples: - summary: |- @@ -42,14 +43,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --yes -y defaultValue: "False" summary: |- @@ -63,6 +67,7 @@ directCommands: syntax: >- az webapp connection list [--name] [--resource-group] + [--slot] [--source-id] examples: - summary: |- @@ -77,10 +82,13 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -95,6 +103,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- List a connection's source configurations interactively @@ -114,10 +123,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_list-support-types() name: az webapp connection list-support-types summary: |- @@ -148,6 +160,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Get a connection interactively @@ -167,10 +180,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_validate() name: az webapp connection validate summary: |- @@ -182,6 +198,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Validate a connection interactively @@ -201,10 +218,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_wait() name: az webapp connection wait summary: |- @@ -221,6 +241,7 @@ directCommands: [--interval] [--name] [--resource-group] + [--slot] [--timeout] [--updated] examples: @@ -255,10 +276,13 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml index abe31f256d..58170d03b6 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/create.yml @@ -27,6 +27,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -40,6 +41,9 @@ directCommands: - summary: |- Create a connection between webapp and appconfig with resource name syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --tg AppconfigRG --app-config MyConfigStore --system-identity + - summary: |- + Create a connection between webapp slot and appconfig with resource name + syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --slot MySlot --tg AppconfigRG --app-config MyConfigStore --system-identity - summary: |- Create a connection between webapp and appconfig with resource id syntax: az webapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity @@ -59,7 +63,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -85,6 +89,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -129,6 +136,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--source-id] [--vault-id] examples: @@ -173,14 +181,17 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -206,6 +217,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -219,6 +231,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-cassandra with resource name syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-cassandra with resource name + syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity - summary: |- Create a connection between webapp and cosmos-cassandra with resource id syntax: az webapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity @@ -241,7 +256,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -252,7 +267,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -271,6 +286,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -316,6 +334,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -329,6 +348,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-gremlin with resource name syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-gremlin with resource name + syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity - summary: |- Create a connection between webapp and cosmos-gremlin with resource id syntax: az webapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity @@ -354,7 +376,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -365,7 +387,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -384,6 +406,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -428,6 +453,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -441,6 +467,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-mongo with resource name syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-mongo with resource name + syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-mongo with resource id syntax: az webapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity @@ -463,7 +492,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -474,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -493,6 +522,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -537,6 +569,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -550,6 +583,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-sql with resource name syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-sql with resource name + syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-sql with resource id syntax: az webapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity @@ -572,7 +608,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -583,7 +619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -602,6 +638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -645,6 +684,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--table] @@ -659,6 +699,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-table with resource name syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --table MyTable --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-table with resource name + syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --table MyTable --system-identity - summary: |- Create a connection between webapp and cosmos-table with resource id syntax: az webapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity @@ -678,7 +721,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -689,7 +732,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -708,6 +751,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -754,6 +800,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -767,6 +814,9 @@ directCommands: - summary: |- Create a connection between webapp and eventhub with resource name syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --tg EventhubRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and eventhub with resource name + syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --slot MySlot --tg EventhubRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and eventhub with resource id syntax: az webapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity @@ -783,7 +833,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -797,7 +847,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -816,6 +866,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -858,6 +911,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -872,6 +926,9 @@ directCommands: - summary: |- Create a connection between webapp and keyvault with resource name syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --tg KeyvaultRG --vault MyVault --system-identity + - summary: |- + Create a connection between webapp slot and keyvault with resource name + syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --slot MySlot --tg KeyvaultRG --vault MyVault --system-identity - summary: |- Create a connection between webapp and keyvault with resource id syntax: az webapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity @@ -894,7 +951,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -910,7 +967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -924,6 +981,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -973,6 +1033,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -984,6 +1045,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql with resource name syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql with resource name + syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql with resource id syntax: az webapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1009,7 +1073,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1020,7 +1084,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1040,6 +1104,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1069,6 +1136,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1081,6 +1149,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql-flexible with resource name syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql-flexible with resource name + syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql-flexible with resource id syntax: az webapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1106,14 +1177,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1129,6 +1200,9 @@ directCommands: - name: --server summary: |- Name of the mysql flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1206,14 +1280,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1293,6 +1367,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1305,6 +1380,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres with resource name syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres with resource name + syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres with resource id syntax: az webapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1336,7 +1414,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1352,7 +1430,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1372,6 +1450,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1456,7 +1537,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1472,7 +1553,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1628,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1559,6 +1641,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres-flexible with resource name syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres-flexible with resource name + syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres-flexible with resource id syntax: az webapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1584,14 +1669,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,6 +1692,9 @@ directCommands: - name: --server summary: |- Name of postgres flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1682,14 +1770,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1848,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1771,6 +1860,9 @@ directCommands: - summary: |- Create a connection between webapp and redis with resource name syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis with resource name + syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis with resource id syntax: az webapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret @@ -1790,7 +1882,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1801,7 +1893,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1810,6 +1902,9 @@ directCommands: - name: --server summary: |- Name of the redis server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1838,6 +1933,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1849,6 +1945,9 @@ directCommands: - summary: |- Create a connection between webapp and redis-enterprise with resource name syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis-enterprise with resource name + syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis-enterprise with resource id syntax: az webapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret @@ -1868,14 +1967,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1884,6 +1983,9 @@ directCommands: - name: --server summary: |- Name of the redis enterprise server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1914,6 +2016,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1927,6 +2030,9 @@ directCommands: - summary: |- Create a connection between webapp and servicebus with resource name syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --tg ServicebusRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and servicebus with resource name + syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --slot MySlot --tg ServicebusRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and servicebus with resource id syntax: az webapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity @@ -1943,7 +2049,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1957,7 +2063,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1976,6 +2082,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2018,6 +2127,7 @@ directCommands: [--secret] [--service-principal] [--signalr] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2031,6 +2141,9 @@ directCommands: - summary: |- Create a connection between webapp and signalr with resource name syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --tg SignalrRG --signalr MySignalR --system-identity + - summary: |- + Create a connection between webapp slot and signalr with resource name + syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --slot MySlot --tg SignalrRG --signalr MySignalR --system-identity - summary: |- Create a connection between webapp and signalr with resource id syntax: az webapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity @@ -2047,7 +2160,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2058,7 +2171,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,6 +2189,9 @@ directCommands: - name: --signalr summary: |- Name of the signalr service. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2120,6 +2236,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2132,6 +2249,9 @@ directCommands: - summary: |- Create a connection between webapp and sql with resource name syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and sql with resource name + syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --slot MySlot --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and sql with resource id syntax: az webapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -2157,7 +2277,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2168,7 +2288,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2188,6 +2308,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2265,7 +2388,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2276,7 +2399,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2353,6 +2476,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2366,6 +2490,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-blob with resource name syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-blob with resource name + syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-blob with resource id syntax: az webapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity @@ -2391,7 +2518,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2407,7 +2534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2426,6 +2553,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2468,6 +2598,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2479,6 +2610,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-file with resource name syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-file with resource name + syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-file with resource id syntax: az webapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret @@ -2498,7 +2632,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2509,7 +2643,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2519,6 +2653,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2549,6 +2686,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2562,6 +2700,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-queue with resource name syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-queue with resource name + syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-queue with resource id syntax: az webapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity @@ -2581,7 +2722,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2592,7 +2733,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2611,6 +2752,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2653,6 +2797,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2664,6 +2809,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-table with resource name syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-table with resource name + syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-table with resource id syntax: az webapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret @@ -2683,7 +2831,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2694,7 +2842,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2704,6 +2852,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2732,6 +2883,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2746,6 +2898,9 @@ directCommands: - summary: |- Create a connection between webapp and webpubsub with resource name syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity + - summary: |- + Create a connection between webapp slot and webpubsub with resource name + syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --slot MySlot --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity - summary: |- Create a connection between webapp and webpubsub with resource id syntax: az webapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity @@ -2762,7 +2917,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2773,7 +2928,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2788,6 +2943,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. diff --git a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml index 5e3a0a9a07..5c31692daf 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/webapp/connection/update.yml @@ -23,6 +23,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -49,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -60,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -75,6 +76,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -110,6 +114,7 @@ directCommands: [--schema-key] [--schema-registry] [--schema-secret] + [--slot] [--source-id] [--vault-id] examples: @@ -149,14 +154,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -166,6 +171,9 @@ directCommands: - name: --schema-secret summary: |- Schema registry API-Key (secret). + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -190,6 +198,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -216,7 +225,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -227,7 +236,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -246,6 +255,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -280,6 +292,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -306,7 +319,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -317,7 +330,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -336,6 +349,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -370,6 +386,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -396,7 +413,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -407,7 +424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -426,6 +443,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -460,6 +480,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -486,7 +507,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -497,7 +518,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -516,6 +537,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -550,6 +574,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -576,7 +601,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -587,7 +612,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -606,6 +631,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -640,6 +668,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -666,7 +695,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -677,7 +706,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -696,6 +725,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -729,6 +761,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -755,7 +788,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -766,7 +799,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -780,6 +813,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -816,6 +852,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -846,7 +883,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -857,7 +894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -874,6 +911,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -893,6 +933,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -924,14 +965,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -944,6 +985,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -974,6 +1018,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1005,7 +1050,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1016,7 +1061,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1033,6 +1078,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1057,6 +1105,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -1088,14 +1137,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1108,6 +1157,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1132,6 +1184,7 @@ directCommands: [--private-endpoint {false, true}] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1156,7 +1209,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1167,12 +1220,15 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1191,6 +1247,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1215,19 +1272,22 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1249,6 +1309,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1275,7 +1336,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1286,7 +1347,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1305,6 +1366,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1338,6 +1402,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1364,7 +1429,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1375,7 +1440,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1390,6 +1455,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1424,6 +1492,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1455,7 +1524,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1466,7 +1535,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1483,6 +1552,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1509,6 +1581,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1535,7 +1608,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1546,7 +1619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1565,6 +1638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1598,6 +1674,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1622,7 +1699,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1633,7 +1710,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1643,6 +1720,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1664,6 +1744,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1690,7 +1771,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1701,7 +1782,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1720,6 +1801,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1753,6 +1837,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1777,7 +1862,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1788,7 +1873,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1798,6 +1883,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1818,6 +1906,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1844,7 +1933,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1855,7 +1944,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1870,6 +1959,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/TOC.yml b/2020-09-01-hybrid/docs-ref-autogen/TOC.yml index 776a9bd9ab..25a2a21f99 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/TOC.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/TOC.yml @@ -594,6 +594,14 @@ uid: az_scvmm_vm_disk displayName: az scvmm vm disk items: [] + - name: extension + uid: az_scvmm_vm_extension + displayName: az scvmm vm extension + items: [] + - name: guest-agent + uid: az_scvmm_vm_guest-agent + displayName: az scvmm vm guest-agent + items: [] - name: nic uid: az_scvmm_vm_nic displayName: az scvmm vm nic @@ -3978,6 +3986,10 @@ uid: az_aks_egress-endpoints displayName: az aks egress-endpoints items: [] + - name: machine + uid: az_aks_machine + displayName: az aks machine + items: [] - name: maintenanceconfiguration uid: az_aks_maintenanceconfiguration displayName: az aks maintenanceconfiguration @@ -7353,10 +7365,6 @@ uid: az_stack-hci_extension displayName: az stack-hci extension items: [] - - name: Stack HCI VM - uid: sp-Stack_HCI_VM - displayName: Stack HCI VM - items: [] - name: Storage items: - name: Summary diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/lock.yml b/2020-09-01-hybrid/docs-ref-autogen/account/lock.yml index 8868f4e99e..65cc8fbba7 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/lock.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/lock.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure subscription level locks. diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/management-group.yml b/2020-09-01-hybrid/docs-ref-autogen/account/management-group.yml index 4581a2922b..697a9365b8 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/management-group.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/management-group.yml @@ -257,5 +257,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure Management Groups. diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/entities.yml b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/entities.yml index 216e0bf65c..4e4e45263a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/entities.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/entities.yml @@ -47,5 +47,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Entity operations (Management Group and Subscriptions) for Management Groups. diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml index 1765ca90da..8273695000 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/hierarchy-settings.yml @@ -177,5 +177,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy. diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml index 572dfc76f3..523464ad76 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/subscription.yml @@ -130,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Subscription operations for Management Groups. diff --git a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml index 037d92a58d..8d240dd236 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/account/management-group/tenant-backfill.yml @@ -62,5 +62,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Backfill Tenant Subscription Operations for Management Groups. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/agentpool.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/agentpool.yml index a44e57a32f..c8876fb011 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/agentpool.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/agentpool.yml @@ -233,5 +233,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage private Tasks agent pools with Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/cache.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/cache.yml index 67bbcaab50..893ade96f7 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/cache.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/cache.yml @@ -203,5 +203,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage cache rules in Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/config.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/config.yml index a12612412d..02694cb215 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/config.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/config.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Configure policies for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/config/authentication-as-arm.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/config/authentication-as-arm.yml index 44ef90c1f2..90fd784b28 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/config/authentication-as-arm.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/config/authentication-as-arm.yml @@ -94,5 +94,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage 'Azure AD authenticate as ARM' policy for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/config/content-trust.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/config/content-trust.yml index 13e5b1ea44..2307b788f3 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/config/content-trust.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/config/content-trust.yml @@ -85,5 +85,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage content-trust policy for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/config/retention.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/config/retention.yml index 86c1e72939..76b5b6d863 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/config/retention.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/config/retention.yml @@ -105,5 +105,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage retention policy for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/config/soft-delete.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/config/soft-delete.yml index ef2ca5b5ba..e32e2a688e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/config/soft-delete.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/config/soft-delete.yml @@ -90,5 +90,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage soft-delete policy for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry.yml index 35ec8ce53b..5fdf1fe49a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry.yml @@ -332,10 +332,10 @@ directCommands: optionalParameters: - name: --add summary: |- - Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --remove summary: |- - Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -479,5 +479,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage connected registry resources with Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/install.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/install.yml index 60709e6d8d..c7bb7f4d5a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/install.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/install.yml @@ -119,5 +119,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Help to access the necessary information for installing a connected registry. Please see https://aka.ms/acr/connected-registry for more information. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/permissions.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/permissions.yml index c7ea594c44..c46c23df1b 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/permissions.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/connected-registry/permissions.yml @@ -75,10 +75,10 @@ directCommands: optionalParameters: - name: --add summary: |- - Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --remove summary: |- - Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -110,5 +110,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage the repository permissions accross multiple connected registries. Please see https://aka.ms/acr/connected-registry for more information. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/credential-set.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/credential-set.yml index 266d16fb94..e82322248e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/credential-set.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/credential-set.yml @@ -196,5 +196,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credential sets in Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/credential.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/credential.yml index 80128cb7a8..186141b45f 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/credential.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/credential.yml @@ -95,5 +95,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage login credentials for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/encryption.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/encryption.yml index 988ac080c5..084fd47a1d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/encryption.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/encryption.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: For more information, see http://aka.ms/acr/cmk. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/helm.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/helm.yml index 004848d689..ff75b77515 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/helm.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/helm.yml @@ -258,5 +258,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage helm charts for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/helm/repo.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/helm/repo.yml index f9c91427b9..41fdece153 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/helm/repo.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/helm/repo.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage helm chart repositories for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/identity.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/identity.yml index c7e57e0e5a..b9601f2ea6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/identity.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/identity.yml @@ -104,5 +104,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage service (managed) identities for a container registry. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/manifest.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/manifest.yml index 7b57d58eac..25810d9a7d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/manifest.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/manifest.yml @@ -568,5 +568,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage artifact manifests in Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/manifest/metadata.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/manifest/metadata.yml index 688efccfe6..8f6819c925 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/manifest/metadata.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/manifest/metadata.yml @@ -179,5 +179,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage artifact manifest metadata in Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/network-rule.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/network-rule.yml index 4e1b046c58..577b3d6a5e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/network-rule.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/network-rule.yml @@ -18,12 +18,6 @@ directCommands: [--ip-address] [--resource-group] examples: - - summary: |- - Add a rule to allow access for a subnet in the same resource group as the registry. - syntax: az acr network-rule add -n MyRegistry --vnet-name myvnet --subnet mysubnet - - summary: |- - Add a rule to allow access for a subnet in a different subscription or resource group. - syntax: az acr network-rule add -n MyRegistry --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet - summary: |- Add a rule to allow access for a specific IP address-range. syntax: az acr network-rule add -n MyRegistry --ip-address 23.45.1.0/24 @@ -74,12 +68,6 @@ directCommands: [--ip-address] [--resource-group] examples: - - summary: |- - Remove a rule that allows access for a subnet in the same resource group as the registry. - syntax: az acr network-rule remove -n MyRegistry --vnet-name myvnet --subnet mysubnet - - summary: |- - Remove a rule that allows access for a subnet in a different subscription or resource group. - syntax: az acr network-rule remove -n MyRegistry --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet - summary: |- Remove a rule that allows access for a specific IP address-range. syntax: az acr network-rule remove -n MyRegistry --ip-address 23.45.1.0/24 @@ -124,5 +112,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage network rules for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/pack.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/pack.yml index 5e57165ceb..706e56a8ff 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/pack.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/pack.yml @@ -120,5 +120,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage Azure Container Registry Tasks that use Cloud Native Buildpacks. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/private-endpoint-connection.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/private-endpoint-connection.yml index a27e7156ed..01d5a8863e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/private-endpoint-connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/private-endpoint-connection.yml @@ -172,5 +172,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: To create a private endpoint connection use "az network private-endpoint create". For more information see https://aka.ms/acr/private-link. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/private-link-resource.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/private-link-resource.yml index 03c7c6440b..9d87a4289a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/private-link-resource.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/private-link-resource.yml @@ -52,5 +52,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage registry private link resources. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/replication.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/replication.yml index 4e74dd2284..3663d99f3d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/replication.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/replication.yml @@ -227,5 +227,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage geo-replicated regions of Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/repository.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/repository.yml index 971b7969b9..bcfdf0cd70 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/repository.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/repository.yml @@ -422,5 +422,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage repositories (image names) for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/scope-map.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/scope-map.yml index f4dad54ce9..25832cb0ab 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/scope-map.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/scope-map.yml @@ -45,10 +45,10 @@ directCommands: Description for the scope map. Maximum 256 characters are allowed. - name: --gateway summary: |- - Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'config/read', 'message/write'}. + Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --repository summary: |- - Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -167,19 +167,19 @@ directCommands: optionalParameters: - name: --add-gateway summary: |- - Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'config/read', 'message/write'}. + Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --add-repository summary: |- - Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --description summary: |- Description for the scope map. Maximum 256 characters are allowed. - name: --remove-gateway summary: |- - Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'config/read', 'message/write'}. + Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --remove-repository summary: |- - Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -214,5 +214,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage scope access maps for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/task.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/task.yml index 3fab790c12..4f93fcd327 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/task.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/task.yml @@ -799,5 +799,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage a collection of steps for building, testing and OS & Framework patching container images using Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/task/credential.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/task/credential.yml index 5f72143b91..2b03af8ce1 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/task/credential.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/task/credential.yml @@ -219,5 +219,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credentials for a task. Please see https://aka.ms/acr/tasks/cross-registry-authentication for more information. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/task/identity.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/task/identity.yml index c884a8a959..bb6e3837bb 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/task/identity.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/task/identity.yml @@ -145,5 +145,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Managed Identities for Task. Please see https://aka.ms/acr/tasks/task-create-managed-identity for more information. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/task/timer.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/task/timer.yml index cadb3b2daf..43572552ad 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/task/timer.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/task/timer.yml @@ -186,5 +186,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage timer triggers for a task. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/taskrun.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/taskrun.yml index d60602d4d1..3774ccedd5 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/taskrun.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/taskrun.yml @@ -163,5 +163,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage taskruns using Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml index d9426fd7c0..da5a3fc18f 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml @@ -57,14 +57,14 @@ directCommands: Number of days for which the credentials will be valid. If not specified, the expiration will default to the max value "9999-12-31T23:59:59.999999+00:00". - name: --gateway summary: |- - Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'config/read', 'message/write'}. + Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --no-passwords parameterValueGroup: "false, true" summary: |- Do not generate passwords during token creation. You can generate the passwords after the token is created by using `az acr token credentials generate` command. - name: --repository summary: |- - Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'content/delete', 'metadata/read', 'content/write', 'metadata/write'}. + Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -229,5 +229,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage tokens for an Azure Container Registry. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/token/credential.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/token/credential.yml index ffa6e31909..6df3ae192d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/token/credential.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/token/credential.yml @@ -118,5 +118,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credentials of a token for an Azure Container Registry. diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr/webhook.yml b/2020-09-01-hybrid/docs-ref-autogen/acr/webhook.yml index 4afab2dded..421f340e1c 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/webhook.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/webhook.yml @@ -350,5 +350,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage webhooks for Azure Container Registries. diff --git a/2020-09-01-hybrid/docs-ref-autogen/aks.yml b/2020-09-01-hybrid/docs-ref-autogen/aks.yml index 91c7cc04e6..121ad2124a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/aks.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/aks.yml @@ -1025,6 +1025,7 @@ directCommands: [--http-proxy-config] [--image-cleaner-interval-hours] [--ip-families] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -1083,7 +1084,7 @@ directCommands: [--snapshot-id] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--vm-set-type] [--vnet-subnet-id] [--windows-admin-password] @@ -1560,6 +1561,10 @@ directCommands: A comma separated list of IP versions to use for cluster networking. description: |- Each IP version should be in the format IPvN. For example, IPv4. + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -1809,7 +1814,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA. - name: --vm-set-type @@ -2004,17 +2009,17 @@ directCommands: Enable Kubernetes addons. description: |- These addons are available: - - http_application_routing : configure ingress with automatic public DNS name creation. - - monitoring : turn on Log Analytics monitoring. Requires "--workspace-resource-id". - Requires "--enable-msi-auth-for-monitoring" for managed identity auth. - Requires "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled - If monitoring addon is enabled --no-wait argument will have no effect - - virtual-node : enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. - - azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner. - Learn more at aka.ms/aks/policy. - - ingress-appgw : enable Application Gateway Ingress Controller addon. - - open-service-mesh : enable Open Service Mesh addon. - - azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon. + - http_application_routing : configure ingress with automatic public DNS name creation. + - monitoring : turn on Log Analytics monitoring. Requires "--workspace-resource-id". + Requires "--enable-msi-auth-for-monitoring" for managed identity auth. + Requires "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled + If monitoring addon is enabled --no-wait argument will have no effect + - virtual-node : enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. + - azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner. + Learn more at aka.ms/aks/policy. + - ingress-appgw : enable Application Gateway Ingress Controller addon. + - open-service-mesh : enable Open Service Mesh addon. + - azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon. status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/acs/_help.py @@ -3033,6 +3038,7 @@ directCommands: [--disable-defender] [--disable-disk-driver] [--disable-file-driver] + [--disable-force-upgrade] [--disable-image-cleaner] [--disable-keda] [--disable-local-accounts] @@ -3040,6 +3046,7 @@ directCommands: [--disable-secret-rotation] [--disable-snapshot-controller] [--disable-vpa] + [--disable-windows-gmsa] [--disable-workload-identity] [--enable-aad] [--enable-ahub] @@ -3051,6 +3058,7 @@ directCommands: [--enable-defender] [--enable-disk-driver] [--enable-file-driver] + [--enable-force-upgrade] [--enable-image-cleaner] [--enable-keda] [--enable-local-accounts] @@ -3089,10 +3097,12 @@ directCommands: [--nodepool-taints] [--outbound-type {loadBalancer, managedNATGateway, userAssignedNATGateway, userDefinedRouting}] [--pod-cidr] + [--private-dns-zone] [--rotation-poll-interval] [--tags] [--tier {free, premium, standard}] [--update-cluster-autoscaler] + [--upgrade-override-until] [--windows-admin-password] [--yes] examples: @@ -3168,6 +3178,9 @@ directCommands: - summary: |- Enable Windows gmsa for a kubernetes cluster without setting DNS server in the vnet used by the cluster. syntax: az aks update -g MyResourceGroup -n MyManagedCluster --enable-windows-gmsa --gmsa-dns-server "10.240.0.4" --gmsa-root-domain-name "contoso.com" + - summary: |- + Disable Windows gmsa for a kubernetes cluster. + syntax: az aks update -g MyResourceGroup -n MyManagedCluster --disable-windows-gmsa - summary: |- Enable KEDA workload autoscaler for an existing kubernetes cluster. syntax: az aks update -g MyResourceGroup -n MyManagedCluster --enable-keda @@ -3274,6 +3287,10 @@ directCommands: defaultValue: "False" summary: |- Disable AzureFile CSI Driver. + - name: --disable-force-upgrade + defaultValue: "False" + summary: |- + Disable forceUpgrade cluster upgrade settings override. - name: --disable-image-cleaner defaultValue: "False" summary: |- @@ -3302,6 +3319,10 @@ directCommands: defaultValue: "False" summary: |- Disable vertical pod autoscaler for cluster. + - name: --disable-windows-gmsa + defaultValue: "False" + summary: |- + Disable Windows gmsa on cluster. - name: --disable-workload-identity defaultValue: "False" summary: |- @@ -3345,6 +3366,10 @@ directCommands: defaultValue: "False" summary: |- Enable AzureFile CSI Driver. + - name: --enable-force-upgrade + defaultValue: "False" + summary: |- + Enable forceUpgrade cluster upgrade settings override. - name: --enable-image-cleaner defaultValue: "False" summary: |- @@ -3501,6 +3526,11 @@ directCommands: - name: --pod-cidr summary: |- Update the pod CIDR for a cluster. Used when updating a cluster from Azure CNI to Azure CNI Overlay. + - name: --private-dns-zone + summary: |- + The private dns zone mode for private cluster. + description: |- + Only allow changing private dns zone from byo/system mode to none for private cluster. Others are denied. - name: --rotation-poll-interval summary: |- Set interval of rotation poll. Use with azure-keyvault-secrets-provider addon. @@ -3515,6 +3545,9 @@ directCommands: defaultValue: "False" summary: |- Update min-count or max-count for cluster autoscaler. + - name: --upgrade-override-until + summary: |- + Until when the cluster upgradeSettings overrides are effective. It needs to be in a valid date-time format that's within the next 30 days. For example, 2023-04-01T13:00:00Z. Note that if --force-upgrade is set to true and --upgrade-override-until is not set, by default it will be set to 3 days from now. - name: --windows-admin-password summary: |- User account password to use on windows node VMs. @@ -3626,6 +3659,7 @@ directCommands: [--guardrails-version] [--http-proxy-config] [--image-cleaner-interval-hours] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -3653,7 +3687,7 @@ directCommands: [--rotation-poll-interval] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--update-cluster-autoscaler] [--upgrade-override-until] [--windows-admin-password] @@ -4100,6 +4134,10 @@ directCommands: summary: |- ImageCleaner scanning interval. isPreview: true + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -4218,7 +4256,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' changes a standard managed cluster to a free one. - name: --update-cluster-autoscaler -u @@ -4678,6 +4716,9 @@ commands: - az_aks_kollect(aks-preview) - az_aks_list() - az_aks_list(aks-preview) +- az_aks_machine +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) - az_aks_maintenanceconfiguration - az_aks_maintenanceconfiguration_add() - az_aks_maintenanceconfiguration_add(aks-preview) diff --git a/2020-09-01-hybrid/docs-ref-autogen/aks/command.yml b/2020-09-01-hybrid/docs-ref-autogen/aks/command.yml index a6ae0bd77a..eab2a68208 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/aks/command.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/aks/command.yml @@ -91,5 +91,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/17/2023 + ms.date: 09/19/2023 description: See detail usage in 'az aks command invoke', 'az aks command result'. diff --git a/2020-09-01-hybrid/docs-ref-autogen/aks/machine.yml b/2020-09-01-hybrid/docs-ref-autogen/aks/machine.yml new file mode 100644 index 0000000000..0562e9ba0f --- /dev/null +++ b/2020-09-01-hybrid/docs-ref-autogen/aks/machine.yml @@ -0,0 +1,92 @@ +### YamlMime:AzureCLIGroup +uid: az_aks_machine +name: az aks machine +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **aks-preview** extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an **az aks machine** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Get information about machines in a nodepool of a managed clusters. +status: GA +sourceType: Extension +directCommands: +- uid: az_aks_machine_list(aks-preview) + name: az aks machine list + summary: |- + Get information about IP Addresses, Hostname for all machines in an agentpool. + status: GA + sourceType: Extension + syntax: >- + az aks machine list --cluster-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_aks_machine_show(aks-preview) + name: az aks machine show + summary: |- + Show IP Addresses, Hostname for a specific machine in an agentpool for a managedcluster. + status: GA + sourceType: Extension + syntax: >- + az aks machine show --cluster-name + --machine-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --machine-name + summary: |- + Get IP Addresses, Hostname for a specific machine in an agentpool. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +commands: +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Get information about machines in a nodepool of a managed clusters. diff --git a/2020-09-01-hybrid/docs-ref-autogen/aks/oidc-issuer.yml b/2020-09-01-hybrid/docs-ref-autogen/aks/oidc-issuer.yml index bb713bf3a0..fef307d8c8 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/aks/oidc-issuer.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/aks/oidc-issuer.yml @@ -63,5 +63,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/17/2023 + ms.date: 09/19/2023 description: Oidc issuer related commands. diff --git a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection.yml index c65eca91b8..62f0fe7ed2 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection.yml @@ -12,6 +12,7 @@ directCommands: Delete a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection delete [--connection] [--id] @@ -38,14 +39,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -56,6 +57,7 @@ directCommands: List connections of a containerapp. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list [--name] [--resource-group] @@ -73,10 +75,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -86,6 +88,7 @@ directCommands: List source configurations of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list-configuration [--connection] [--id] @@ -110,16 +113,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_list-support-types() name: az containerapp connection list-support-types summary: |- List client types and auth types supported by containerapp connections. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: az containerapp connection list-support-types [--target-type {appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}] examples: - summary: |- @@ -139,6 +143,7 @@ directCommands: Get the details of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection show [--connection] [--id] @@ -163,16 +168,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_validate() name: az containerapp connection validate summary: |- Validate a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection validate [--connection] [--id] @@ -197,16 +203,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_wait() name: az containerapp connection wait summary: |- Place the CLI in a waiting state until a condition of the connection is met. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection wait [--connection] [--created] @@ -251,10 +258,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- @@ -344,4 +351,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Commands to manage containerapp connections. diff --git a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml index b07b1e4f10..28f82f023d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/create.yml @@ -12,6 +12,7 @@ directCommands: Create a containerapp connection to appconfig. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create appconfig [--app-config] [--client-type {dotnet, java, nodejs, none, python}] @@ -59,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -116,6 +117,7 @@ directCommands: Create a containerapp connection to confluent-cloud. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create confluent-cloud --bootstrap-server --kafka-key @@ -177,14 +179,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -197,6 +199,7 @@ directCommands: Create a containerapp connection to cosmos-cassandra. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-cassandra [--account] [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] @@ -249,7 +252,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -260,7 +263,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,6 +313,7 @@ directCommands: Create a containerapp connection to cosmos-gremlin. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-gremlin [--account] [--client-type {dotnet, java, nodejs, none, php, python}] @@ -366,7 +370,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -377,7 +381,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -427,6 +431,7 @@ directCommands: Create a containerapp connection to cosmos-mongo. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-mongo [--account] [--client-type {dotnet, go, java, nodejs, none, springBoot}] @@ -479,7 +484,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -490,7 +495,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -540,6 +545,7 @@ directCommands: Create a containerapp connection to cosmos-sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-sql [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -592,7 +598,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -603,7 +609,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -653,6 +659,7 @@ directCommands: Create a containerapp connection to cosmos-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-table [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -702,7 +709,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -713,7 +720,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -766,6 +773,7 @@ directCommands: Create a containerapp connection to eventhub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -811,7 +819,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -825,7 +833,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -875,6 +883,7 @@ directCommands: Create a containerapp connection to keyvault. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -926,7 +935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -942,7 +951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -992,6 +1001,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1038,7 +1048,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1049,7 +1059,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1087,6 +1097,7 @@ directCommands: Create a containerapp connection to mysql-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1132,14 +1143,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1182,6 +1193,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1236,7 +1248,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1252,7 +1264,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1295,6 +1307,7 @@ directCommands: Create a containerapp connection to postgres-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1340,14 +1353,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1386,6 +1399,7 @@ directCommands: Create a containerapp connection to redis. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1431,7 +1445,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1442,7 +1456,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1469,6 +1483,7 @@ directCommands: Create a containerapp connection to redis-enterprise. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1513,14 +1528,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1562,7 @@ directCommands: Create a containerapp connection to servicebus. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1592,7 +1608,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1606,7 +1622,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1656,6 +1672,7 @@ directCommands: Create a containerapp connection to signalr. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create signalr [--client-type {dotnet, none}] [--connection] @@ -1700,7 +1717,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1711,7 +1728,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1777,7 @@ directCommands: Create a containerapp connection to sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1807,7 +1825,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1818,7 +1836,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1861,6 +1879,7 @@ directCommands: Create a containerapp connection to storage-blob. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-blob [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -1916,7 +1935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1932,7 +1951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1982,6 +2001,7 @@ directCommands: Create a containerapp connection to storage-file. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-file [--account] [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] @@ -2027,7 +2047,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2038,7 +2058,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2066,6 +2086,7 @@ directCommands: Create a containerapp connection to storage-queue. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-queue [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -2114,7 +2135,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2125,7 +2146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2175,6 +2196,7 @@ directCommands: Create a containerapp connection to storage-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-table [--account] [--client-type {dotnet, java, nodejs, none, python}] @@ -2220,7 +2242,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2231,7 +2253,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2259,6 +2281,7 @@ directCommands: Create a containerapp connection to webpubsub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -2303,7 +2326,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2314,7 +2337,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2406,4 +2429,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Create a connection between a containerapp and a target resource. diff --git a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml index 374cae2ad2..11afda4188 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/containerapp/connection/update.yml @@ -12,6 +12,7 @@ directCommands: Update a containerapp to appconfig connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update appconfig [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -53,7 +54,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -64,7 +65,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -101,6 +102,7 @@ directCommands: Update a containerapp to confluent-cloud connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update confluent-cloud --connection [--bootstrap-server] @@ -153,14 +155,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -182,6 +184,7 @@ directCommands: Update a containerapp to cosmos-cassandra connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-cassandra [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -224,7 +227,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -235,7 +238,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -276,6 +279,7 @@ directCommands: Update a containerapp to cosmos-gremlin connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-gremlin [--client-type {dotnet, java, nodejs, none, php, python}] [--connection] @@ -318,7 +322,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -329,7 +333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -370,6 +374,7 @@ directCommands: Update a containerapp to cosmos-mongo connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-mongo [--client-type {dotnet, go, java, nodejs, none, springBoot}] [--connection] @@ -412,7 +417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -423,7 +428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -464,6 +469,7 @@ directCommands: Update a containerapp to cosmos-sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-sql [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -506,7 +512,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -517,7 +523,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -558,6 +564,7 @@ directCommands: Update a containerapp to cosmos-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-table [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -600,7 +607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -611,7 +618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,6 +659,7 @@ directCommands: Update a containerapp to eventhub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -694,7 +702,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -705,7 +713,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -746,6 +754,7 @@ directCommands: Update a containerapp to keyvault connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -787,7 +796,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -798,7 +807,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,6 +845,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -875,7 +885,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -886,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -912,6 +922,7 @@ directCommands: Update a containerapp to mysql-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -950,14 +961,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -988,6 +999,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1028,7 +1040,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1039,7 +1051,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1070,6 +1082,7 @@ directCommands: Update a containerapp to postgres-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1108,14 +1121,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,6 +1155,7 @@ directCommands: Update a containerapp to redis connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1180,7 +1194,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1191,7 +1205,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1206,6 +1220,7 @@ directCommands: Update a containerapp to redis-enterprise connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1243,14 +1258,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1265,6 +1280,7 @@ directCommands: Update a containerapp to servicebus connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1307,7 +1323,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1318,7 +1334,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1359,6 +1375,7 @@ directCommands: Update a containerapp to signalr connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update signalr [--client-type {dotnet, none}] [--connection] @@ -1400,7 +1417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1411,7 +1428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1448,6 +1465,7 @@ directCommands: Update a containerapp to sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1488,7 +1506,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1499,7 +1517,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1530,6 +1548,7 @@ directCommands: Update a containerapp to storage-blob connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-blob [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1572,7 +1591,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1583,7 +1602,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1624,6 +1643,7 @@ directCommands: Update a containerapp to storage-file connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-file [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1663,7 +1683,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1674,7 +1694,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1693,6 +1713,7 @@ directCommands: Update a containerapp to storage-queue connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-queue [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1735,7 +1756,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1746,7 +1767,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1787,6 +1808,7 @@ directCommands: Update a containerapp to storage-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-table [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1826,7 +1848,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1837,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1856,6 +1878,7 @@ directCommands: Update a containerapp to webpubsub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1897,7 +1920,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1908,7 +1931,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1988,4 +2011,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Update a containerapp connection. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment.yml index 20749b0819..aa8d61fa35 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment.yml @@ -415,5 +415,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/group.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/group.yml index 8401a7a86b..c0e29e69fb 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/group.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/group.yml @@ -83,8 +83,8 @@ directCommands: Create a deployment at resource group scope from a template-spec syntax: az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0" - summary: |- - Create a deployment at resource group scope from a bicep template and a bicepparam parameter file - syntax: az deployment group create --resource-group testrg --template-file azuredeploy.bicep --parameters parameters.bicepparam + Create a deployment at resource group scope from a bicepparam parameter file + syntax: az deployment group create --resource-group testrg --parameters parameters.bicepparam - summary: |- Create a deployment at resource group across tenants syntax: >- @@ -133,7 +133,7 @@ directCommands: summary: |- Supply deployment parameter values. description: |- - 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. Also note if you are providing a bicepparam file with a bicep template then you can use this argument only once. + 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. Also note if you are providing a bicepparam file then you can use this argument only once. - name: --proceed-if-no-change summary: |- Instruct the command to execute the deployment if the What-If result contains no resource changes. Applicable when --confirm-with-what-if is set. @@ -512,5 +512,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at resource group. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/mg.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/mg.yml index 3b3857c4a1..8643d5f2e6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/mg.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/mg.yml @@ -475,5 +475,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at management group. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation.yml index a788bc8a58..769e3a3842 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/group.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/group.yml index c950e10e53..f2ba339664 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/group.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/group.yml @@ -81,5 +81,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at resource group. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/mg.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/mg.yml index 0fdc26af22..c2a7a6b9e5 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/mg.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/mg.yml @@ -77,5 +77,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at management group. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml index eedad853e1..5060c4afd8 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/sub.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/tenant.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/tenant.yml index e9c9755692..05f9478035 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/tenant.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/operation/tenant.yml @@ -66,5 +66,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at tenant scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/sub.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/sub.yml index 789462e0aa..abcad321cd 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/sub.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/sub.yml @@ -419,5 +419,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/deployment/tenant.yml b/2020-09-01-hybrid/docs-ref-autogen/deployment/tenant.yml index c86cf5a110..592e5ec124 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/deployment/tenant.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/deployment/tenant.yml @@ -423,5 +423,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at tenant scope. diff --git a/2020-09-01-hybrid/docs-ref-autogen/dt/model.yml b/2020-09-01-hybrid/docs-ref-autogen/dt/model.yml index a96d5da72b..583a66b870 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/dt/model.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/dt/model.yml @@ -132,7 +132,7 @@ directCommands: List model definitions syntax: az dt model list -n {instance_or_hostname} --definition - summary: |- - List dependencies of particular pre-existing model(s). Space seperate dtmi values. + List dependencies of particular pre-existing model(s). Space separate dtmi values. syntax: az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1} requiredParameters: - isRequired: true diff --git a/2020-09-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml index 3d46f29499..c1e786c25d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/dt/network/private-endpoint/connection.yml @@ -117,7 +117,7 @@ directCommands: Description for the private endpoint connection. - name: --group-ids summary: |- - Space seperated list of group ids that the private endpoint should connect to. + Space separated list of group ids that the private endpoint should connect to. - name: --no-wait defaultValue: "False" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/feature.yml b/2020-09-01-hybrid/docs-ref-autogen/feature.yml index d9aa63b0e6..f2db687a32 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/feature.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/feature.yml @@ -117,5 +117,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource provider features. diff --git a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection.yml index 5aa7711ce5..67a0d992a8 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection.yml @@ -43,14 +43,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -79,10 +79,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -117,10 +117,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_list-support-types() name: az functionapp connection list-support-types summary: |- @@ -172,10 +172,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_validate() name: az functionapp connection validate summary: |- @@ -207,10 +207,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_wait() name: az functionapp connection wait summary: |- @@ -262,10 +262,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml index e92790c539..3767dae0bc 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/create.yml @@ -60,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -71,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -175,14 +175,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -244,7 +244,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -255,7 +255,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +358,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -369,7 +369,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -468,7 +468,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -479,7 +479,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -578,7 +578,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -589,7 +589,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -685,7 +685,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -696,7 +696,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -791,7 +791,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -805,7 +805,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -903,7 +903,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -919,7 +919,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1012,7 +1012,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1023,7 +1023,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1103,14 +1103,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1194,14 +1194,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1299,7 +1299,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1315,7 +1315,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1410,7 +1410,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1426,7 +1426,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1515,14 +1515,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1604,14 +1604,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1696,7 +1696,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1707,7 +1707,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1775,14 +1775,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1851,7 +1851,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1865,7 +1865,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +1956,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1967,7 +1967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2060,7 +2060,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2071,7 +2071,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2159,7 +2159,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2170,7 +2170,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2269,7 +2269,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2285,7 +2285,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2377,7 +2377,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2388,7 +2388,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2461,7 +2461,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2472,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2564,7 +2564,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2575,7 +2575,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2644,7 +2644,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2655,7 +2655,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml index 38d4dd2445..5f86ae02ef 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/functionapp/connection/update.yml @@ -50,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -61,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -151,14 +151,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -219,7 +219,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -230,7 +230,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,7 +310,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -321,7 +321,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -401,7 +401,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -412,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -492,7 +492,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -503,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -583,7 +583,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -594,7 +594,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -674,7 +674,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -685,7 +685,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -764,7 +764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -775,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -849,7 +849,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -860,7 +860,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -921,14 +921,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -996,7 +996,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1007,7 +1007,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1073,14 +1073,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,7 +1142,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1153,7 +1153,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1202,14 +1202,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1263,7 +1263,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1274,7 +1274,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1353,7 +1353,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1364,7 +1364,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1438,7 +1438,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1449,7 +1449,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1519,7 +1519,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1530,7 +1530,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,7 +1607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1618,7 +1618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1676,7 +1676,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1687,7 +1687,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1764,7 +1764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1775,7 +1775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1832,7 +1832,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1843,7 +1843,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/group.yml b/2020-09-01-hybrid/docs-ref-autogen/group.yml index 846b577ecc..b450511a56 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/group.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/group.yml @@ -296,5 +296,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource groups and template deployments. diff --git a/2020-09-01-hybrid/docs-ref-autogen/group/deployment.yml b/2020-09-01-hybrid/docs-ref-autogen/group/deployment.yml index bdb6506b2b..845f03e2c5 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/group/deployment.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/group/deployment.yml @@ -376,5 +376,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager deployments. diff --git a/2020-09-01-hybrid/docs-ref-autogen/group/deployment/operation.yml b/2020-09-01-hybrid/docs-ref-autogen/group/deployment/operation.yml index 3a10ee2996..1a816fc7b6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/group/deployment/operation.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/group/deployment/operation.yml @@ -88,5 +88,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations. diff --git a/2020-09-01-hybrid/docs-ref-autogen/group/lock.yml b/2020-09-01-hybrid/docs-ref-autogen/group/lock.yml index 6190f384ce..9862bfbf29 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/group/lock.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/group/lock.yml @@ -178,5 +178,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource group locks. diff --git a/2020-09-01-hybrid/docs-ref-autogen/iot/du/account.yml b/2020-09-01-hybrid/docs-ref-autogen/iot/du/account.yml index bb80295b1a..60982b150f 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/iot/du/account.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/iot/du/account.yml @@ -43,7 +43,7 @@ directCommands: Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor. syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount - summary: |- - Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-seperated) with a custom specified role. + Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role. syntax: >- az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1 /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2 diff --git a/2020-09-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml b/2020-09-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml index 9c24473ee3..ffe8446d6a 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/iot/hub/device-identity/children.yml @@ -114,7 +114,7 @@ directCommands: [--resource-group] examples: - summary: |- - Remove a space-seperated list of child devices from a target parent device. + Remove a space-separated list of child devices from a target parent device. syntax: az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name} - summary: |- Remove all child devices from a target parent device. diff --git a/2020-09-01-hybrid/docs-ref-autogen/lock.yml b/2020-09-01-hybrid/docs-ref-autogen/lock.yml index eda6357072..16bc620028 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/lock.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/lock.yml @@ -284,5 +284,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure locks. diff --git a/2020-09-01-hybrid/docs-ref-autogen/managedapp.yml b/2020-09-01-hybrid/docs-ref-autogen/managedapp.yml index eda87aefc3..796ed5b7a6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/managedapp.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/managedapp.yml @@ -187,5 +187,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage template solutions provided and maintained by Independent Software Vendors (ISVs). diff --git a/2020-09-01-hybrid/docs-ref-autogen/managedapp/definition.yml b/2020-09-01-hybrid/docs-ref-autogen/managedapp/definition.yml index 4bf603ef13..bff48d2565 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/managedapp/definition.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/managedapp/definition.yml @@ -272,5 +272,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Managed Applications. diff --git a/2020-09-01-hybrid/docs-ref-autogen/policy.yml b/2020-09-01-hybrid/docs-ref-autogen/policy.yml index 0c984b3d74..b8ac9b4150 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/policy.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/policy.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policies. diff --git a/2020-09-01-hybrid/docs-ref-autogen/policy/assignment.yml b/2020-09-01-hybrid/docs-ref-autogen/policy/assignment.yml index 751eee6c86..9c8344043e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/policy/assignment.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/policy/assignment.yml @@ -224,5 +224,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy assignments. diff --git a/2020-09-01-hybrid/docs-ref-autogen/policy/definition.yml b/2020-09-01-hybrid/docs-ref-autogen/policy/definition.yml index e0eb4690e8..72abf35404 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/policy/definition.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/policy/definition.yml @@ -232,5 +232,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy definitions. diff --git a/2020-09-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml b/2020-09-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml index 9ab9816d44..52b1b32df5 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -21,22 +21,20 @@ directCommands: previewOrExperimentalInfo: "Command group 'postgres server-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az postgres server-arc endpoint list --name - [--k8s-namespace] + az postgres server-arc endpoint list [--k8s-namespace] + [--name] [--use-k8s] examples: - summary: |- List Azure Arc enabled PostgreSQL server endpoints. syntax: az postgres server-arc endpoint list --name postgres01 --k8s-namespace namespace --use-k8s - requiredParameters: - - isRequired: true - name: --name -n - summary: |- - Name of the Azure Arc enabled PostgreSQL server. optionalParameters: - name: --k8s-namespace -k summary: |- The Kubernetes namespace where the Azure Arc enabled PostgreSQL server is deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used. + - name: --name -n + summary: |- + Name of the Azure Arc enabled PostgreSQL server. - name: --use-k8s summary: |- Use local Kubernetes APIs to perform this action. diff --git a/2020-09-01-hybrid/docs-ref-autogen/provider.yml b/2020-09-01-hybrid/docs-ref-autogen/provider.yml index 5898a00528..cd5a602cb6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/provider.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/provider.yml @@ -139,5 +139,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource providers. diff --git a/2020-09-01-hybrid/docs-ref-autogen/provider/operation.yml b/2020-09-01-hybrid/docs-ref-autogen/provider/operation.yml index 518ec011a4..6544ce6305 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/provider/operation.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/provider/operation.yml @@ -59,5 +59,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get provider operations metadatas. diff --git a/2020-09-01-hybrid/docs-ref-autogen/provider/permission.yml b/2020-09-01-hybrid/docs-ref-autogen/provider/permission.yml index 95846fb713..b5f93b9261 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/provider/permission.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/provider/permission.yml @@ -46,5 +46,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage permissions for a provider. diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource-mover.yml b/2020-09-01-hybrid/docs-ref-autogen/resource-mover.yml index 3c5aa44f8e..1d9ccf7ffc 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource-mover.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource-mover.yml @@ -4,12 +4,10 @@ name: az resource-mover extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage Resource Mover Service API. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Extension commands: - az_resource-mover_move-collection diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml b/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml index 6b7c846932..dc729bc40b 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-collection.yml @@ -4,31 +4,29 @@ name: az resource-mover move-collection extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-collection. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-collection_bulk-remove(resource-mover) name: az resource-mover move-collection bulk-remove summary: |- - Remove the set of move-resources from move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection bulk-remove [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] [--move-resources] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Remove a move-resource in a move-collection. @@ -40,53 +38,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - Name of the move-collection. + The Move Collection Name. - name: --move-resources summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_commit(resource-mover) name: az resource-mover move-collection commit summary: |- - Commit the set of resources. The commit operation is triggered on the move-resources in the move-state 'CommitPending' or 'CommitFailed', on a successful completion the move-resource's move-state do a transition to Committed. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection commit --move-resources - [--ids] + az resource-mover move-collection commit [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Commit a move-resource. + Commit a move-resource in the move-collection (RegionToRegion) syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Commit resources in the move-collection (RegionToZone) + syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -94,87 +90,100 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_create(resource-mover) name: az resource-mover move-collection create summary: |- - Create a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a move collection. + description: |- + Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- az resource-mover move-collection create --move-collection-name --resource-group [--identity] [--location] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] [--source-region] [--tags] [--target-region] + [--version] examples: - summary: |- - Create a move-collection with system assigned identity. + Create a move-collection with system assigned identity. (RegionToRegion) syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Create a zonal type move-collection with system assigned identity. (RegionToZone) + syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone requiredParameters: - isRequired: true name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + The geo-location where the resource lives. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. - name: --source-region summary: |- - The source region. + Gets or sets the source region. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --target-region summary: |- - The target region. + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_delete(resource-mover) name: az resource-mover move-collection delete summary: |- - Delete a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a move collection. + description: |- + The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection delete [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -188,14 +197,14 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -206,29 +215,24 @@ directCommands: - uid: az_resource-mover_move-collection_discard(resource-mover) name: az resource-mover move-collection discard summary: |- - Discard the set of resources. The discard operation is triggered on the move-resources in the move-state 'CommitPending' or 'DiscardFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection discard --move-resources - [--ids] + az resource-mover move-collection discard [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Discard a remove-resource. syntax: az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -236,50 +240,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_initiate-move(resource-mover) name: az resource-mover move-collection initiate-move summary: |- - Move the set of resources. The move operation is triggered after the move-resources are in the move-state 'MovePending' or 'MoveFailed', on a successful completion the move-resource's move-state do a transition to CommitPending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection initiate-move --move-resources - [--ids] + az resource-mover move-collection initiate-move [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Move the set of resources. + Move the set of resources. (RegionToRegion) syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Move VMs into zonal configuration within the same region (RegionToZone) + syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -287,33 +292,39 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_list(resource-mover) name: az resource-mover move-collection list summary: |- - List details of the move-collections. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List all the Move Collections in the subscription. + description: |- + The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension - syntax: az resource-mover move-collection list [--resource-group] + syntax: >- + az resource-mover move-collection list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all move-collections. @@ -322,94 +333,114 @@ directCommands: List all move-collections by resource group. syntax: az resource-mover move-collection list -g MyResourceGroup optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - uid: az_resource-mover_move-collection_list-required-for(resource-mover) name: az resource-mover move-collection list-required-for summary: |- - List the move-resources for which an arm resource is required for. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List of the move resources for which an arm resource is required for. + description: |- + The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection list-required-for --move-collection-name - --resource-group - --source-id - examples: - - summary: |- - List the move-resources for which an arm resource is required for. - syntax: az resource-mover move-collection list-required-for --name MyMoveCollection --resource-group MyResourceGroup --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/nic1" + az resource-mover move-collection list-required-for --source-id + [--ids] + [--move-collection-name] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true - name: --move-collection-name --name -n + name: --source-id + summary: |- + The sourceId for which the api is invoked. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name --name -n summary: |- The Move Collection Name. - - isRequired: true - name: --resource-group -g + - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --source-id + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --subscription summary: |- - The sourceId for which the api is invoked. + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_list-unresolved-dependency(resource-mover) name: az resource-mover move-collection list-unresolved-dependency summary: |- - List the details of the unresolved dependencies in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Lists a list of unresolved dependencies. + description: |- + The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection list-unresolved-dependency --move-collection-name --resource-group [--dependency-level {Descendant, Direct}] + [--filter] + [--max-items] + [--next-token] + [--orderby] examples: - summary: |- List the unresolved dependencies. syntax: az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --dependency-level parameterValueGroup: "Descendant, Direct" summary: |- - The dependency level. + Defines the dependency level. + - name: --filter + summary: |- + The filter to apply on the operation. For example, $apply=filter(count eq 2). + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. + - name: --orderby + summary: |- + OData order by query option. For example, you can use $orderby=Count desc. - uid: az_resource-mover_move-collection_prepare(resource-mover) name: az resource-mover move-collection prepare summary: |- - Prepare the set of resources. The prepare operation is on the move-resources that are in the move-state 'PreparePending' or 'PrepareFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection prepare --move-resources - [--ids] + az resource-mover move-collection prepare [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Prepare a move-resource. syntax: az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -417,66 +448,72 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_resolve-dependency(resource-mover) name: az resource-mover move-collection resolve-dependency summary: |- - Compute, resolve and validate the dependencies of the move-resources in the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Computes, resolves and validate the dependencies of the moveResources in the move collection. + description: |- + Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection resolve-dependency [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] examples: - summary: |- - Resolve the dependency of the move-resources. + Resolve the dependency of the move-resources. (RegionToRegion) syntax: az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Resolve the dependency of the move-resources. (RegionToZone) + syntax: az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_show(resource-mover) name: az resource-mover move-collection show summary: |- - Get the details of a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the move collection. + description: |- + The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection show [--ids] @@ -493,64 +530,94 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_update(resource-mover) name: az resource-mover move-collection update summary: |- - Update a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Update a move collection. + description: |- + Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection update [--identity] + az resource-mover move-collection update [--add] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--identity] [--ids] [--move-collection-name] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] + [--remove] [--resource-group] + [--set] + [--source-region] [--subscription] [--tags] + [--target-region] + [--version] examples: - summary: |- Update a move-collection. syntax: az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup optionalParameters: + - name: --add + summary: |- + Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --force-string + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. + - name: --remove + summary: |- + Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --set + summary: |- + Update an object by specifying a property path and value to set. Example: --set property1.property2=. + - name: --source-region + summary: |- + Gets or sets the source region. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --target-region + summary: |- + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_wait(resource-mover) name: az resource-mover move-collection wait summary: |- - Place the CLI in a waiting state until a condition of the move-collection is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection wait [--created] @@ -564,13 +631,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully deleted. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --deleted - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully created. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --created optionalParameters: - name: --created defaultValue: "False" @@ -596,10 +656,10 @@ directCommands: Polling interval in seconds. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml b/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml index 3f887cf77d..a1af1c1331 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource-mover/move-resource.yml @@ -4,118 +4,86 @@ name: az resource-mover move-resource extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-resource. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-resource_add(resource-mover) name: az resource-mover move-resource add summary: |- - Create or update a move-resource to the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a Move Resource in the move collection. + description: |- + The 'az resource-mover move-resource add' command remains same for both 'RegionToRegion' (default) and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-resource add --move-collection-name - --move-resource-name - --resource-group - [--depends-on-overrides] + az resource-mover move-resource add [--depends-on-overrides] [--existing-target-id] - [--no-wait] + [--ids] + [--move-collection-name] + [--move-resource-name] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] + [--resource-group] [--resource-settings] [--source-id] + [--subscription] examples: - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings '{ - "resourceType": "Microsoft.Network/virtualNetworks", - "targetResourceName": "MyVNet-target" - }' + Add a vNet as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet\" --resource-settings '{ \"resourceType\": \"Microsoft.Network/virtualNetworks\", \"targetResourceName\": \"MyVNet-target\" }'" - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings @resource-settings.json + Add a VM as a move-resource to the move-collection. (RegionToZone) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyZonalMoveCollection --name MyVMMoveResource --source-id \"/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetResourceName\": \"MyVM\", \"targetAvailabilityZone\": \"2\", \"targetVmSize\": \"Standard_B2s\" }'" - summary: |- - Add a VM as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM" - - --depends-on-overrides id="/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" target-id="/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" - - --resource-settings '{ - "resourceType": "Microsoft.Compute/virtualMachines", - "targetAvailabilitySetId": "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet", - "targetAvailabilityZone": "2", - "targetResourceName": "MyVM-target", - "targetVmSize": null, - "userManagedIdentities": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] - }' - requiredParameters: - - isRequired: true - name: --move-collection-name - summary: |- - The move-collection name. - - isRequired: true - name: --move-resource-name --name -n - summary: |- - The move-resource name. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Add a VM as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM\" --depends-on-overrides id=\"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" target-id=\"/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetAvailabilitySetId\": \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet\", \"targetAvailabilityZone\": \"2\", \"targetResourceName\": \"MyVM-target\", \"targetVmSize\": null, \"userManagedIdentities\": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] }'" optionalParameters: - name: --depends-on-overrides summary: |- - The move-resource dependencies overrides. - description: |- - Usage: --depends-on-overrides id=XX target-id=XX - - id: The ARM ID of the dependent resource. - target-id: The resource ARM ID of either the move-resource or the resource ARM ID of the dependent resource. - - Multiple actions can be specified by using more than one --depends-on-overrides argument. + Gets or sets the move resource dependencies overrides. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --existing-target-id summary: |- - The existing target ARM Id of the resource. + Gets or sets the existing target ARM Id of the resource. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name + summary: |- + The Move Collection Name. + - name: --move-resource-name --name -n + summary: |- + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --resource-settings summary: |- - The resource settings. Expected value: json-string/@json-file. + The resource settings. Expected value: json-string/@json-file. Support json-file and yaml-file. - name: --source-id summary: |- - The Source ARM Id of the resource. + Gets or sets the Source ARM Id of the resource. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_delete(resource-mover) name: az resource-mover move-resource delete summary: |- - Delete a move-resource from the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a Move Resource from the move collection. + description: |- + The 'az resource-mover move-resource delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource delete [--ids] [--move-collection-name] [--move-resource-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -129,17 +97,17 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -150,34 +118,47 @@ directCommands: - uid: az_resource-mover_move-resource_list(resource-mover) name: az resource-mover move-resource list summary: |- - List the move-resources in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List the Move Resources in the move collection. + description: |- + The 'az resource-mover move-resource list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource list --move-collection-name --resource-group + [--filter] + [--max-items] + [--next-token] examples: - summary: |- List the move-resources in a move-collection. syntax: az resource-mover move-resource list --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + optionalParameters: + - name: --filter + summary: |- + The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_resource-mover_move-resource_show(resource-mover) name: az resource-mover move-resource show summary: |- - Get the details of a move-resource. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the Move Resource. + description: |- + The 'az resource-mover move-resource show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource show [--ids] @@ -195,23 +176,21 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_wait(resource-mover) name: az resource-mover move-resource wait summary: |- - Place the CLI in a waiting state until a condition of the move-resource is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource wait [--created] @@ -226,13 +205,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully created. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --created - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully deleted. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --deleted optionalParameters: - name: --created defaultValue: "False" @@ -258,13 +230,13 @@ directCommands: Polling interval in seconds. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource.yml b/2020-09-01-hybrid/docs-ref-autogen/resource.yml index 135aabce03..6b769beb7f 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource.yml @@ -732,5 +732,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resources. diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource/link.yml b/2020-09-01-hybrid/docs-ref-autogen/resource/link.yml index f2b488a62a..6be731ae36 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource/link.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource/link.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Linking is a feature of the Resource Manager. It enables declaring relationships between resources even if they do not reside in the same resource group. Linking has no impact on resource usage, billing, or role-based access. It allows for managing multiple resources across groups as a single unit. diff --git a/2020-09-01-hybrid/docs-ref-autogen/resource/lock.yml b/2020-09-01-hybrid/docs-ref-autogen/resource/lock.yml index 55f2453025..b542c25008 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/resource/lock.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/resource/lock.yml @@ -267,5 +267,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource level locks. diff --git a/2020-09-01-hybrid/docs-ref-autogen/scvmm.yml b/2020-09-01-hybrid/docs-ref-autogen/scvmm.yml index c68bc47dce..d32b42e906 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/scvmm.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/scvmm.yml @@ -52,6 +52,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm.yml b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm.yml index 56f846f67d..452bb2d8c2 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm.yml @@ -22,7 +22,6 @@ directCommands: sourceType: Extension syntax: >- az scvmm vm create --custom-location - --location --name --resource-group [--admin-password] @@ -34,6 +33,7 @@ directCommands: [--dynamic-memory-max] [--dynamic-memory-min] [--inventory-item] + [--location] [--memory-size] [--nic] [--no-wait] @@ -55,10 +55,6 @@ directCommands: name: --custom-location summary: |- Name or ID of the custom location that will manage this resource. - - isRequired: true - name: --location -l - summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - isRequired: true name: --name -n summary: |- @@ -96,6 +92,9 @@ directCommands: - name: --inventory-item -i summary: |- Name or ID of the inventory item. + - name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - name: --memory-size summary: |- Desired memory size in MBs for the vm. @@ -170,13 +169,13 @@ directCommands: previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az scvmm vm delete [--deleteFromHost] + az scvmm vm delete [--delete-from-host] + [--delete-machine] [--force] [--ids] [--name] [--no-wait] [--resource-group] - [--retain] [--subscription] [--yes] examples: @@ -196,12 +195,15 @@ directCommands: Delete the VM from SCVMM syntax: az scvmm vm delete --subscription contoso-sub --resource-group contoso-rg --name contoso-avset --deleteFromHost optionalParameters: - - name: --deleteFromHost + - name: --delete-from-host summary: |- - Delete the VM from the SCVMM. + Delete the VM from the VMware host. + - name: --delete-machine + summary: |- + Delete the parent Microsoft.HybridCompute Machine resource. - name: --force summary: |- - Force the resource to be deleted from azure. + Force delete the azure resource. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -215,9 +217,6 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --retain - summary: |- - Disable the VM from azure but retain the VM in VMM. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -270,8 +269,10 @@ directCommands: name: az scvmm vm list summary: |- Retrieve a list of VMs. - status: Preview + status: Preview and Deprecated + isDeprecated: true isPreview: true + deprecateInfo: This command has been deprecated and will be removed in a future release. Use 'scvmm vm show' instead. previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: az scvmm vm list [--resource-group] @@ -467,7 +468,6 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --skip-shutdown - defaultValue: "False" parameterValueGroup: "false, true" summary: |- Skip shutdown and power-off immediately. @@ -605,6 +605,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml new file mode 100644 index 0000000000..e868aabd26 --- /dev/null +++ b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/extension.yml @@ -0,0 +1,304 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_extension +name: az scvmm vm extension +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Manage vm extension with scvmm. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_extension_create(scvmm) + name: az scvmm vm extension create + summary: |- + The operation to create the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension create --location + --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Create a VM Extension + syntax: az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +- uid: az_scvmm_vm_extension_delete(scvmm) + name: az scvmm vm extension delete + summary: |- + The operation to delete the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension delete [--ids] + [--name] + [--no-wait] + [--resource-group] + [--subscription] + [--vm-name] + [--yes] + examples: + - summary: |- + Delete a VM Extension + syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm where the extension should be deleted. + - name: --yes -y + defaultValue: "False" + summary: |- + Do not prompt for confirmation. +- uid: az_scvmm_vm_extension_list(scvmm) + name: az scvmm vm extension list + summary: |- + The operation to get all extensions of a non-Azure vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension list --resource-group + --vm-name + [--expand] + examples: + - summary: |- + Get all VM Extensions + syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm containing the extension. + optionalParameters: + - name: --expand + summary: |- + The expand expression to apply on the operation. +- uid: az_scvmm_vm_extension_show(scvmm) + name: az scvmm vm extension show + summary: |- + The operation to get the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension show [--ids] + [--name] + [--resource-group] + [--subscription] + [--vm-name] + examples: + - summary: |- + Get VM Extension + syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm containing the extension. +- uid: az_scvmm_vm_extension_update(scvmm) + name: az scvmm vm extension update + summary: |- + The operation to update the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension update --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Update a VM Extension + syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +commands: +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Manage vm extension with scvmm. diff --git a/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml new file mode 100644 index 0000000000..ff7c276ac9 --- /dev/null +++ b/2020-09-01-hybrid/docs-ref-autogen/scvmm/vm/guest-agent.yml @@ -0,0 +1,111 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_guest-agent +name: az scvmm vm guest-agent +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Vm guest agent. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_guest-agent_enable(scvmm) + name: az scvmm vm guest-agent enable + summary: |- + Enable guest agent on the vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent enable --password + --resource-group + --username + --vm-name + [--https-proxy] + [--no-wait] + examples: + - summary: |- + Enable guest agent on the vm + syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass --resource-group contoso-rg --subscription contoso-sub --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --password + summary: |- + Username password credentials to use for connecting to the VM. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --username + summary: |- + Username to use for connecting to the vm. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. + optionalParameters: + - name: --https-proxy + summary: |- + HTTPS proxy server url for the VM. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. +- uid: az_scvmm_vm_guest-agent_show(scvmm) + name: az scvmm vm guest-agent show + summary: |- + Get details of a guest agent by guest agent name, resource-group and vm name. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent show --resource-group + --vm-name + examples: + - summary: |- + Get details of a guest agent + syntax: az scvmm vm guest-agent show --resource-group contoso-rg --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. +commands: +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Vm guest agent. diff --git a/2020-09-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml b/2020-09-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml deleted file mode 100644 index 4a4347faaa..0000000000 --- a/2020-09-01-hybrid/docs-ref-autogen/service-page/Stack HCI VM.yml +++ /dev/null @@ -1,6 +0,0 @@ -### YamlMime:AzureCLIGroup -uid: sp-Stack_HCI_VM -name: Stack HCI VM -commands: -- az_stack-hci-vm -metadata: {} diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml index 7a19d9b2dc..b8f3501d17 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection.yml @@ -38,14 +38,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -55,10 +57,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -90,17 +92,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -132,23 +136,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_list-support-types() name: az spring-cloud connection list-support-types summary: |- @@ -198,23 +204,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_validate() name: az spring-cloud connection validate summary: |- @@ -243,23 +251,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_wait() name: az spring-cloud connection wait summary: |- @@ -289,7 +299,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. @@ -307,7 +317,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -321,10 +333,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml index 789af0ef1a..a36f6ca536 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/create.yml @@ -48,7 +48,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -65,7 +65,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -76,7 +78,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -84,7 +86,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -176,7 +178,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -190,17 +192,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -252,7 +256,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -266,7 +270,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -280,7 +286,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -288,7 +294,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -373,7 +379,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -390,7 +396,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -404,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -412,7 +420,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -496,7 +504,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -513,7 +521,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -524,7 +534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -532,7 +542,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -616,7 +626,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +643,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -644,7 +656,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,7 +664,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +748,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -750,7 +762,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -761,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -769,7 +783,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -852,7 +866,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -866,7 +880,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -880,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -888,7 +904,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -974,7 +990,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -988,7 +1004,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1004,10 +1022,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1088,7 +1106,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1105,7 +1123,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1116,7 +1136,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1134,7 +1154,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1189,7 +1209,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1206,14 +1226,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1231,7 +1253,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1298,7 +1320,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1315,7 +1337,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1331,7 +1355,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1349,7 +1373,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1409,7 +1433,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1426,14 +1450,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1451,7 +1477,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1507,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1524,7 +1550,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1535,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1546,7 +1574,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1596,7 +1624,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1613,14 +1641,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1631,7 +1661,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1685,7 +1715,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1699,7 +1729,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1713,7 +1745,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1721,7 +1753,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1800,7 +1832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1814,7 +1846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1825,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1833,7 +1867,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1911,7 +1945,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1928,7 +1962,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1939,7 +1975,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1957,7 +1993,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2030,7 +2066,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2044,7 +2080,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2060,7 +2098,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2068,7 +2106,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2148,7 +2186,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2162,7 +2200,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2173,7 +2213,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2181,7 +2221,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2242,7 +2282,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2256,7 +2296,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2267,7 +2309,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2275,7 +2317,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2355,7 +2397,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2369,7 +2411,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2380,7 +2424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2388,7 +2432,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2445,7 +2489,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2459,7 +2503,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2470,7 +2516,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2478,7 +2524,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml index 153e6b0b18..2dfdbef869 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring-cloud/connection/update.yml @@ -42,7 +42,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -56,7 +56,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -70,7 +72,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -78,7 +80,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -150,7 +152,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -164,7 +166,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -177,7 +181,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -189,7 +193,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -231,7 +235,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -245,7 +249,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -259,7 +265,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -267,7 +273,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -332,7 +338,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -346,7 +352,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -360,7 +368,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -368,7 +376,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -433,7 +441,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -447,7 +455,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -461,7 +471,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -469,7 +479,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -534,7 +544,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -548,7 +558,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -562,7 +574,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -570,7 +582,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -635,7 +647,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -649,7 +661,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -663,7 +677,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -671,7 +685,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +750,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -750,7 +764,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -764,7 +780,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -772,7 +788,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,7 +852,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -850,7 +866,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -864,10 +882,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -929,7 +947,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -943,7 +961,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -957,7 +977,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -972,7 +992,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1011,7 +1031,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1025,7 +1045,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1035,7 +1057,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1050,7 +1072,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1094,7 +1116,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1108,7 +1130,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1122,7 +1146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1137,7 +1161,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1181,7 +1205,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1195,7 +1219,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1205,7 +1231,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1220,7 +1246,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1260,7 +1286,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1274,7 +1300,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1288,7 +1316,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1296,7 +1324,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1330,7 +1358,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1344,7 +1372,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1354,7 +1384,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1362,7 +1392,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1401,7 +1431,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1415,7 +1445,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1429,7 +1461,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1437,7 +1469,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1501,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1515,7 +1547,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1529,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1537,7 +1571,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1596,7 +1630,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1610,7 +1644,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1624,7 +1660,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1639,7 +1675,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1687,7 +1723,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1701,7 +1737,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1715,7 +1753,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1723,7 +1761,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1785,7 +1823,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1799,7 +1837,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1813,7 +1853,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1821,7 +1861,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1864,7 +1904,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1878,7 +1918,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1892,7 +1934,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1900,7 +1942,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1962,7 +2004,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1976,7 +2018,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1990,7 +2034,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1998,7 +2042,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2040,7 +2084,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2054,7 +2098,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2068,7 +2114,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,7 +2122,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring.yml b/2020-09-01-hybrid/docs-ref-autogen/spring.yml index 485ae7f209..65749e42df 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring.yml @@ -301,6 +301,30 @@ directCommands: - summary: |- List all plans. syntax: az spring list-marketplace-plan -o table +- uid: az_spring_list-support-server-versions(spring) + name: az spring list-support-server-versions + summary: |- + (Standard and Basic Tier Only) List supported server versions. + status: Preview + isPreview: true + previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + sourceType: Extension + syntax: >- + az spring list-support-server-versions --resource-group + --service + examples: + - summary: |- + List supported server versions. + syntax: az spring list-support-server-versions -o table -s MyService -g MyResourceGroup + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. - uid: az_spring_show(spring) name: az spring show summary: |- @@ -566,6 +590,7 @@ commands: - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) - az_spring_config-server - az_spring_config-server_clear(spring) - az_spring_config-server_disable(spring) @@ -675,6 +700,7 @@ commands: - az_spring_gateway_update(spring) - az_spring_list(spring) - az_spring_list-marketplace-plan(spring) +- az_spring_list-support-server-versions(spring) - az_spring_service-registry - az_spring_service-registry_bind(spring) - az_spring_service-registry_create(spring) diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/app.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/app.yml index ab25b24e0f..1cd618bab9 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/app.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/app.yml @@ -415,6 +415,7 @@ directCommands: [--registry-password] [--registry-username] [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}] + [--server-version] [--source-path] [--startup-probe-config] [--target-module] @@ -426,6 +427,9 @@ directCommands: - summary: |- Deploy a pre-built jar to an app with jvm options and environment variables. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar + - summary: |- + Deploy a pre-built war to an app with server version, jvm options and environment variables (Standard and Basic Tiers Only). + syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar - summary: |- Deploy source code to a specific deployment of an app. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path @@ -460,7 +464,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -563,6 +567,9 @@ directCommands: parameterValueGroup: "Java_11, Java_17, Java_8, NetCore_31" summary: |- Runtime version of used language. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --source-path summary: |- Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided. diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/app/deployment.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/app/deployment.yml index dcc3191376..71c8bd02fb 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/app/deployment.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/app/deployment.yml @@ -58,6 +58,7 @@ directCommands: [--scale-rule-metadata] [--scale-rule-name] [--scale-rule-type] + [--server-version] [--skip-clone-settings] [--source-path] [--startup-probe-config] @@ -99,7 +100,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -223,6 +224,9 @@ directCommands: - name: --scale-rule-type --srt summary: |- The type of the scale rule. Default: http. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --skip-clone-settings defaultValue: "False" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml index 13f8eaec64..61a4e22133 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml @@ -28,6 +28,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -35,6 +36,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -80,6 +82,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -102,6 +107,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. @@ -238,6 +247,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -245,6 +255,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -290,6 +301,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -312,6 +326,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/certificate.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/certificate.yml index 5ed4bdbe1d..4c6a781f4d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/certificate.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/certificate.yml @@ -20,6 +20,7 @@ directCommands: az spring certificate add --name --resource-group --service + [--enable-auto-sync {false, true}] [--only-public-cert {false, true}] [--public-certificate-file] [--vault-certificate-name] @@ -42,6 +43,11 @@ directCommands: summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. optionalParameters: + - name: --enable-auto-sync + defaultValue: "False" + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. - name: --only-public-cert defaultValue: "False" parameterValueGroup: "false, true" @@ -157,12 +163,49 @@ directCommands: name: --service -s summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. +- uid: az_spring_certificate_update(spring) + name: az spring certificate update + summary: |- + Update a certificate in Azure Spring Apps. + status: GA + sourceType: Extension + syntax: >- + az spring certificate update --name + --resource-group + --service + [--enable-auto-sync {false, true}] + examples: + - summary: |- + Enable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true + - summary: |- + Disable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false + requiredParameters: + - isRequired: true + name: --name -n + summary: |- + Name of certificate. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. + optionalParameters: + - name: --enable-auto-sync + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. commands: - az_spring_certificate_add(spring) - az_spring_certificate_list(spring) - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) globalParameters: - name: --debug summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/connection.yml index f6c6051669..176dcc3111 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/connection.yml @@ -34,14 +34,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -51,10 +53,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -84,17 +86,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -124,23 +128,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_list-support-types() name: az spring connection list-support-types summary: |- @@ -186,23 +192,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_validate() name: az spring connection validate summary: |- @@ -229,23 +237,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_wait() name: az spring connection wait summary: |- @@ -273,7 +283,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. @@ -291,7 +301,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -305,10 +317,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/connection/create.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/connection/create.yml index a8cb097cd1..29ca0fbf26 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/connection/create.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/connection/create.yml @@ -44,7 +44,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -61,7 +61,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -72,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -80,7 +82,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -170,7 +172,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -184,17 +186,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -244,7 +248,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -258,7 +262,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -272,7 +278,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -280,7 +286,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -363,7 +369,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -380,7 +386,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -394,7 +402,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -402,7 +410,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -484,7 +492,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -501,7 +509,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -512,7 +522,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -520,7 +530,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -602,7 +612,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -619,7 +629,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -630,7 +642,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -638,7 +650,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -720,7 +732,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -734,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -745,7 +759,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -753,7 +767,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -834,7 +848,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -848,7 +862,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -862,7 +878,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -870,7 +886,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -954,7 +970,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -968,7 +984,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -984,10 +1002,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1068,7 +1086,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1085,7 +1103,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1096,7 +1116,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1114,7 +1134,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1167,7 +1187,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1184,14 +1204,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1209,7 +1231,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1276,7 +1298,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1293,7 +1315,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1309,7 +1333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1327,7 +1351,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1385,7 +1409,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1402,14 +1426,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1427,7 +1453,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1481,7 +1507,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1498,7 +1524,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1509,7 +1537,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1520,7 +1548,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1568,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1585,14 +1613,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1603,7 +1633,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1655,7 +1685,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1669,7 +1699,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1683,7 +1715,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1691,7 +1723,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1768,7 +1800,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1782,7 +1814,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1793,7 +1827,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1801,7 +1835,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1877,7 +1911,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1894,7 +1928,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1905,7 +1941,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1923,7 +1959,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1994,7 +2030,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2008,7 +2044,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2024,7 +2062,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2070,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2110,7 +2148,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2124,7 +2162,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2135,7 +2175,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2143,7 +2183,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2202,7 +2242,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2216,7 +2256,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2227,7 +2269,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2235,7 +2277,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2313,7 +2355,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2327,7 +2369,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2338,7 +2382,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2346,7 +2390,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2401,7 +2445,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2415,7 +2459,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2426,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2434,7 +2480,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/spring/connection/update.yml b/2020-09-01-hybrid/docs-ref-autogen/spring/connection/update.yml index 66da61e2e7..1684f816cd 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/spring/connection/update.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/spring/connection/update.yml @@ -38,7 +38,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -52,7 +52,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -66,7 +68,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -74,7 +76,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -144,7 +146,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -158,7 +160,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -171,7 +175,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -183,7 +187,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -223,7 +227,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -237,7 +241,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -251,7 +257,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -259,7 +265,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -322,7 +328,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -336,7 +342,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -350,7 +358,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +366,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -421,7 +429,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -435,7 +443,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -449,7 +459,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -457,7 +467,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -520,7 +530,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -534,7 +544,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -548,7 +560,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -556,7 +568,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -619,7 +631,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +645,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -647,7 +661,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -655,7 +669,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -718,7 +732,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -732,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -746,7 +762,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -754,7 +770,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -816,7 +832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -830,7 +846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -844,10 +862,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -909,7 +927,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -923,7 +941,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -937,7 +957,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -952,7 +972,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -989,7 +1009,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1003,7 +1023,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1013,7 +1035,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1028,7 +1050,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1072,7 +1094,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1086,7 +1108,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1100,7 +1124,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1115,7 +1139,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1157,7 +1181,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1171,7 +1195,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1181,7 +1207,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1196,7 +1222,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1234,7 +1260,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1248,7 +1274,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1262,7 +1290,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1270,7 +1298,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1302,7 +1330,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1316,7 +1344,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1326,7 +1356,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1334,7 +1364,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1371,7 +1401,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1385,7 +1415,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1399,7 +1431,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1407,7 +1439,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1469,7 +1501,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1483,7 +1515,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1497,7 +1531,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1505,7 +1539,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1562,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1576,7 +1610,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1590,7 +1626,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1605,7 +1641,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1651,7 +1687,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1665,7 +1701,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1679,7 +1717,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1687,7 +1725,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1747,7 +1785,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1761,7 +1799,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1775,7 +1815,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1783,7 +1823,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1824,7 +1864,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1838,7 +1878,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1852,7 +1894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1860,7 +1902,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1920,7 +1962,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1934,7 +1976,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1948,7 +1992,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +2000,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1996,7 +2040,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2010,7 +2054,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2024,7 +2070,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2078,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage/blob/directory.yml b/2020-09-01-hybrid/docs-ref-autogen/storage/blob/directory.yml index fd2d12feca..7ea3e81023 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage/blob/directory.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage/blob/directory.yml @@ -573,7 +573,7 @@ directCommands: - isRequired: true name: --destination-path -d summary: |- - The upload destination directory path. It should be an absolute path to container. If the specified destination path does not exist, a new directory path will be created. + The destination path that will be prepended to the blob name. - isRequired: true name: --source -s summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/tag.yml b/2020-09-01-hybrid/docs-ref-autogen/tag.yml index 9046a9a4ec..7bb812cc8f 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/tag.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/tag.yml @@ -216,5 +216,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Tag Management on a resource. diff --git a/2020-09-01-hybrid/docs-ref-autogen/webapp.yml b/2020-09-01-hybrid/docs-ref-autogen/webapp.yml index 839c4b700d..f494bb2847 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/webapp.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/webapp.yml @@ -393,9 +393,7 @@ directCommands: name: az webapp deploy summary: |- Deploys a provided artifact to Azure Web Apps. - status: Preview - isPreview: true - previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + status: GA sourceType: Core syntax: >- az webapp deploy [--async {false, true}] diff --git a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection.yml b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection.yml index 5cb6b4634d..3768e89313 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection.yml @@ -22,6 +22,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--yes] examples: - summary: |- @@ -42,14 +43,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --yes -y defaultValue: "False" summary: |- @@ -63,6 +67,7 @@ directCommands: syntax: >- az webapp connection list [--name] [--resource-group] + [--slot] [--source-id] examples: - summary: |- @@ -77,10 +82,13 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -95,6 +103,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- List a connection's source configurations interactively @@ -114,10 +123,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_list-support-types() name: az webapp connection list-support-types summary: |- @@ -148,6 +160,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Get a connection interactively @@ -167,10 +180,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_validate() name: az webapp connection validate summary: |- @@ -182,6 +198,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Validate a connection interactively @@ -201,10 +218,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_wait() name: az webapp connection wait summary: |- @@ -221,6 +241,7 @@ directCommands: [--interval] [--name] [--resource-group] + [--slot] [--timeout] [--updated] examples: @@ -255,10 +276,13 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --timeout defaultValue: "3600" summary: |- diff --git a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/create.yml b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/create.yml index abe31f256d..58170d03b6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/create.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/create.yml @@ -27,6 +27,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -40,6 +41,9 @@ directCommands: - summary: |- Create a connection between webapp and appconfig with resource name syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --tg AppconfigRG --app-config MyConfigStore --system-identity + - summary: |- + Create a connection between webapp slot and appconfig with resource name + syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --slot MySlot --tg AppconfigRG --app-config MyConfigStore --system-identity - summary: |- Create a connection between webapp and appconfig with resource id syntax: az webapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity @@ -59,7 +63,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -85,6 +89,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -129,6 +136,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--source-id] [--vault-id] examples: @@ -173,14 +181,17 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -206,6 +217,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -219,6 +231,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-cassandra with resource name syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-cassandra with resource name + syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity - summary: |- Create a connection between webapp and cosmos-cassandra with resource id syntax: az webapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity @@ -241,7 +256,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -252,7 +267,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -271,6 +286,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -316,6 +334,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -329,6 +348,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-gremlin with resource name syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-gremlin with resource name + syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity - summary: |- Create a connection between webapp and cosmos-gremlin with resource id syntax: az webapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity @@ -354,7 +376,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -365,7 +387,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -384,6 +406,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -428,6 +453,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -441,6 +467,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-mongo with resource name syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-mongo with resource name + syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-mongo with resource id syntax: az webapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity @@ -463,7 +492,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -474,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -493,6 +522,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -537,6 +569,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -550,6 +583,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-sql with resource name syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-sql with resource name + syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-sql with resource id syntax: az webapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity @@ -572,7 +608,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -583,7 +619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -602,6 +638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -645,6 +684,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--table] @@ -659,6 +699,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-table with resource name syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --table MyTable --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-table with resource name + syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --table MyTable --system-identity - summary: |- Create a connection between webapp and cosmos-table with resource id syntax: az webapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity @@ -678,7 +721,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -689,7 +732,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -708,6 +751,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -754,6 +800,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -767,6 +814,9 @@ directCommands: - summary: |- Create a connection between webapp and eventhub with resource name syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --tg EventhubRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and eventhub with resource name + syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --slot MySlot --tg EventhubRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and eventhub with resource id syntax: az webapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity @@ -783,7 +833,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -797,7 +847,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -816,6 +866,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -858,6 +911,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -872,6 +926,9 @@ directCommands: - summary: |- Create a connection between webapp and keyvault with resource name syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --tg KeyvaultRG --vault MyVault --system-identity + - summary: |- + Create a connection between webapp slot and keyvault with resource name + syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --slot MySlot --tg KeyvaultRG --vault MyVault --system-identity - summary: |- Create a connection between webapp and keyvault with resource id syntax: az webapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity @@ -894,7 +951,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -910,7 +967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -924,6 +981,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -973,6 +1033,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -984,6 +1045,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql with resource name syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql with resource name + syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql with resource id syntax: az webapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1009,7 +1073,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1020,7 +1084,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1040,6 +1104,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1069,6 +1136,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1081,6 +1149,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql-flexible with resource name syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql-flexible with resource name + syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql-flexible with resource id syntax: az webapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1106,14 +1177,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1129,6 +1200,9 @@ directCommands: - name: --server summary: |- Name of the mysql flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1206,14 +1280,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1293,6 +1367,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1305,6 +1380,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres with resource name syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres with resource name + syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres with resource id syntax: az webapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1336,7 +1414,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1352,7 +1430,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1372,6 +1450,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1456,7 +1537,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1472,7 +1553,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1628,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1559,6 +1641,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres-flexible with resource name syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres-flexible with resource name + syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres-flexible with resource id syntax: az webapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1584,14 +1669,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,6 +1692,9 @@ directCommands: - name: --server summary: |- Name of postgres flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1682,14 +1770,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1848,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1771,6 +1860,9 @@ directCommands: - summary: |- Create a connection between webapp and redis with resource name syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis with resource name + syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis with resource id syntax: az webapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret @@ -1790,7 +1882,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1801,7 +1893,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1810,6 +1902,9 @@ directCommands: - name: --server summary: |- Name of the redis server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1838,6 +1933,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1849,6 +1945,9 @@ directCommands: - summary: |- Create a connection between webapp and redis-enterprise with resource name syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis-enterprise with resource name + syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis-enterprise with resource id syntax: az webapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret @@ -1868,14 +1967,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1884,6 +1983,9 @@ directCommands: - name: --server summary: |- Name of the redis enterprise server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1914,6 +2016,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1927,6 +2030,9 @@ directCommands: - summary: |- Create a connection between webapp and servicebus with resource name syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --tg ServicebusRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and servicebus with resource name + syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --slot MySlot --tg ServicebusRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and servicebus with resource id syntax: az webapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity @@ -1943,7 +2049,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1957,7 +2063,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1976,6 +2082,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2018,6 +2127,7 @@ directCommands: [--secret] [--service-principal] [--signalr] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2031,6 +2141,9 @@ directCommands: - summary: |- Create a connection between webapp and signalr with resource name syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --tg SignalrRG --signalr MySignalR --system-identity + - summary: |- + Create a connection between webapp slot and signalr with resource name + syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --slot MySlot --tg SignalrRG --signalr MySignalR --system-identity - summary: |- Create a connection between webapp and signalr with resource id syntax: az webapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity @@ -2047,7 +2160,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2058,7 +2171,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,6 +2189,9 @@ directCommands: - name: --signalr summary: |- Name of the signalr service. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2120,6 +2236,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2132,6 +2249,9 @@ directCommands: - summary: |- Create a connection between webapp and sql with resource name syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and sql with resource name + syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --slot MySlot --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and sql with resource id syntax: az webapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -2157,7 +2277,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2168,7 +2288,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2188,6 +2308,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2265,7 +2388,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2276,7 +2399,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2353,6 +2476,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2366,6 +2490,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-blob with resource name syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-blob with resource name + syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-blob with resource id syntax: az webapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity @@ -2391,7 +2518,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2407,7 +2534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2426,6 +2553,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2468,6 +2598,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2479,6 +2610,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-file with resource name syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-file with resource name + syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-file with resource id syntax: az webapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret @@ -2498,7 +2632,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2509,7 +2643,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2519,6 +2653,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2549,6 +2686,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2562,6 +2700,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-queue with resource name syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-queue with resource name + syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-queue with resource id syntax: az webapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity @@ -2581,7 +2722,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2592,7 +2733,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2611,6 +2752,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2653,6 +2797,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2664,6 +2809,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-table with resource name syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-table with resource name + syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-table with resource id syntax: az webapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret @@ -2683,7 +2831,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2694,7 +2842,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2704,6 +2852,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2732,6 +2883,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2746,6 +2898,9 @@ directCommands: - summary: |- Create a connection between webapp and webpubsub with resource name syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity + - summary: |- + Create a connection between webapp slot and webpubsub with resource name + syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --slot MySlot --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity - summary: |- Create a connection between webapp and webpubsub with resource id syntax: az webapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity @@ -2762,7 +2917,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2773,7 +2928,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2788,6 +2943,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. diff --git a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/update.yml b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/update.yml index 5e3a0a9a07..5c31692daf 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/update.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/webapp/connection/update.yml @@ -23,6 +23,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -49,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -60,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -75,6 +76,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -110,6 +114,7 @@ directCommands: [--schema-key] [--schema-registry] [--schema-secret] + [--slot] [--source-id] [--vault-id] examples: @@ -149,14 +154,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -166,6 +171,9 @@ directCommands: - name: --schema-secret summary: |- Schema registry API-Key (secret). + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -190,6 +198,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -216,7 +225,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -227,7 +236,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -246,6 +255,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -280,6 +292,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -306,7 +319,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -317,7 +330,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -336,6 +349,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -370,6 +386,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -396,7 +413,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -407,7 +424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -426,6 +443,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -460,6 +480,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -486,7 +507,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -497,7 +518,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -516,6 +537,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -550,6 +574,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -576,7 +601,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -587,7 +612,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -606,6 +631,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -640,6 +668,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -666,7 +695,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -677,7 +706,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -696,6 +725,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -729,6 +761,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -755,7 +788,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -766,7 +799,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -780,6 +813,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -816,6 +852,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -846,7 +883,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -857,7 +894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -874,6 +911,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -893,6 +933,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -924,14 +965,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -944,6 +985,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -974,6 +1018,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1005,7 +1050,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1016,7 +1061,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1033,6 +1078,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1057,6 +1105,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -1088,14 +1137,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1108,6 +1157,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1132,6 +1184,7 @@ directCommands: [--private-endpoint {false, true}] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1156,7 +1209,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1167,12 +1220,15 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1191,6 +1247,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1215,19 +1272,22 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1249,6 +1309,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1275,7 +1336,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1286,7 +1347,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1305,6 +1366,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1338,6 +1402,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1364,7 +1429,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1375,7 +1440,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1390,6 +1455,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1424,6 +1492,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1455,7 +1524,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1466,7 +1535,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1483,6 +1552,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1509,6 +1581,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1535,7 +1608,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1546,7 +1619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1565,6 +1638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1598,6 +1674,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1622,7 +1699,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1633,7 +1710,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1643,6 +1720,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1664,6 +1744,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1690,7 +1771,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1701,7 +1782,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1720,6 +1801,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1753,6 +1837,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1777,7 +1862,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1788,7 +1873,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1798,6 +1883,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1818,6 +1906,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1844,7 +1933,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1855,7 +1944,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1870,6 +1959,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. diff --git a/docs-ref-conceptual/TOC.yml b/docs-ref-conceptual/TOC.yml index 5a242b3aec..c6ec855dd2 100644 --- a/docs-ref-conceptual/TOC.yml +++ b/docs-ref-conceptual/TOC.yml @@ -45,12 +45,23 @@ - name: Run Azure Cloud Shell href: /azure/cloud-shell/quickstart?toc=%2fcli%2fazure%2ftoc.json&bc=%2fcli%2fazure%2fbreadcrumb%2ftoc.json displayName: bash, Powershell - - name: Sign in +- name: Sign in + items: + - name: Sign in overview href: authenticate-azure-cli.md displayName: >- sign in, signin, log in, login, credentials, msi, managed identity, tenant, subscription, region, certificate, service principal, - authenticate + authenticate, WAM + - name: Sign in interactively + href: authenticate-azure-cli-interactively.md + - name: Sign in with a service principal + href: authenticate-azure-cli-service-principal.md + - name: Sign in with a managed identity + href: authenticate-azure-cli-managed-identity.md + - name: Sign in with Web Account Manager + href: authenticate-azure-cli-web-account-manager.md + displayName: WAM - name: What's new items: - name: Overview @@ -159,11 +170,25 @@ - name: Tutorials items: - name: Working with service principals - href: create-an-azure-service-principal-azure-cli.md - displayName: >- - automation, application, web app, script, certificate, sign in, - signin, log in, login, devops, dev ops, itpro, it pro, role, - aad, authentication, authenticate + items: + - name: 1 - Overview and prerequisites + href: ./azure-cli-sp-tutorial-1.md + - name: 2 - Work with Azure service principals with a password + href: ./azure-cli-sp-tutorial-2.md + - name: 3 - Work with Azure service principals with a certificate + href: ./azure-cli-sp-tutorial-3.md + - name: 4 - Get an existing service principal + href: ./azure-cli-sp-tutorial-4.md + - name: 5 - Manage service principal roles + href: ./azure-cli-sp-tutorial-5.md + - name: 6 - Create a resource using service principal + href: ./azure-cli-sp-tutorial-6.md + - name: 7 - Reset service principal + href: ./azure-cli-sp-tutorial-7.md + - name: 8 - Cleanup + href: ./azure-cli-sp-tutorial-8.md + - name: 9 - Summary + href: ./azure-cli-sp-tutorial-9.md - name: Create virtual machines items: - name: 1 - Overview and prerequisites @@ -187,7 +212,15 @@ items: - name: List A - Z href: samples-index.md - displayName: list of samples, samples list, A to Z + displayName: >- + list of samples, samples list, A to Z + , acr, aks, appconfig, appservice, batch, cdn, cosmosdb + , deployment, devops, disk, disk-encryption-set, eventgrid + , extension, functionapp, hdinsight, iot, keyvault, lab + , lock, logic, mariadb, ml, monitor, mysql, network + , pipelines, postgres, provider, redis, resource + , rest, role, sf, signalr, snapshot, sql, storage + , vm, vmss, webapp - name: Batch href: https://github.com/Azure-Samples/azure-cli-samples/tree/master/batch displayName: script, commands diff --git a/docs-ref-conceptual/authenticate-azure-cli-interactively.md b/docs-ref-conceptual/authenticate-azure-cli-interactively.md new file mode 100644 index 0000000000..e8acd5e933 --- /dev/null +++ b/docs-ref-conceptual/authenticate-azure-cli-interactively.md @@ -0,0 +1,69 @@ +--- +title: Sign in with Azure CLI interactively at a command line | Microsoft Docs +description: Learn how to sign into the Azure CIL interactively using az login +author: jiasli +ms.author: jiasli +manager: yonzhan +ms.date: 09/22/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: az login, authentication types , authentication methods, azure, cli login, az login powershell, cli login, sign in +--- + +# Sign in interactively + +The Azure CLI's default authentication method for logins uses a web browser and access token to sign in. + +[!INCLUDE [interactive_login](includes/interactive-login.md)] + +## Sign in with credentials on the command line + +Provide your Azure user credentials on the command line. Only use this authentication method for learning Azure CLI commands. +Production-level applications should use a service principal or managed identity. + +This approach doesn't work with Microsoft accounts or accounts that have two-factor authentication enabled. +You receive an _interactive authentication is needed_ message. + +```azurecli-interactive +az login --user --password +``` + +> [!IMPORTANT] +> If you want to avoid displaying your password on console and are using `az login` interactively, +> use the `read -s` command under `bash`. +> +> ```bash +> read -sp "Azure password: " AZ_PASS && echo && az login -u -p $AZ_PASS +> ``` +> +> Under PowerShell, use the `Get-Credential` cmdlet. +> +> ```powershell +> $AzCred = Get-Credential -UserName +> az login -u $AzCred.UserName -p $AzCred.GetNetworkCredential().Password +> ``` + +## Sign in with a different tenant + +You can select a tenant to sign in under with the `--tenant` argument. The value of this argument can either be an `.onmicrosoft.com` domain or the Azure object ID for the tenant. Both interactive and command-line sign-in methods work with `--tenant`. + +```azurecli-interactive +az login --tenant 00000000-0000-0000-0000-000000000000 +``` + +After signing in, if you want to change your active tenant, see [How-to change your active tenant](manage-azure-subscriptions-azure-cli.md#change-the-active-tenant). + +## Troubleshooting + +When your default browser is Microsoft Edge, you might encounter the following error when attempting +to sign in to Azure interactively with `az login`: "_The connection for this site is not +secure._" To resolve this issue, visit [edge://net-internals/#hsts](edge://net-internals/#hsts) in +Microsoft Edge. Add `localhost` under "_Delete domain security policy_" and select Delete. + +## See also + +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* [Manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) diff --git a/docs-ref-conceptual/authenticate-azure-cli-managed-identity.md b/docs-ref-conceptual/authenticate-azure-cli-managed-identity.md new file mode 100644 index 0000000000..601c487cca --- /dev/null +++ b/docs-ref-conceptual/authenticate-azure-cli-managed-identity.md @@ -0,0 +1,45 @@ +--- +title: Sign in with Azure CLI using a managed identity | Microsoft Docs +description: Learn how to sign into the Azure CIL with managed identity +author: jiasli +ms.author: jiasli +manager: yonzhan +ms.date: 09/22/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: az login, authentication types , authentication methods, azure, cli login, az login powershell, cli login, sign in +--- + +# Sign in with a managed identity + +On resources configured for managed identities for Azure resources, you can sign in using the managed identity. +Here are some of the benefits of using managed identities: + +* You don't need to manage credentials. Credentials aren’t even accessible to you. +* You can use managed identities to authenticate to any resource that supports Azure AD authentication, including your own applications. +* Managed identities can be used at no extra cost. + +Signing in with the resource's identity is done through the `--identity` flag. + +```azurecli-interactive +az login --identity +``` + +If the resource has multiple user assigned managed identities and no system assigned identity, you must specify the client ID or object ID or resource ID of the user assigned managed identity with `--username` for login. + +```azurecli-interactive +az login --identity --username +``` + +To learn more about managed identities for Azure resources, see [Configure managed identities for Azure resources](/azure/active-directory/managed-identities-azure-resources/qs-configure-cli-windows-vm). Here are more articles showing the use of the `--identity` parameter. + +* [How to use managed identities for Azure resources on an Azure VM for sign-in](/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-sign-in). +* [Use an Azure managed identity to authenticate to an Azure container registry](/azure/container-registry/container-registry-authentication-managed-identity?tabs=azure-cli) + +## See also + +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* [Manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) diff --git a/docs-ref-conceptual/authenticate-azure-cli-service-principal.md b/docs-ref-conceptual/authenticate-azure-cli-service-principal.md new file mode 100644 index 0000000000..5841f52cd5 --- /dev/null +++ b/docs-ref-conceptual/authenticate-azure-cli-service-principal.md @@ -0,0 +1,59 @@ +--- +title: Sign in with Azure CLI using a service principal | Microsoft Docs +description: Learn how to sign into the Azure CIL using a service principal +author: jiasli +ms.author: jiasli +manager: yonzhan +ms.date: 09/22/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: az login, authentication types , authentication methods, azure, cli login, az login powershell, cli login, sign in +--- + +# Sign in with a service principal + +Service principals are accounts not tied to any particular user, which can have permissions on them assigned through +predefined roles. Authenticating with a service principal is the best way to write secure scripts or programs, +allowing you to apply both permissions restrictions and locally stored static credential information. To learn more +about service principals, see [Working with Azure service principals using the Azure CLI](./create-an-azure-service-principal-azure-cli.md#4-sign-in-using-a-service-principal). + +To sign in with a service principal, you need: + +* The URL or name associated with the service principal +* The service principal password, or the X509 certificate used to create the service principal in PEM format +* The tenant associated with the service principal, as either an `.onmicrosoft.com` domain or Azure object ID + +Note two important facts when working with service principals and the Azure CLI: + +* A **CERTIFICATE** must be appended to the **PRIVATE KEY** within a PEM file. For an example of a PEM file format, see [Certificate-based authentication](./create-an-azure-service-principal-azure-cli.md#certificate-based-authentication). + +* If your service principal uses a certificate that is stored in Key Vault, that certificate's private key must be available without signing in to Azure. To retrieve the certificate for `az login`, see [Retrieve certificate from Key Vault](./create-an-azure-service-principal-azure-cli.md#retrieve-certificate-from-key-vault). + +```azurecli-interactive +az login --service-principal -u -p --tenant +``` + +> [!IMPORTANT] +> If you want to avoid displaying your password on console and are using `az login` interactively, +> use the `read -s` command under `bash`. +> +> ```bash +> read -sp "Azure password: " AZ_PASS && echo && az login --service-principal -u -p $AZ_PASS --tenant +> ``` +> +> Under PowerShell, use the `Get-Credential` cmdlet. +> +> ```powershell +> $AzCred = Get-Credential -UserName +> az login --service-principal -u $AzCred.UserName -p $AzCred.GetNetworkCredential().Password --tenant +> ``` + +For more information on PEN file formats, see [Working with service principals](./create-an-azure-service-principal-azure-cli.md#certificate-based-authentication). + +## See also + +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* [Manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) diff --git a/docs-ref-conceptual/authenticate-azure-cli-web-account-manager.md b/docs-ref-conceptual/authenticate-azure-cli-web-account-manager.md new file mode 100644 index 0000000000..781a5d4b5f --- /dev/null +++ b/docs-ref-conceptual/authenticate-azure-cli-web-account-manager.md @@ -0,0 +1,43 @@ +--- +title: Sign in with Azure CLI using web account manager (WAM) | Microsoft Docs +description: Learn how to sign into the Azure CIL using web account manager (WAM) +author: jiasli +ms.author: jiasli +manager: yonzhan +ms.date: 09/22/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: az login, authentication types , authentication methods, azure, cli login, az login powershell, cli login, sign in +--- + +# Sign in with Web Account Manager (WAM) + +The Azure CLI now offers preview support for Web Account Manager (WAM). WAM is a Windows 10+ component that acts as an authentication broker. (An authentication broker is an application that runs on a user’s machine that manages the authentication handshakes and token maintenance for connected accounts.) + +Using WAM has several benefits: + +* Enhanced security. See [Conditional Access: Token protection (preview)](/azure/active-directory/conditional-access/concept-token-protection). +* Support for Windows Hello, conditional access policies, and FIDO keys. +* Streamlined single sign-on. +* Bug fixes and enhancements shipped with Windows. + +Signing in with WAM is a preview, opt-in feature. Once enabled, the previous browser-based user interface is replaced. + +```azurecli-interactive +az config set core.allow_broker=true +az account clear +az login +``` + +At the current stage of development, there are a few known limitations to WAM: + +* WAM is available on Windows 10 and later, and on Windows Server 2019 and later. On Mac, Linux, and earlier versions of Windows, the Azure CLI automatically defaults to a browser. +* Microsoft Accounts (for example @outlook.com or @live.com) aren't currently supported. We're working with the Microsoft Identity team to bring the support later. + +## See also + +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* [Manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) diff --git a/docs-ref-conceptual/authenticate-azure-cli.md b/docs-ref-conceptual/authenticate-azure-cli.md index afb11b432b..ced7aea2b1 100644 --- a/docs-ref-conceptual/authenticate-azure-cli.md +++ b/docs-ref-conceptual/authenticate-azure-cli.md @@ -4,7 +4,7 @@ description: Learn the different authentication types for your Azure CLI login author: jiasli ms.author: jiasli manager: yonzhan -ms.date: 08/1/2023 +ms.date: 09/22/2023 ms.topic: conceptual ms.service: azure-cli ms.tool: azure-cli @@ -14,22 +14,25 @@ keywords: az login, authentication types , authentication methods, azure, cli lo # Sign in with Azure CLI -There are several authentication types for the Azure Command-Line Interface (CLI), so how do you sign in? The easiest way to get started is with [Azure Cloud Shell](/azure/cloud-shell/overview), which automatically logs you in. -Locally, you can sign in interactively through your browser with the [az login](/cli/azure/reference-index#az-login) command. When you write scripts, the recommended approach is -to use service principals. By granting just the appropriate permissions needed to a service principal, you can keep your automation secure. +The Azure CLI supports several authentication methods. Restrict sign-in permissions for your use case to keep your Azure resources secure. -When signing in with a user account, Azure CLI generates and stores an [authentication refresh token](/azure/active-directory/develop/v1-id-and-access-tokens#refresh-tokens). For more information on refresh and session token configuration, see [Refresh and session token lifetime policy properties](/azure/active-directory/develop/configurable-token-lifetimes#refresh-and-session-token-lifetime-policy-properties). +## Authentication methods -After you sign in, CLI commands are run against your default subscription. If you have multiple subscriptions, you can [change your default subscription](manage-azure-subscriptions-azure-cli.md). +There are five authentication options when working with the Azure CIL: -> [!Note] -> Depending on your signing in method, your tenant may have Conditional Access policies that restrict your access to certain resources. +| Authentication method | Advantage | +|-|-| +| [Azure Cloud Shell](/azure/cloud-shell/overview) | Azure Cloud Shell automatically logs you in, so this is the easiest way to get started. +| [Sign in interactively](./authenticate-azure-cli-interactively.md) | This is a good option when learning Azure CLI commands and running the Azure CLI locally. Log in through your browser with the [az login](/cli/azure/reference-index#az-login) command. +| [Sign in using a service principal](./authenticate-azure-cli-service-principal.md) | When you write scripts, using a service principal is the recommended approach. You grant just the appropriate permissions needed to a service principal keeping your automation secure. +| [Sign in with a managed identity](./authenticate-azure-cli-managed-identity.md) | A common challenge for developers is the management of secrets, credentials, certificates, and keys used to secure communication between services. Using a managed identity eliminates the need for you to manage these credentials. +| [Sign in using Web Account Manager (WAM)](./authenticate-azure-cli-web-account-manager.md) | WAM is a Windows 10+ component that acts as an authentication broker. WAM provides enhanced security and enhancements are shipped with Windows. -## Sign in interactively +## Find or change your current subscription -The Azure CLI's default authentication method for logins uses a web browser and access token to sign in. +After you sign in, CLI commands are run against your default subscription. If you have multiple subscriptions, you can change your default subscription using `az account set --subscription`. To learn more about managing Azure subscriptions, see [How to manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md). -[!INCLUDE [interactive_login](includes/interactive-login.md)] +## Refresh tokens ## Sign in with credentials on the command line @@ -62,7 +65,7 @@ az login -u -p Service principals are accounts not tied to any particular user, which can have permissions on them assigned through predefined roles. Authenticating with a service principal is the best way to write secure scripts or programs, allowing you to apply both permissions restrictions and locally stored static credential information. To learn more -about service principals, see [Working with Azure service principals using the Azure CLI](./create-an-azure-service-principal-azure-cli.md#4-sign-in-using-a-service-principal). +about service principals, see [Working with Azure service principals using the Azure CLI](./azure-cli-sp-tutorial-1.md). To sign in with a service principal, you need: @@ -71,11 +74,11 @@ To sign in with a service principal, you need: * The tenant associated with the service principal, as either an `.onmicrosoft.com` domain or Azure object ID > [!NOTE] -> A **CERTIFICATE** must be appended to the **PRIVATE KEY** within a PEM file. For an example of a PEM file format, see [Certificate-based authentication](./create-an-azure-service-principal-azure-cli.md#certificate-based-authentication). +> A **CERTIFICATE** must be appended to the **PRIVATE KEY** within a PEM file. For an example of a PEM file format, see [Certificate-based authentication](./azure-cli-sp-tutorial-5.md). > [!IMPORTANT] > -> If your service principal uses a certificate that is stored in Key Vault, that certificate's private key must be available without signing in to Azure. To retrieve the certificate for `az login`, see [Retrieve certificate from Key Vault](create-an-azure-service-principal-azure-cli.md#retrieve-certificate-from-key-vault). +> If your service principal uses a certificate that is stored in Key Vault, that certificate's private key must be available without signing in to Azure. To retrieve the certificate for `az login`, see [Retrieve certificate from Key Vault](./azure-cli-sp-tutorial-5.md). ```azurecli-interactive az login --service-principal -u -p --tenant @@ -96,7 +99,7 @@ az login --service-principal -u -p --tenant > az login --service-principal -u $AzCred.UserName -p $AzCred.GetNetworkCredential().Password --tenant > ``` -See [Working with service principals](./create-an-azure-service-principal-azure-cli.md#certificate-based-authentication) for more information on PEM file formats. +See [Working with service principals](./azure-cli-sp-tutorial-1.md) for more information on PEM file formats. ## Sign in with a different tenant @@ -145,15 +148,14 @@ At the current stage of development, there are a few known limitations to WAM: - WAM is available on Windows 10 and later, and on Windows Server 2019 and later. On Mac, Linux, and earlier versions of Windows, we automatically fall back to a browser. - Microsoft Accounts (for example @outlook.com or @live.com) aren't supported for the time being. We're working with the Microsoft Identity team to bring the support later. -## Troubleshooting +When you sign in with a user account, Azure CLI generates and stores an authentication refresh token. Because access tokens are valid for only a short period of time, a refresh token is issued at the same time the access token is issued. The client application can then exchange this refresh token for a new access token when needed. For more information on token lifetime and expiration, see [Refresh tokens in the Microsoft identity platform](/azure/active-directory/develop/refresh-tokens). + +> [!NOTE] +> Depending on your sign in method, your tenant may have Conditional Access policies that restrict your access to certain resources. -When your default browser is Microsoft Edge, you might encounter the following error when attempting -to login to Azure interactively with `az login`: "_The connection for this site is not -secure._" To resolve this issue, visit [edge://net-internals/#hsts](edge://net-internals/#hsts) in -Microsoft Edge. Add `localhost` under "_Delete domain security policy_" and click Delete. ## See also -* [How-to change your active tenant](manage-azure-subscriptions-azure-cli.md#change-the-active-tenant) -* [How-to change your active subscription](manage-azure-subscriptions-azure-cli.md#change-the-active-subscription) -* [Learn to use Bash with the Azure CLI](azure-cli-learn-bash.md) +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* [Manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) diff --git a/docs-ref-conceptual/azure-cli-extensions-list.md b/docs-ref-conceptual/azure-cli-extensions-list.md index 85368d3480..acdf83a877 100644 --- a/docs-ref-conceptual/azure-cli-extensions-list.md +++ b/docs-ref-conceptual/azure-cli-extensions-list.md @@ -4,7 +4,7 @@ description: A complete list of officially supported Azure Command-Line Interfac author: haroldrandom ms.author: jianzen manager: yonzhan,yungezz -ms.date: 09/20/2023 +ms.date: 09/28/2023 ms.topic: article ms.service: azure-cli ms.devlang: azure-cli @@ -32,7 +32,7 @@ You will be prompted to install an extension on first use. |[adp](https://github.com/Azure/azure-cli-extensions/tree/main/src/adp) | 2.40.0 | Microsoft Azure Command-Line Tools Adp Extension. | Experimental | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/adp/HISTORY.rst) | |[aem](https://github.com/Azure/azure-cli-extensions) | 2.19.1 | Manage Azure Enhanced Monitoring Extensions for SAP | GA | [0.3.0](https://github.com/Azure/azure-cli-extensions) | |[ai-examples](https://github.com/Azure/azure-cli-extensions/tree/master/src/ai-examples) | 2.2.0 | Add AI powered examples to help content. | Preview | [0.2.5](https://github.com/Azure/azure-cli-extensions/tree/master/src/ai-examples/HISTORY.rst) | -|[aks-preview](https://github.com/Azure/azure-cli-extensions/tree/main/src/aks-preview) | 2.49.0 | Provides a preview for upcoming AKS features | Preview | [0.5.159](https://github.com/Azure/azure-cli-extensions/tree/main/src/aks-preview/HISTORY.rst) | +|[aks-preview](https://github.com/Azure/azure-cli-extensions/tree/main/src/aks-preview) | 2.49.0 | Provides a preview for upcoming AKS features | Preview | [0.5.161](https://github.com/Azure/azure-cli-extensions/tree/main/src/aks-preview/HISTORY.rst) | |[alb](https://github.com/Azure/azure-cli-extensions/tree/main/src/alb) | 2.48.0 | Microsoft Azure Command-Line Tools ALB Extension. | Preview | [0.2.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/alb/HISTORY.rst) | |[alertsmanagement](https://github.com/Azure/azure-cli-extensions/tree/main/src/alertsmanagement) | 2.45.0 | Microsoft Azure Command-Line Tools AlertsManagementClient Extension | Preview | [0.2.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/alertsmanagement/HISTORY.rst) | |[alias](https://github.com/Azure/azure-cli-extensions) | 2.0.50.dev0 | Support for command aliases | Preview | [0.5.2](https://github.com/Azure/azure-cli-extensions) | @@ -50,7 +50,7 @@ You will be prompted to install an extension on first use. |[azure-cli-ml](https://docs.microsoft.com/python/api/overview/azure/ml/?view=azure-ml-py) | 2.3.1 | Microsoft Azure Command-Line Tools AzureML Command Module | GA | [1.41.0](https://docs.microsoft.com/python/api/overview/azure/ml/?view=azure-ml-py/HISTORY.rst) | |[azure-devops](https://github.com/Microsoft/azure-devops-cli-extension) | 2.30.0 | Tools for managing Azure DevOps. | GA | [0.26.0](https://github.com/Microsoft/azure-devops-cli-extension) | |[azure-firewall](https://github.com/Azure/azure-cli-extensions/tree/main/src/azure-firewall) | 2.50.0 | Manage Azure Firewall resources. | GA | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/azure-firewall/HISTORY.rst) | -|[azure-iot](https://github.com/azure/azure-iot-cli-extension) | 2.37.0 | The Azure IoT extension for Azure CLI. | GA | [0.21.5](https://github.com/azure/azure-iot-cli-extension) | +|[azure-iot](https://github.com/azure/azure-iot-cli-extension) | 2.37.0 | The Azure IoT extension for Azure CLI. | GA | [0.22.0](https://github.com/azure/azure-iot-cli-extension) | |[azure-sphere](https://docs.microsoft.com/azure-sphere) | 2.45.0 | Microsoft Azure Command-Line Tools Azure Sphere Extension | Preview | [0.1.4](https://docs.microsoft.com/azure-sphere) | |[azurestackhci](https://github.com/Azure/azure-cli-extensions/tree/master/src/azurestackhci) | 2.15.0 | Microsoft Azure Command-Line Tools AzureStackHCI Extension | Experimental | [0.2.9](https://github.com/Azure/azure-cli-extensions/tree/master/src/azurestackhci) | |[baremetal-infrastructure](https://github.com/Azure/azure-baremetalinfrastructure-cli-extension) | 2.12.0 | Additional commands for working with BareMetal instances. | GA | [1.0.0](https://github.com/Azure/azure-baremetalinfrastructure-cli-extension) | @@ -66,11 +66,11 @@ You will be prompted to install an extension on first use. |[confcom](https://github.com/Azure/azure-cli-extensions/tree/main/src/confcom) | 2.26.2 | Microsoft Azure Command-Line Tools Confidential Container Security Policy Generator Extension | GA | [0.2.16](https://github.com/Azure/azure-cli-extensions/tree/main/src/confcom/HISTORY.rst) | |[confidentialledger](https://github.com/Azure/azure-cli-extensions/tree/main/src/confidentialledger) | 2.15.0 | Microsoft Azure Command-Line Tools ConfidentialLedger Extension | GA | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/confidentialledger/HISTORY.rst) | |[confluent](https://github.com/Azure/azure-cli-extensions/tree/master/src/confluent) | 2.25.0 | Microsoft Azure Command-Line Tools ConfluentManagementClient Extension | Experimental | [0.4.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/confluent/HISTORY.rst) | -|[connectedk8s](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedk8s) | 2.38.0 | Microsoft Azure Command-Line Tools Connectedk8s Extension | GA | [1.4.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedk8s/HISTORY.rst) | +|[connectedk8s](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedk8s) | 2.38.0 | Microsoft Azure Command-Line Tools Connectedk8s Extension | GA | [1.4.2](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedk8s/HISTORY.rst) | |[connectedmachine](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedmachine) | 2.49.0 | Microsoft Azure Command-Line Tools ConnectedMachine Extension | Preview | [0.6.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedmachine/HISTORY.rst) | |[connectedvmware](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedvmware) | 2.0.67 | Microsoft Azure Command-Line Tools Connectedvmware Extension | Preview | [0.2.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/connectedvmware/HISTORY.rst) | |[connection-monitor-preview](https://github.com/Azure/azure-cli-extensions/tree/master/src/connection-monitor-preview) | 2.0.80 | Microsoft Azure Command-Line Connection Monitor V2 Extension | Preview | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/connection-monitor-preview/HISTORY.rst) | -|[containerapp](https://github.com/Azure/azure-cli-extensions/tree/main/src/containerapp) | 2.45.0 | Microsoft Azure Command-Line Tools Containerapp Extension | Preview | [0.3.39](https://github.com/Azure/azure-cli-extensions/tree/main/src/containerapp/HISTORY.rst) | +|[containerapp](https://github.com/Azure/azure-cli-extensions/tree/main/src/containerapp) | 2.45.0 | Microsoft Azure Command-Line Tools Containerapp Extension | Preview | [0.3.41](https://github.com/Azure/azure-cli-extensions/tree/main/src/containerapp/HISTORY.rst) | |[cosmosdb-preview](https://github.com/Azure/azure-cli-extensions/tree/main/src/cosmosdb-preview) | 2.17.1 | Microsoft Azure Command-Line Tools Cosmosdb-preview Extension | Preview | [0.25.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/cosmosdb-preview/HISTORY.rst) | |[costmanagement](https://github.com/Azure/azure-cli-extensions/tree/main/src/costmanagement) | 2.3.1 | Microsoft Azure Command-Line Tools CostManagementClient Extension | GA | [0.2.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/costmanagement/HISTORY.rst) | |[csvmware](https://github.com/Azure/az-vmware-cli) | 2.0.67 | Manage Azure VMware Solution by CloudSimple. | Preview | [0.3.0](https://github.com/Azure/az-vmware-cli) | @@ -81,7 +81,7 @@ You will be prompted to install an extension on first use. |[datadog](https://github.com/Azure/azure-cli-extensions/tree/master/src/datadog) | 2.17.0 | Microsoft Azure Command-Line Tools MicrosoftDatadogClient Extension | Experimental | [0.1.1](https://github.com/Azure/azure-cli-extensions/tree/master/src/datadog/HISTORY.rst) | |[datafactory](https://github.com/Azure/azure-cli-extensions/tree/main/src/datafactory) | 2.15.0 | Microsoft Azure Command-Line Tools DataFactoryManagementClient Extension | GA | [0.7.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/datafactory/HISTORY.rst) | |[datamigration](https://github.com/Azure/azure-cli-extensions/tree/master/src/datamigration) | 2.15.0 | Microsoft Azure Command-Line Tools DataMigrationManagementClient Extension | Experimental | [0.6.1](https://github.com/Azure/azure-cli-extensions/tree/master/src/datamigration/HISTORY.rst) | -|[dataprotection](https://github.com/Azure/azure-cli-extensions/tree/main/src/dataprotection) | 2.51.0 | Microsoft Azure Command-Line Tools DataProtectionClient Extension | Experimental | [0.10.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/dataprotection/HISTORY.rst) | +|[dataprotection](https://github.com/Azure/azure-cli-extensions/tree/main/src/dataprotection) | 2.51.0 | Microsoft Azure Command-Line Tools DataProtectionClient Extension | Experimental | [0.11.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/dataprotection/HISTORY.rst) | |[datashare](https://github.com/Azure/azure-cli-extensions/tree/master/src/datashare) | 2.15.0 | Microsoft Azure Command-Line Tools DataShareManagementClient Extension | Experimental | [0.2.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/datashare/HISTORY.rst) | |[db-up](https://github.com/Azure/azure-cli-extensions/tree/main/src/db-up) | 2.0.46 | Additional commands to simplify Azure Database workflows. | Preview | [0.2.9](https://github.com/Azure/azure-cli-extensions/tree/main/src/db-up/HISTORY.rst) | |[deploy-to-azure](https://github.com/Azure/deploy-to-azure-cli-extension) | 2.0.60 | Deploy to Azure using Github Actions. | Preview | [0.2.0](https://github.com/Azure/deploy-to-azure-cli-extension) | @@ -98,7 +98,7 @@ You will be prompted to install an extension on first use. |[elastic-san](https://github.com/Azure/azure-cli-extensions/tree/master/src/elastic-san) | 2.50.0 | Microsoft Azure Command-Line Tools ElasticSan Extension. | Preview | [1.0.0b1](https://github.com/Azure/azure-cli-extensions/tree/master/src/elastic-san/HISTORY.rst) | |[eventgrid](https://github.com/Azure/azure-cli-extensions) | 2.0.49 | Microsoft Azure Command-Line Tools EventGrid Command Module. | Preview | [0.4.9](https://github.com/Azure/azure-cli-extensions) | |[express-route-cross-connection](https://github.com/Azure/azure-cli-extensions/tree/master/src/express-route-cross-connection) | 2.0.41 | Manage customer ExpressRoute circuits using an ExpressRoute cross-connection. | GA | [0.1.1](https://github.com/Azure/azure-cli-extensions/tree/master/src/express-route-cross-connection) | -|[fleet](https://github.com/Azure/azure-cli-extensions/tree/main/src/fleet) | 2.48.0 | Microsoft Azure Command-Line Tools Fleet Extension | Preview | [0.2.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/fleet/HISTORY.rst) | +|[fleet](https://github.com/Azure/azure-cli-extensions/tree/main/src/fleet) | 2.48.0 | Microsoft Azure Command-Line Tools Fleet Extension | Preview | [0.2.4](https://github.com/Azure/azure-cli-extensions/tree/main/src/fleet/HISTORY.rst) | |[fluid-relay](https://github.com/Azure/azure-cli-extensions/tree/main/src/fluid-relay) | 2.39.0 | Microsoft Azure Command-Line Tools FluidRelay Extension. | GA | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/fluid-relay/HISTORY.rst) | |[footprint](https://github.com/Azure/azure-cli-extensions/tree/master/src/footprint) | 2.11.0 | Microsoft Azure Command-Line Tools FootprintMonitoringManagementClient Extension | Experimental | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/footprint/HISTORY.rst) | |[front-door](https://github.com/Azure/azure-cli-extensions/tree/main/src/front-door) | 2.0.68 | Manage networking Front Doors. | GA | [1.0.17](https://github.com/Azure/azure-cli-extensions/tree/main/src/front-door/HISTORY.rst) | @@ -146,7 +146,7 @@ You will be prompted to install an extension on first use. |[nsp](https://github.com/Azure/azure-cli-extensions/tree/main/src/nsp) | 2.45.0 | Microsoft Azure Command-Line Tools Nsp Extension. | Experimental | [0.2.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/nsp/HISTORY.rst) | |[offazure](https://github.com/Azure/azure-cli-extensions/tree/master/src/offazure) | 2.15.0 | Microsoft Azure Command-Line Tools AzureMigrateV2 Extension | Experimental | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/offazure/HISTORY.rst) | |[orbital](https://github.com/Azure/azure-cli-extensions/tree/main/src/orbital) | 2.39.0 | Microsoft Azure Command-Line Tools Orbital Extension. | GA | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/orbital/HISTORY.rst) | -|[palo-alto-networks](https://github.com/Azure/azure-cli-extensions/tree/main/src/palo-alto-networks) | 2.51.0 | Microsoft Azure Command-Line Tools PaloAltoNetworks Extension. | Preview | [1.1.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/palo-alto-networks/HISTORY.rst) | +|[palo-alto-networks](https://github.com/Azure/azure-cli-extensions/tree/main/src/palo-alto-networks) | 2.51.0 | Microsoft Azure Command-Line Tools PaloAltoNetworks Extension. | Preview | [1.1.1b1](https://github.com/Azure/azure-cli-extensions/tree/main/src/palo-alto-networks/HISTORY.rst) | |[partnercenter](https://github.com/Azure/partnercenter-cli-extension/tree/main/partnercenter) | 2.0.67 | Microsoft Azure CLI Extension for Partner Center | Preview | [0.2.4](https://github.com/Azure/partnercenter-cli-extension/tree/main/partnercenter/HISTORY.rst) | |[peering](https://github.com/Azure/azure-cli-extensions/tree/master/src/peering) | 2.3.1 | Microsoft Azure Command-Line Tools PeeringManagementClient Extension | GA | [0.2.1](https://github.com/Azure/azure-cli-extensions/tree/master/src/peering/HISTORY.rst) | |[portal](https://github.com/Azure/azure-cli-extensions/tree/main/src/portal) | 2.3.1 | Microsoft Azure Command-Line Tools Portal Extension | Experimental | [0.1.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/portal/HISTORY.rst) | @@ -160,19 +160,19 @@ You will be prompted to install an extension on first use. |[redisenterprise](https://github.com/Azure/azure-cli-extensions/tree/main/src/redisenterprise) | 2.45.0 | Microsoft Azure Command-Line Tools RedisEnterprise Extension. | GA | [0.1.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/redisenterprise/HISTORY.rst) | |[reservation](https://github.com/Azure/azure-cli-extensions/tree/main/src/reservation) | 2.50.0 | Microsoft Azure Command-Line Tools Reservation Extension | GA | [0.3.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/reservation/HISTORY.rst) | |[resource-graph](https://github.com/Azure/azure-cli-extensions/tree/master/src/resource-graph) | 2.22.0 | Support for querying Azure resources with Resource Graph. | GA | [2.1.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/resource-graph/HISTORY.rst) | -|[resource-mover](https://github.com/Azure/azure-cli-extensions/tree/master/src/resource-mover) | 2.15.0 | Microsoft Azure Command-Line Tools ResourceMoverServiceAPI Extension | Experimental | [0.1.1](https://github.com/Azure/azure-cli-extensions/tree/master/src/resource-mover/HISTORY.rst) | +|[resource-mover](https://github.com/Azure/azure-cli-extensions/tree/main/src/resource-mover) | 2.50.0 | Microsoft Azure Command-Line Tools ResourceMoverServiceAPI Extension | Preview | [1.0.0b1](https://github.com/Azure/azure-cli-extensions/tree/main/src/resource-mover/HISTORY.rst) | |[sap-hana](https://github.com/Azure/azure-hanaonazure-cli-extension) | 2.0.46 | Additional commands for working with SAP HanaOnAzure instances. | GA | [0.6.5](https://github.com/Azure/azure-hanaonazure-cli-extension) | |[scenario-guide](https://github.com/Azure/azure-cli-extensions/tree/main/src/scenario-guide) | 2.20.0 | Microsoft Azure Command-Line Tools Scenario Guidance Extension | Experimental | [0.1.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/scenario-guide/HISTORY.rst) | |[scheduled-query](https://github.com/Azure/azure-cli-extensions/tree/main/src/scheduled-query) | 2.38.0 | Microsoft Azure Command-Line Tools Scheduled_query Extension | Preview | [0.5.2](https://github.com/Azure/azure-cli-extensions/tree/main/src/scheduled-query/HISTORY.rst) | -|[scvmm](https://github.com/Azure/azure-cli-extensions/tree/main/src/scvmm) | 2.15.0 | Microsoft Azure Command-Line Tools SCVMM Extension | Preview | [0.1.8](https://github.com/Azure/azure-cli-extensions/tree/main/src/scvmm/HISTORY.rst) | +|[scvmm](https://github.com/Azure/azure-cli-extensions/tree/main/src/scvmm) | 2.15.0 | Microsoft Azure Command-Line Tools SCVMM Extension | Preview | [0.2.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/scvmm/HISTORY.rst) | |[self-help](https://github.com/Azure/azure-cli-extensions/tree/main/src/self-help) | 2.45.0 | Microsoft Azure Command-Line Tools SelfHelp Extension. | Preview | [0.1.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/self-help/HISTORY.rst) | |[sentinel](https://github.com/Azure/azure-cli-extensions/tree/main/src/securityinsight) | 2.37.0 | Microsoft Azure Command-Line Tools Sentinel Extension. | Experimental | [0.2.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/securityinsight/HISTORY.rst) | |[serial-console](https://github.com/Azure/azure-cli-extensions/tree/main/src/serial-console) | 2.15.0 | Microsoft Azure Command-Line Tools for Serial Console Extension | Preview | [0.1.6](https://github.com/Azure/azure-cli-extensions/tree/main/src/serial-console/HISTORY.rst) | -|[serviceconnector-passwordless](https://github.com/Azure/azure-cli-extensions/tree/master/src/serviceconnector-passwordless) | 2.46.0 | Microsoft Azure Command-Line Tools Serviceconnector-passwordless Extension | Preview | [0.3.9](https://github.com/Azure/azure-cli-extensions/tree/master/src/serviceconnector-passwordless/HISTORY.rst) | +|[serviceconnector-passwordless](https://github.com/Azure/azure-cli-extensions/tree/master/src/serviceconnector-passwordless) | 2.46.0 | Microsoft Azure Command-Line Tools Serviceconnector-passwordless Extension | Preview | [0.3.11](https://github.com/Azure/azure-cli-extensions/tree/master/src/serviceconnector-passwordless/HISTORY.rst) | |[site-recovery](https://github.com/Azure/azure-cli-extensions/tree/main/src/site-recovery) | 2.51.0 | Microsoft Azure Command-Line Tools SiteRecovery Extension. | Experimental | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/site-recovery/HISTORY.rst) | -|[spring](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring) | 2.45.0 | Microsoft Azure Command-Line Tools spring Extension | GA | [1.14.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring) | +|[spring](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring) | 2.45.0 | Microsoft Azure Command-Line Tools spring Extension | GA | [1.15.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring) | |[spring-cloud](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring-cloud) | 2.45.0 | Microsoft Azure Command-Line Tools spring-cloud Extension | GA | [3.1.8](https://github.com/Azure/azure-cli-extensions/tree/main/src/spring-cloud) | -|[ssh](https://github.com/Azure/azure-cli-extensions/tree/main/src/ssh) | 2.45.0 | SSH into Azure VMs using RBAC and AAD OpenSSH Certificates | GA | [2.0.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/ssh) | +|[ssh](https://github.com/Azure/azure-cli-extensions/tree/main/src/ssh) | 2.45.0 | SSH into Azure VMs using RBAC and AAD OpenSSH Certificates | GA | [2.0.2](https://github.com/Azure/azure-cli-extensions/tree/main/src/ssh) | |[stack-hci](https://github.com/Azure/azure-cli-extensions/tree/main/src/stack-hci) | 2.50.0 | Microsoft Azure Command-Line Tools AzureStackHCIClient Extension | GA | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/stack-hci/HISTORY.rst) | |[stack-hci-vm](https://msazure.visualstudio.com/msk8s/_git/azstackhci-util?version=GBmain) | 2.15.0 | Microsoft Azure Command-Line Tools AzureStackHCIClient Extension | Preview | [0.1.2](https://msazure.visualstudio.com/msk8s/_git/azstackhci-util?version=GBmain/HISTORY.rst) | |[staticwebapp](https://github.com/Azure/azure-cli-extensions/tree/master/src/staticwebapp) | 2.39.0 | Microsoft Azure Command-Line Tools Staticwebapp Extension | Preview | [1.0.0](https://github.com/Azure/azure-cli-extensions/tree/master/src/staticwebapp/HISTORY.rst) | diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-1.md b/docs-ref-conceptual/azure-cli-sp-tutorial-1.md new file mode 100644 index 0000000000..1ebfe74f7b --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-1.md @@ -0,0 +1,48 @@ +--- +title: Work with Azure service principals – Azure CLI | Microsoft Docs +description: Learn how to create and use service principals with the Azure CLI. Use service principals to gain control over which Azure resources can be accessed. +manager: jasongroce +author: dbradish-microsoft +ms.author: dbradish +ms.date: 08/2/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- +# 1 - Work with Azure service principal using the Azure CLI + +Automated tools that use Azure services should always have restricted permissions, to ensure that your resources will be secure. Therefore, instead of having applications sign in as a fully privileged user, Azure offers service principals. + +## Overview and Prerequisites + +An Azure service principal is an identity created for use with applications, hosted services, and automated tools, to access resources. For security reasons, it's always recommended to use service principals with automated tools rather than allowing them to sign in with a user identity. + +In this tutorial, you'll learn how to use service principals with either password-based or certificate-based authentication in order to create a resource. The roles assigned to the service principal restrict access, which gives you control over which resources can be accessed and at what level. + +This tutorial can be completed with the interactive experience offered through Azure Cloud Shell, or you may [install the CLI](install-azure-cli.md) +locally. + +To create a service principal in Azure, you must have sufficient permissions to register an application with your Azure Active Directory tenant, and assign a role to the application in your Azure subscription. In order to do so, you require `Application.ReadWrite.All` permission. + +[!INCLUDE [include](~/articles/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)] + +Create an Azure service principal with the [az ad sp create-for-rbac](/cli/azure/ad/sp#az_ad_sp_create_for_rbac) command. + +The `appId` and `tenant` keys appear in the output of `az ad sp create-for-rbac` and are used in service principal authentication. Record their values, but they can be retrieved at any point with [az ad sp list](/cli/azure/ad/sp#az-ad-sp-list). + +When creating a service principal, you choose the type of sign-in authentication it uses. There are two types of authentication available for Azure service principals: [password-based authentication](./azure-cli-sp-tutorial-4.md), and [certificate-based authentication](./azure-cli-sp-tutorial-5.md). We recommend using certificate-based authentication due to the security restrictions that password-based authentication has. To learn more about why certificate-based authentication is more secure, see the [benefits](/azure/active-directory/authentication/) that it provides, as opposed to password-based authentication. + +> [!WARNING] +> When you create an Azure service principal using the `az ad sp create-for-rbac` command, 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](/azure/active-directory/managed-identities-azure-resources/overview) if available to avoid the need to use credentials. +> +> To reduce your risk of a compromised service principal, assign a more specific role and narrow the scopes to a resource or resource group. See [Steps to add a role assignment](/azure/role-based-access-control/role-assignments-steps) for more information. + + +## Next Steps + +Now that you've learned how to create an Azure service principal, proceed to the next step to learn how to use service principals with password-based authentication. + +> [!div class="nextstepaction"] +> [Work with service principals using a password](./azure-cli-sp-tutorial-2.md) diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-2.md b/docs-ref-conceptual/azure-cli-sp-tutorial-2.md new file mode 100644 index 0000000000..989246c4a0 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-2.md @@ -0,0 +1,96 @@ +--- +title: Work with Azure service principals using a password – Azure CLI | Microsoft Docs +description: Use service principals with a password to gain control over which Azure resources can be accessed. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 2 - Create a service principal using password-based authentication + +When creating a [Service Principal](./azure-cli-sp-tutorial-1.md), you can choose either password-based or [certificate based-authentication](./azure-cli-sp-tutorial-5.md). This article details how you can use a **password** with the service principal to access the Azure Container Registry. + +### How does password-based authentication work? + +With password-based authentication, a random password is created for you. If you don't specify a `--name` parameter value, a name containing a time stamp is created for you. You must specify a `--scopes` as this value doesn't have a default. If you prefer, you can set the role assignment later by using [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create). + +```azurecli-interactive + +# Create a service principal for a resource group using a preferred name and role +az ad sp create-for-rbac --name myServicePrincipalName \ + --role reader \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName +``` + +You can also create a service principal using variables: + +```azurecli-interactive +let "randomIdentifier=$RANDOM*$RANDOM" +servicePrincipalName="msdocs-sp-$randomIdentifier" +roleName="azureRoleName" +subscriptionID=$(az account show --query id -o tsv) +# Verify the ID of the active subscription +echo "Using subscription ID $subscriptionID" +resourceGroup="myResourceGroupName" + +echo "Creating SP for RBAC with name $servicePrincipalName, with role $roleName and in scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup" +az ad sp create-for-rbac --name $servicePrincipalName --role $roleName --scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup +``` + +Output Console: + +``` +{ + "appId": "myAppId", + "displayName": "myDisplayName", + "password": "myPassword", + "tenant": "myTentantId" +} + +``` + +The output for a service principal with password authentication includes the `password` key. __Make sure you copy this value__ - it can't be retrieved. If you lose the password, [reset the service principal credentials](./azure-cli-sp-tutorial-7.md). + +### Sign in with a service principal using a password + +You can test the new service principal's credentials and permissions by signing in. To sign in with a service principal, you need the `appId`, `tenant`, and credentials. + +To learn more about signing in with a service principal, see [Sign in with the Azure CLI](authenticate-azure-cli.md). + +To sign in with a service principal using a password: + +> [!IMPORTANT] +> Make sure to use the same password key you received as the output for the service principal in the previous step + +```azurecli-interactive +az login --service-principal --username appID --password PASSWORD --tenant tenantID +``` + +> [!IMPORTANT] +> If you want to avoid displaying your password on console and are using `az login` interactively, +> use the `read -s` command under `bash`. +> +> ```bash +> read -sp "Azure password: " AZ_PASS && echo && az login --service-principal -u -p $AZ_PASS --tenant +> ``` +> +> Under PowerShell, use the `Get-Credential` cmdlet. +> +> ```powershell +> $AzCred = Get-Credential -UserName +> az login --service-principal -u $AzCred.UserName -p $AzCred.GetNetworkCredential().Password --tenant +> ``` + + +## Next Steps + +Now that you've learned how to work with service principals using a password, proceed to the next step to learn how to use service principals with certificate-based authentication. + +> [!div class="nextstepaction"] +> [Work with service principals using a certificate](./azure-cli-sp-tutorial-3.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-3.md b/docs-ref-conceptual/azure-cli-sp-tutorial-3.md new file mode 100644 index 0000000000..10504468b1 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-3.md @@ -0,0 +1,192 @@ +--- +title: Work with Azure service principals using a certificate – Azure CLI | Microsoft Docs +description: Use service principals with an existing certificate to gain control over which Azure resources can be accessed. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 08/16/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 3 - Create a service principal using certificate-based authentication + +When creating a [Service Principal](./azure-cli-sp-tutorial-1.md), you can choose the either password-based or certificate based-authentication. This article details how you can use an existing **certificate** with the service principal to access the Azure Container Registry. + +## Why use certificate-based authentication? + +We recommend using certificate-based authentication due to the security considerations that password authentication has. Certificate-based authentication enables you to adopt a phishing resistant authentication, by using [conditional access policies](/azure/active-directory/conditional-access/overview), which better protects the user's assets. + +To learn more about why and how certificate based authentication is more secure, see [Azure Active Directory certificate based authentication concepts](/azure/active-directory/authentication/concept-certificate-based-authentication). + +## How do I add certificates to a Service Principal? + +We recommend you use Azure CLI to perform certificate-based authentication, however there is also a way to manually assign an existing certificate to a service principal through the Azure portal: + +# [Azure CLI](#tab/concepts) + +For certificate-based authentication, use the `--cert` parameter. This parameter requires that you hold an existing certificate. Make sure any tool that uses this service principal has access to the certificate's private key. Certificates should be in an ASCII format such as PEM, CER, or DER. Pass the certi897ficate as a string, or use the `@path` format to load the certificate from a file. + +> [!NOTE] +> When using a PEM file, the **CERTIFICATE** must be appended to the **PRIVATE KEY** within the file. +```azurecli-interactive +az ad sp create-for-rbac --name myServicePrincipalName \ + --role roleName \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ + --cert "-----BEGIN CERTIFICATE----- +... +-----END CERTIFICATE-----" +``` + +```azurecli-interactive +az ad sp create-for-rbac --name myServicePrincipalName \ + --role roleName \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ + --cert @/path/to/cert.pem +``` + +The `--keyvault` parameter can be added to use a certificate in Azure Key Vault. In this case, the `--cert` value is the name of the certificate. + +```azurecli-interactive +az ad sp create-for-rbac --name myServicePrincipalName \ + --role roleName \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ + --cert certificateName \ + --keyvault vaultName +``` + +To create a _self-signed_ certificate for authentication, use the `--create-cert` parameter: + +```azurecli-interactive +az ad sp create-for-rbac --name myServicePrincipalName \ + --role roleName \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ + --create-cert +``` + +You can use `--append ` to assign multiple certificates to a service principal: + +```azurecli-interactive +az ad sp credential reset --append \ + --name myServicePrincipalName \ + --cert @/path/to/cert.pem +``` + +Console output: + +``` +Creating a role assignment under the scopes of "/subscriptions/myId" +Please copy C:\myPath\myNewFile.pem to a safe place. +When you run 'az login', provide the file path in the --password parameter +{ + "appId": "myAppId", + "displayName": "myDisplayName", + "fileWithCertAndPrivateKey": "C:\\myPath\\myNewFile.pem", + "name": "http://myName", + "password": null, + "tenant": "myTenantId" +} +``` + +Contents of the new PEM file: +``` +-----BEGIN PRIVATE KEY----- +myPrivateKeyValue +-----END PRIVATE KEY----- +-----BEGIN CERTIFICATE----- +myCertificateValue +-----END CERTIFICATE----- +``` + +> [!NOTE] +> The `az ad sp create-for-rbac --create-cert` command creates the service principal and a PEM file. The PEM file contains a correctly formatted **PRIVATE KEY** and **CERTIFICATE**. +The `--keyvault` parameter can be added to store the certificate in Azure Key Vault. When you use `--keyvault`, the `--cert` parameter is __required__. + +```azurecli-interactive +az ad sp create-for-rbac --name myServicePrincipalName \ + --role roleName \ + --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ + --create-cert \ + --cert certificateName \ + --keyvault vaultName +``` + +Unless you store the certificate in Key Vault, the output includes the `fileWithCertAndPrivateKey` key. This key's value tells you where the generated certificate is stored. +__Make sure__ that you copy the certificate to a secure location, or you can't sign in with this service principal. + +If you lose access to a certificate's private key, [reset the service principal credentials](./azure-cli-sp-tutorial-7.md). + +## Retrieve certificate from Key Vault + +For a certificate stored in Key Vault, retrieve the certificate with its private key with [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show) and convert it to a PEM file. In the Key Vault, the name of the certificate's secret is the same as the certificate name. + +```azurecli-interactive +az keyvault secret download --file /path/to/cert.pfx --vault-name VaultName --name CertName --encoding base64 +openssl pkcs12 -in cert.pfx -passin pass: -out cert.pem -nodes +``` + +## Convert existing PKCS12 file + +If you already have a PKCS#12 file, you can convert it to PEM format using OpenSSL. If you have a password, change the `passin` argument. + +```console +openssl pkcs12 -in fileName.p12 -clcerts -nodes -out fileName.pem -passin pass: +``` + +## Signing in with a service principal using a certificate + +To sign in with a certificate, it must be available locally as a PEM or DER file, in ASCII format. When you use a PEM file, the **PRIVATE KEY** and **CERTIFICATE** must be appended together within the file. + +```azurecli-interactive +az login --service-principal --username appID --tenant tenantID --password /path/to/cert +``` + + +# [Azure Portal](#tab/examples) + +You can assign a certificate to a service principal through the Azure portal by following these steps: + +1. In the Azure Portal, select Active Directory. + +![Screenshot of AAD](~/docs-ref-conceptual/media/azure-cli-sp-tutorial-aad.png) + +2. Then select App Registrations on the left hand sidebar. + +![Screenshot of App Registration](~/docs-ref-conceptual/media/azure-cli-sp-tutorial-app-reg.png) + +3. Next, select your AKS service principal. + +![Screenshot of Service Principal](~/docs-ref-conceptual/media/azure-cli-sp-tutorial-select-sp.png) + +4. Then proceed to click on "Certificates and secrets." Here, you can upload it, or download and install it on your PC you are using to connect with. Make sure the certificate is stored somewhere you can access it on your local machine for later steps. + +![Screenshot of Upload Certificate](~/docs-ref-conceptual/media/azure-cli-sp-tutorial-cert.png) + +5. To use the Service Principal with the certificate to access the Azure Container Registry, use the following command: + +```azurecli-interactive +# Sign into Azure CLI with Service Principal's appID and tenantID and use certificate as password +az login --service-principal --username appID --tenant tenantID --password /path/to/cert +``` + +6. Then sign into the registry with `az acr login`, which uses the Active Directory token from the CLI login: + +```azurecli-interactive +az acr login --name registryName +``` + +> [!NOTE] +> Certificate must be in PEM format - it won't work with PKCS#12 files (.p12/.pfx) +> +> You don't need to prefix the path with an @ like you do with the previous az commands +*** + +## Next Steps + +Now that you've learned how to work with service principals using a certificate, proceed to the next step to learn how to retrieve an existing service principal. + +> [!div class="nextstepaction"] +> [Get an existing service principal](./azure-cli-sp-tutorial-4.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-4.md b/docs-ref-conceptual/azure-cli-sp-tutorial-4.md new file mode 100644 index 0000000000..fbf3a36b38 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-4.md @@ -0,0 +1,46 @@ +--- +title: Get an existing service principal – Azure CLI | Microsoft Docs +description: Learn how to retrieve an existing service principal. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 4 - Get an existing service principal + +If you already have an existing service principal that you wish to use, this article details how to retrieve your existing service principal. + +A list of the service principals in a tenant can be retrieved with [az ad sp list](/cli/azure/ad/sp#az-ad-sp-list). By default this command returns the first 100 service principals for your tenant. To get all of a tenant's service principals, use the `--all` parameter. Getting this list can take a long time, so it's recommended that you filter the list with one of the following parameters: + +* `--display-name` requests service principals that have a _prefix_ that match the provided name. The display name of a service principal is the value set with the `--name` + parameter during creation. If you didn't set `--name` during service principal creation, the name prefix is `azure-cli-`. +* `--spn` filters on exact service principal name matching. The service principal name always starts with `https://`. + if the value you used for `--name` wasn't a URI, this value is `https://` followed by the display name. +* `--show-mine` requests only service principals created by the signed-in user. +* `--filter` takes an OData filter, and performs _server-side_ filtering. This method is recommended over filtering client-side with the CLI's `--query` parameter. To learn about OData filters, see [OData expression syntax for filters](/rest/api/searchservice/odata-expression-syntax-for-azure-search). + +The information returned for service principal objects is verbose. To get only the information necessary for sign-in, use the query string +`[].{id:appId, tenant:appOwnerTenantId}`. For example, to get the sign-in information for all service principals created by the currently logged in user: + +```azurecli-interactive +az ad sp list --show-mine --query "[].{id:appId, tenant:appOwnerTenantId}" +``` + +> [!IMPORTANT] +> +> `az ad sp list` or [az ad sp show](/cli/azure/ad/sp#az-ad-sp-show) get the user and tenant, but not any authentication secrets _or_ the authentication method. +> Secrets for certificates in Key Vault can be retrieved with [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show), but no other secrets are stored by default. +> If you forget an authentication method or secret, [reset the service principal credentials](./azure-cli-sp-tutorial-7.md). + +## Next Steps + +Now that you've learned how to retrieve your existing service principal, proceed to the next step to learn how to manage your service principal roles. + +> [!div class="nextstepaction"] +> [Manage service principal roles](./azure-cli-sp-tutorial-5.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-5.md b/docs-ref-conceptual/azure-cli-sp-tutorial-5.md new file mode 100644 index 0000000000..4877dfa500 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-5.md @@ -0,0 +1,79 @@ +--- +title: Manage service principal roles – Azure CLI | Microsoft Docs +description: Learn how to manage role assignments using Azure CLI. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 5 - Manage service principal roles + +In order to restrict access to your Azure service's resources, you can use service principal to manage role assignments. Each level provides a different amount of permissions allowed by the user when accessing the service's resources. + +The Azure CLI has the following commands to manage role assignments: + +* [az role assignment list](/cli/azure/role/assignment#az-role-assignment-list) +* [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) +* [az role assignment delete](/cli/azure/role/assignment#az-role-assignment-delete) + +The **Contributor** role has full permissions to read and write to an Azure account. The **Reader** role is more restrictive, with read-only access. For more information on Role-Based Access Control (RBAC) and roles, see [RBAC: Built-in roles](/azure/active-directory/role-based-access-built-in-roles). + +This example adds the **Reader** role and removes the **Contributor** role: + +```azurecli-interactive +az role assignment create --assignee appID \ + --role Reader \ + --scope /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName + +az role assignment delete --assignee appID \ + --role Contributor \ + --scope /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName +``` + +Output Console: + +``` +{ + "condition": null, + "conditionVersion": null, + "createdBy": "userID", + "createdOn": "2023-09-13T21:12:24.213484+00:00", + "delegatedManagedIdentityResourceId": null, + "description": null, + "id": "/subscriptions/mySubscriptionID/resourceGroups/daphne-test/providers/Microsoft.Authorization/roleAssignments/myName", + "name": "myName", + "principalId": "myPrincipalId", + "principalName": "myPrincipalName", + "principalType": "servicePrincipal", + "resourceGroup": "myResourceGroupName", + "roleDefinitionId": "/subscriptions/mysubscriptionID/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "roleDefinitionName": "Reader", + "scope": "/subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName", + "type": "Microsoft.Authorization/roleAssignments", + "updatedBy": "userID", + "updatedOn": "2023-09-13T21:12:24.213484+00:00" +} +``` + +Adding a role _doesn't_ restrict previously assigned permissions. Since the *Contributor* rights are added by default, the role should be deleted using the command shown previously. + +The changes can be verified by listing the assigned roles: + +```azurecli-interactive +az role assignment list --assignee appID +``` + +You can also go into the [Azure portal](https://ms.portal.azure.com/) and manually assign the role to the service principal from the IAM section of the Azure Container Registry Instance. + +## Next Steps + +Now that you've learned how to manage your service principal roles, proceed to the next step to learn how to use service principals to create a resource. + +> [!div class="nextstepaction"] +> [Create a resource using service principal](./azure-cli-sp-tutorial-6.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-6.md b/docs-ref-conceptual/azure-cli-sp-tutorial-6.md new file mode 100644 index 0000000000..71208cb8a5 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-6.md @@ -0,0 +1,208 @@ +--- +title: Create a resource using service principal – Azure CLI | Microsoft Docs +description: Learn how to create a resource using service principal with Azure CLI. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 6 - Create a resource using service principal + +When using service principals with an Azure service, you want to ensure that your resources are secure. You can achieve this by creating your resources using service principal. +The following section provides an example of how to create a resource for [Azure Storage](/azure/storage/) with a service principal, using the following commands: + +* [az login](/cli/azure/reference-index#az-login) +* [az group create](/cli/azure/group#az-group-create) +* [az storage account create](/cli/azure/storage/account#az-storage-account-create) +* [az storage account keys list](/cli/azure/storage/account/keys#az-storage-account-keys-list) + +To sign in with a service principal, you need the `appID`, `tenantID`, and `password` returned as the response when you [created your service principal](./azure-cli-sp-tutorial-1.md). + +1. Sign in as the service principal. + + ```azurecli-interactive + az login --service-principal --username appID --password PASSWORD --tenant tenantID + ``` + + Output console: + + ``` + [ + { + "cloudName": "AzureCloud", + "homeTenantId": "tenantID", + "id": "mySubscriptionId", + "isDefault": true, + "managedByTenants": [], + "name": "mySubscriptionName", + "state": "Enabled", + "tenantId": "tenantID", + "user": { + "name": "myName", + "type": "servicePrincipal" + } + } + ] + ``` + +2. Create a resource group to hold all resources used for the same quickstart, tutorial, or development project. + + ```azurecli-interactive + az group create --location westus --name myResourceGroupName + ``` + +3. Create a storage account. + + For Azure Storage, valid values for the `` parameter are: + + * BlobStorage + * BlockBlobStorage + * FileStorage + * Storage + * StorageV2 + + ```azurecli-interactive + az storage account create --name myStorageAccountName --resource-group myResourceGroupName --kind --sku F0 --location westus --yes + ``` + + Output console: + + ``` + { + "accessTier": "Hot", + "allowBlobPublicAccess": true, + "allowCrossTenantReplication": null, + "allowSharedKeyAccess": null, + "allowedCopyScope": null, + "azureFilesIdentityBasedAuthentication": null, + "blobRestoreStatus": null, + "creationTime": "2023-09-15T17:29:49.429047+00:00", + "customDomain": null, + "defaultToOAuthAuthentication": null, + "dnsEndpointType": null, + "enableHttpsTrafficOnly": true, + "enableNfsV3": null, + "encryption": { + "encryptionIdentity": null, + "keySource": "Microsoft.Storage", + "keyVaultProperties": null, + "requireInfrastructureEncryption": null, + "services": { + "blob": { + "enabled": true, + "keyType": "Account", + "lastEnabledTime": "2023-09-15T17:29:49.569653+00:00" + }, + "file": { + "enabled": true, + "keyType": "Account", + "lastEnabledTime": "2023-09-15T17:29:49.569653+00:00" + }, + "queue": null, + "table": null + } + }, + "extendedLocation": null, + "failoverInProgress": null, + "geoReplicationStats": null, + "id": "/subscriptions/mysubscriptionID/resourceGroups/myResourceGroupName/providers/Microsoft.Storage/storageAccounts/myStorageAccountName", + "identity": null, + "immutableStorageWithVersioning": null, + "isHnsEnabled": null, + "isLocalUserEnabled": null, + "isSftpEnabled": null, + "keyCreationTime": { + "key1": "2023-09-15T17:29:49.554030+00:00", + "key2": "2023-09-15T17:29:49.554030+00:00" + }, + "keyPolicy": null, + "kind": "StorageV2", + "largeFileSharesState": null, + "lastGeoFailoverTime": null, + "location": "eastus", + "minimumTlsVersion": "TLS1_0", + "name": "myStorageAccountName", + "networkRuleSet": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "resourceAccessRules": null, + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "blob": "https://myStorageAccountName.blob.core.windows.net/", + "dfs": "https://myStorageAccountName.dfs.core.windows.net/", + "file": "https://myStorageAccountName.file.core.windows.net/", + "internetEndpoints": null, + "microsoftEndpoints": null, + "queue": "https://myStorageAccountName.queue.core.windows.net/", + "table": "https://myStorageAccountName.table.core.windows.net/", + "web": "https://myStorageAccountName.z13.web.core.windows.net/" + }, + "primaryLocation": "eastus", + "privateEndpointConnections": [], + "provisioningState": "Succeeded", + "publicNetworkAccess": null, + "resourceGroup": "myResourceGroupName", + "routingPreference": null, + "sasPolicy": null, + "secondaryEndpoints": { + "blob": "https://myStorageAccountName-secondary.blob.core.windows.net/", + "dfs": "https://myStorageAccountName-secondary.dfs.core.windows.net/", + "file": null, + "internetEndpoints": null, + "microsoftEndpoints": null, + "queue": "https://myStorageAccountName-secondary.queue.core.windows.net/", + "table": "https://myStorageAccountName-secondary.table.core.windows.net/", + "web": "https://myStorageAccountName-secondary.z13.web.core.windows.net/" + }, + "secondaryLocation": "westus", + "sku": { + "name": "Standard_RAGRS", + "tier": "Standard" + }, + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "storageAccountSkuConversionStatus": null, + "tags": {}, + "type": "Microsoft.Storage/storageAccounts" + } + ``` + +4. Get resource keys, which you use in your code to authenticate to the Azure storage account. + + ```azurecli-interactive + az storage account keys list --resource-group myResourceGroupName --account-name myStorageAccountName + ``` + + Output Console: + + ``` + [ + { + "creationTime": "2023-09-15T17:29:49.554030+00:00", + "keyName": "key1", + "permissions": "FULL", + "value": "myKeyValue1" + }, + { + "creationTime": "2023-09-15T17:29:49.554030+00:00", + "keyName": "key2", + "permissions": "FULL", + "value": "myKeyValue2" + } + ] + ``` + +## Next Steps + +Now that you've learned how to create a resource using service principal, proceed to the next step to learn how to reset your service principal credentials. + +> [!div class="nextstepaction"] +> [Reset service principal credentials](./azure-cli-sp-tutorial-7.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-7.md b/docs-ref-conceptual/azure-cli-sp-tutorial-7.md new file mode 100644 index 0000000000..92945153e4 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-7.md @@ -0,0 +1,32 @@ +--- +title: Reset service principal credentials – Azure CLI | Microsoft Docs +description: Learn how to reset your service principal credentials using Azure CLI. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 7 - Reset credentials + +If you ever lose your service principal credentials, the best and most secure option is to reset the credentials. +This article details how to reset your service principal credentials. + +If you lose the credentials for a service principal, use [az ad sp credential reset](/cli/azure/ad/sp/credential#az-ad-sp-credential-reset). The reset command takes the same parameters +as `az ad sp create-for-rbac`. + +```azurecli-interactive +az ad sp credential reset --name myServicePrincipal_appID_or_name +``` + +## Next Steps + +Now that you've learned how to reset your service principal credentials, proceed to the next step to see how to clean up your service principal resources. + +> [!div class="nextstepaction"] +> [Cleanup](./azure-cli-sp-tutorial-8.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-8.md b/docs-ref-conceptual/azure-cli-sp-tutorial-8.md new file mode 100644 index 0000000000..76470b80ed --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-8.md @@ -0,0 +1,34 @@ +--- +title: Service principal cleanup – Azure CLI | Microsoft Docs +description: Learn how to clean up service principal resources. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 8 - Cleanup + +Now that you have completed the tutorial, it's time to clean up the created service principal resources. You can delete individual resources with the `delete` command, but the safest way to remove all resources in a resource group is with `group delete`. + +```azurecli-interactive +az group delete --name $resourceGroup --no-wait +``` + +This command deletes the resources created during the tutorial, and clears them in the correct order. The `--no-wait` parameter keeps the CLI from blocking while the deletion takes place. If you want to wait until the deletion is complete or watch it progress, use the `group wait` command. + +```azurecli-interactive +az group wait --name $resourceGroup --deleted +``` + +## Next Steps + +Now that you've learned how to cleanup your service principal resources, proceed to the next step to see an overall summary of everything you have learned. + +> [!div class="nextstepaction"] +> [Summary](./azure-cli-sp-tutorial-9.md) \ No newline at end of file diff --git a/docs-ref-conceptual/azure-cli-sp-tutorial-9.md b/docs-ref-conceptual/azure-cli-sp-tutorial-9.md new file mode 100644 index 0000000000..20a00e7825 --- /dev/null +++ b/docs-ref-conceptual/azure-cli-sp-tutorial-9.md @@ -0,0 +1,39 @@ +--- +title: Summary of using Azure service principals – Azure CLI | Microsoft Docs +description: Sumary of what was taught in the service principal tutorial. +manager: jasongroce +author: daphnemamsft +ms.author: daphnema +ms.date: 09/6/2023 +ms.topic: conceptual +ms.service: azure-cli +ms.tool: azure-cli +ms.custom: devx-track-azurecli, seo-azure-cli +keywords: azure service principal, create service principal azure, create service principal azure cli +--- + +# 9 - Summary + +## Troubleshooting + +Congratulations! You learned how to create, retrieve, and work with service principals in order to create a resource group. Although you have completed the tutorial, you may still have additional questions regarding service principals that can be answered in this article. + +### Insufficient privileges +If your account doesn't have permission to create a service principal, `az ad sp create-for-rbac` returns an error message containing "Insufficient privileges to complete the operation." Contact your Azure Active Directory admin to create a service principal. + +### Invalid tenant +If you have specified an invalid subscription ID, you see the error message "The request didn't have a subscription or a valid tenant level resource provider." If using variables, use the Bash `echo` command to see the value being passed to the reference command. Use [az account set](/cli/azure/account#az-account-set) to change your subscription or learn [How to manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md). + +### Resource group not found +If you have specified an invalid resource group name, you see the error message "Resource group 'name' couldn't be found." If using variables, use the Bash `echo` command to see the value being passed to both the subscription and reference commands. Use [az group list](/cli/azure/group#az-group-list) to see the resource groups for the current subscription, or learn [How to manage Azure resource groups with the Azure CLI](./manage-azure-groups-azure-cli.md). + +### Authorization to perform action +If your account doesn't have permission to assign a role, you see an error message that your account "does not have authorization to perform action 'Microsoft.Authorization/roleAssignments/write'." Contact your Azure Active Directory admin to manage roles. + +## See also + +* [Application and service principal objects in Azure Active Directory](/azure/active-directory/develop/app-objects-and-service-principals) +* [Manage service principals using the Azure portal](/azure/developer/python/how-to-manage-service-principals) +* [Azure authentication with service principals](/azure/developer/java/sdk/identity-service-principal-auth) +* [Service principals with Azure Kubernetes Service (AKS)](/azure/aks/kubernetes-service-principal) +* [View the service principal of a managed identity](/azure/active-directory/managed-identities-azure-resources/how-to-view-managed-identity-service-principal-cli) diff --git a/docs-ref-conceptual/create-an-azure-service-principal-azure-cli.md b/docs-ref-conceptual/create-an-azure-service-principal-azure-cli.md deleted file mode 100644 index bdfa678d1b..0000000000 --- a/docs-ref-conceptual/create-an-azure-service-principal-azure-cli.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -title: Work with Azure service principals – Azure CLI | Microsoft Docs -description: Learn how to create and use service principals with the Azure CLI. Use service principals to gain control over which Azure resources can be accessed. -manager: jasongroce -author: dbradish-microsoft -ms.author: dbradish -ms.date: 08/2/2023 -ms.topic: conceptual -ms.service: azure-cli -ms.tool: azure-cli -ms.custom: devx-track-azurecli, seo-azure-cli -keywords: azure service principal, create service principal azure, create service principal azure cli ---- -# Work with Azure service principal using the Azure CLI - -Automated tools that use Azure services should always have restricted permissions. Instead of having -applications sign in as a fully privileged user, Azure offers service principals. - -## What is an Azure service principal? - -An Azure service principal is an identity created for use with -applications, hosted services, and automated tools to access resources. -The roles assigned to the service principal restrict access. This gives you control over which resources can be accessed and at what level. -For security reasons, it's -always recommended to use service principals with automated -tools rather than allowing them to sign in with a user identity. - -This article shows you the steps for creating, getting information about, and resetting an Azure service principal with the Azure CLI. - -## 1. Create a service principal - -Create an Azure service principal with the [az ad sp create-for-rbac](/cli/azure/ad/sp#az_ad_sp_create_for_rbac) command. - -The `appId` and `tenant` keys appear in the output of `az ad sp create-for-rbac` and are used in service principal authentication. Record their values, but they can be retrieved at any point with [az ad sp list](/cli/azure/ad/sp#az-ad-sp-list). - -When creating a service principal, you choose the type of sign-in authentication it uses. There are two types of authentication available for Azure service principals: password-based authentication, and certificate-based authentication. - -> [!WARNING] -> When you create an Azure service principal using the `az ad sp create-for-rbac` command, 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](/azure/active-directory/managed-identities-azure-resources/overview) if available to avoid the need to use credentials. -> -> To reduce your risk of a compromised service principal, assign a more specific role and narrow the scopes to a resource or resource group. See [Steps to add a role assignment](/azure/role-based-access-control/role-assignments-steps) for more information. - - -### Password-based authentication - -With password-based authentication, a random password is created for you. If you don't specify a `--name` parameter value, a name containing a time stamp is created for you. You must specify a `--scopes` as this value doesn't have a default. If you prefer, you can set the role assignment later by using [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create). - -```azurecli-interactive -# Create a service principal without a role assignment -az ad sp create-for-rbac --scopes /subscriptions/mySubscriptionID - -# Create a service principal for a resource group using a preferred name and role -az ad sp create-for-rbac --name myServicePrincipalName \ - --role reader \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName -``` - -You can also create a service principal using variables. - -```azurecli-interactive -let "randomIdentifier=$RANDOM*$RANDOM" -servicePrincipalName="msdocs-sp-$randomIdentifier" -roleName="azureRoleName" -subscriptionID=$(az account show --query id -o tsv) -# Verify the ID of the active subscription -echo "Using subscription ID $subscriptionID" -resourceGroup="myResourceGroupName" - -echo "Creating SP for RBAC with name $servicePrincipalName, with role $roleName and in scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup" -az ad sp create-for-rbac --name $servicePrincipalName --role $roleName --scopes /subscriptions/$subscriptionID/resourceGroups/$resourceGroup -``` - -The output for a service principal with password authentication includes the `password` key. __Make sure you copy this value__ - it can't be retrieved. If you lose the password, [reset the service principal credentials](#6-reset-credentials). - -### Certificate-based authentication - -For certificate-based authentication, use the `--cert` parameter. This parameter requires that you hold an existing certificate. Make sure any tool that uses this service principal has access to the certificate's private key. Certificates should be in an ASCII format such as PEM, CER, or DER. Pass the certificate as a string, or use the `@path` format to load the certificate from a file. - -> [!NOTE] -> When using a PEM file, the **CERTIFICATE** must be appended to the **PRIVATE KEY** within the file. - -```azurecli-interactive -az ad sp create-for-rbac --name myServicePrincipalName \ - --role roleName \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ - --cert "-----BEGIN CERTIFICATE----- -... ------END CERTIFICATE-----" -``` - -```azurecli-interactive -az ad sp create-for-rbac --name myServicePrincipalName \ - --role roleName \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ - --cert @/path/to/cert.pem -``` - -The `--keyvault` parameter can be added to use a certificate in Azure Key Vault. In this case, the `--cert` value is the name of the certificate. - -```azurecli-interactive -az ad sp create-for-rbac --name myServicePrincipalName \ - --role roleName \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ - --cert certificateName \ - --keyvault vaultName -``` - -To create a _self-signed_ certificate for authentication, use the `--create-cert` parameter: - -```azurecli-interactive -az ad sp create-for-rbac --name myServicePrincipalName \ - --role roleName \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ - --create-cert -``` - -Console output: - -``` -Creating a role assignment under the scopes of "/subscriptions/myId" -Please copy C:\myPath\myNewFile.pem to a safe place. -When you run 'az login', provide the file path in the --password parameter -{ - "appId": "myAppId", - "displayName": "myDisplayName", - "fileWithCertAndPrivateKey": "C:\\myPath\\myNewFile.pem", - "name": "http://myName", - "password": null, - "tenant": "myTenantId" -} -``` - -Contents of the new PEM file: -``` ------BEGIN PRIVATE KEY----- -myPrivateKeyValue ------END PRIVATE KEY----- ------BEGIN CERTIFICATE----- -myCertificateValue ------END CERTIFICATE----- -``` - -> [!NOTE] -> The `az ad sp create-for-rbac --create-cert` command creates the service principal and a PEM file. The PEM file contains a correctly formatted **PRIVATE KEY** and **CERTIFICATE**. - -The `--keyvault` parameter can be added to store the certificate in Azure Key Vault. When you use `--keyvault`, the `--cert` parameter is __required__. - -```azurecli-interactive -az ad sp create-for-rbac --name myServicePrincipalName \ - --role roleName \ - --scopes /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName \ - --create-cert \ - --cert certificateName \ - --keyvault vaultName -``` - -Unless you store the certificate in Key Vault, the output includes the `fileWithCertAndPrivateKey` key. This key's value tells you where the generated certificate is stored. -__Make sure__ that you copy the certificate to a secure location, or you can't sign in with this service principal. - -If you lose access to a certificate's private key, [reset the service principal credentials](#6-reset-credentials). - -#### Retrieve certificate from Key Vault - -For certificate stored in Key Vault, retrieve the certificate with its private key with [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show) and convert it to a PEM file. In the Key Vault, the name of the certificate's secret is the same as the certificate name. - -```azurecli-interactive -az keyvault secret download --file /path/to/cert.pfx --vault-name VaultName --name CertName --encoding base64 -openssl pkcs12 -in cert.pfx -passin pass: -out cert.pem -nodes -``` - -#### Convert existing PKCS12 file - -If you already have a PKCS#12 file, you can convert it to PEM format using OpenSSL. If you have a password, change the `passin` argument. - -```console -openssl pkcs12 -in fileName.p12 -clcerts -nodes -out fileName.pem -passin pass: -``` - -## 2. Get an existing service principal - -A list of the service principals in a tenant can be retrieved with [az ad sp list](/cli/azure/ad/sp#az-ad-sp-list). By default this -command returns the first 100 service principals for your tenant. To get all of a tenant's service principals, use the `--all` parameter. Getting this list can take a long time, so it's -recommended that you filter the list with one of the following parameters: - -* `--display-name` requests service principals that have a _prefix_ that match the provided name. The display name of a service principal is the value set with the `--name` - parameter during creation. If you didn't set `--name` during service principal creation, the name prefix is `azure-cli-`. -* `--spn` filters on exact service principal name matching. The service principal name always starts with `https://`. - if the value you used for `--name` wasn't a URI, this value is `https://` followed by the display name. -* `--show-mine` requests only service principals created by the signed-in user. -* `--filter` takes an OData filter, and performs _server-side_ filtering. This method is recommended over filtering client-side with the CLI's `--query` parameter. To learn about OData filters, see [OData expression syntax for filters](/rest/api/searchservice/odata-expression-syntax-for-azure-search). - -The information returned for service principal objects is verbose. To get only the information necessary for sign-in, use the query string -`[].{id:appId, tenant:appOwnerTenantId}`. For example, to get the sign-in information for all service principals created by the currently logged in user: - -```azurecli-interactive -az ad sp list --show-mine --query "[].{id:appId, tenant:appOwnerTenantId}" -``` - -> [!IMPORTANT] -> -> `az ad sp list` or [az ad sp show](/cli/azure/ad/sp#az-ad-sp-show) get the user and tenant, but not any authentication secrets _or_ the authentication method. -> Secrets for certificates in Key Vault can be retrieved with [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show), but no other secrets are stored by default. -> If you forget an authentication method or secret, [reset the service principal credentials](#6-reset-credentials). - -## 3. Manage service principal roles - -The Azure CLI has the following commands to manage role assignments: - -* [az role assignment list](/cli/azure/role/assignment#az-role-assignment-list) -* [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) -* [az role assignment delete](/cli/azure/role/assignment#az-role-assignment-delete) - -The **Contributor** role has full permissions to read and write to an Azure account. The **Reader** role is more restrictive, with read-only access. For more information on Role-Based Access Control (RBAC) and roles, see [RBAC: Built-in roles](/azure/active-directory/role-based-access-built-in-roles). - -This example adds the **Reader** role and removes the **Contributor** role: - -```azurecli-interactive -az role assignment create --assignee appID \ - --role Reader \ - --scope /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName - -az role assignment delete --assignee appID \ - --role Contributor \ - --scope /subscriptions/mySubscriptionID/resourceGroups/myResourceGroupName -``` - -Adding a role _doesn't_ restrict previously assigned permissions. When you restrict a service principal's permissions, the __Contributor__ role should be removed if previously assigned. - -The changes can be verified by listing the assigned roles: - -```azurecli-interactive -az role assignment list --assignee appID -``` - -## 4. Sign in using a service principal - -Test the new service principal's credentials and permissions by signing in. To sign in with a service principal, you need the `appId`, `tenant`, and credentials. - -To sign in with a service principal using a password: - -```azurecli-interactive -az login --service-principal --username appID --password PASSWORD --tenant tenantID -``` - -To sign in with a certificate, it must be available locally as a PEM or DER file, in ASCII format. When you use a PEM file, the **PRIVATE KEY** and **CERTIFICATE** must be appended together within the file. - -```azurecli-interactive -az login --service-principal --username appID --tenant tenantID --password /path/to/cert -``` - -To learn more about signing in with a service principal, see [Sign in with the Azure CLI](authenticate-azure-cli.md). - -## 5. Create a resource using service principal - -The following section provides an example of how to create a resource for [Azure Storage](/azure/storage/) with a service principal, using the following commands: - -* [az login](/cli/azure/reference-index#az-login) -* [az group create](/cli/azure/group#az-group-create) -* [az storage account create](/cli/azure/storage/account#az-storage-account-create) -* [az storage account keys list](/cli/azure/storage/account/keys#az-storage-account-keys-list) - -To sign in with a service principal, you need the `appID`, `tenantID`, and `password` returned as the response when you [created your service principal](#1-create-a-service-principal). - -1. Sign in as the service principal. - - ```azurecli-interactive - az login --service-principal --username appID --password PASSWORD --tenant tenantID - ``` - -1. Create a resource group to hold all resources used for the same quickstart, tutorial, or development project. - - ```azurecli-interactive - az group create --location westus --name myResourceGroupName - ``` - -1. Create a storage account. - - For Azure Storage, valid values for the `` parameter are: - - * BlobStorage - * BlockBlobStorage - * FileStorage - * Storage - * StorageV2 - - ```azurecli-interactive - az storage account create --name myStorageAccountName --resource-group myResourceGroupName --kind --sku F0 --location westus --yes - ``` - -1. Get resource keys, which you use in your code to authenticate to the Azure storage account. - - ```azurecli-interactive - az storage account keys list --name myStorageAccountName --resource-group myResourceGroupName - ``` - -## 6. Reset credentials - -If you lose the credentials for a service principal, use [az ad sp credential reset](/cli/azure/ad/sp/credential#az-ad-sp-credential-reset). The reset command takes the same parameters -as `az ad sp create-for-rbac`. - -```azurecli-interactive -az ad sp credential reset --name myServicePrincipal_appID_or_name -``` - -## 7. Troubleshooting - -### Insufficient privileges -If your account doesn't have permission to create a service principal, `az ad sp create-for-rbac` returns an error message containing "Insufficient privileges to complete the operation." Contact your Azure Active Directory admin to create a service principal. - -### Invalid tenant -If you have specified an invalid subscription ID, you see the error message "The request didn't have a subscription or a valid tenant level resource provider." If using variables, use the Bash `echo` command to see the value being passed to the reference command. Use [az account set](/cli/azure/account#az-account-set) to change your subscription or learn [How to manage Azure subscriptions with the Azure CLI](./manage-azure-subscriptions-azure-cli.md). - -### Resource group not found -If you have specified an invalid resource group name, you see the error message "Resource group 'name' couldn't be found." If using variables, use the Bash `echo` command to see the value being passed to both the subscription and reference commands. Use [az group list](/cli/azure/group#az-group-list) to see the resource groups for the current subscription, or learn [How to manage Azure resource groups with the Azure CLI](./manage-azure-groups-azure-cli.md). - -### Authorization to perform action -If your account doesn't have permission to assign a role, you see an error message that your account "does not have authorization to perform action 'Microsoft.Authorization/roleAssignments/write'." Contact your Azure Active Directory admin to manage roles. - -## See also - -* [Application and service principal objects in Azure Active Directory](/azure/active-directory/develop/app-objects-and-service-principals) -* [Manage service principals using the Azure portal](/azure/developer/python/how-to-manage-service-principals) -* [Azure authentication with service principals](/azure/developer/java/sdk/identity-service-principal-auth) -* [Service principals with Azure Kubernetes Service (AKS)](/azure/aks/kubernetes-service-principal) -* [View the service principal of a managed identity](/azure/active-directory/managed-identities-azure-resources/how-to-view-managed-identity-service-principal-cli) diff --git a/docs-ref-conceptual/includes/cli-install-linux-apt.md b/docs-ref-conceptual/includes/cli-install-linux-apt.md index fae201baa9..a15d5d5e5b 100644 --- a/docs-ref-conceptual/includes/cli-install-linux-apt.md +++ b/docs-ref-conceptual/includes/cli-install-linux-apt.md @@ -56,8 +56,8 @@ If you prefer a step-by-step installation process, complete the following steps 3.
Add the Azure CLI software repository: ```bash - AZ_REPO=$(lsb_release -cs) - echo "deb [arch=`dpkg --print-architecture` signed-by=/etc/apt/keyrings/microsoft.gpg] https://packages.microsoft.com/repos/azure-cli/ $AZ_REPO main" | + AZ_DIST=$(lsb_release -cs) + echo "deb [arch=`dpkg --print-architecture` signed-by=/etc/apt/keyrings/microsoft.gpg] https://packages.microsoft.com/repos/azure-cli/ $AZ_DIST main" | sudo tee /etc/apt/sources.list.d/azure-cli.list ``` @@ -72,18 +72,35 @@ If you prefer a step-by-step installation process, complete the following steps Configure the `azure-cli` repository information as shown previously. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md). -1. To view available versions with command: +1. View available versions of the Azure CLI. ```bash apt-cache policy azure-cli ``` -2. To install specific version: +1. Install a specific version. ```bash - sudo apt-get install azure-cli=-1~bullseye + # Obtain the currently installed distribution + AZ_DIST=$(lsb_release -cs) + + # Store an Azure CLI version of choice + AZ_VER=2.51.0 + + # Install a specific version + sudo apt-get install azure-cli=$AZ_VER-1~$AZ_DIST ``` + To install a specific version without variables, replace the Azure CLI version and Linux distribution name shown: + + ```bash + sudo apt-get install azure-cli=2.51.0-1~bullseye + ``` + +If you receive error message _Unable to locate package azure-cli_, the `azure-cli` repository information is not configured. Follow the steps given in [Option 2: Step-by-step installation instructions](#option-2-step-by-step-installation-instructions). + +If you receive error message _Version x.xx.x-1~distributionName for azure-cli was not found_, use `lsb_release -cs` to find the distribution you're running. + ## Update Azure CLI [!INCLUDE [az-upgrade](az-upgrade.md)] @@ -202,12 +219,9 @@ Acquire { If your proxy doesn't use basic auth, __remove__ the `[username]:[password]@` portion of the proxy URI. If you require more information for proxy configuration, see the official Ubuntu documentation: -* [apt.conf manpage](https://manpages.ubuntu.com/manpages/lunar/en/man5/apt.conf.5.html) +* [apt.conf man page](https://manpages.ubuntu.com/manpages/lunar/en/man5/apt.conf.5.html) * [Ubuntu wiki - apt-get howto](https://help.ubuntu.com/community/AptGet/Howto#Setting_up_apt-get_to_use_a_http-proxy) -In order to get the Microsoft signing key and get the package from our repository, your proxy needs to -allow HTTPS connections to the following address: - -* `https://packages.microsoft.com` +In order to get the Microsoft signing key and get the package from our repository, your proxy needs to allow HTTPS connections to the following address: `https://packages.microsoft.com. [!INCLUDE[troubleshoot-wsl.md](troubleshoot-wsl.md)] diff --git a/docs-ref-conceptual/index.yml b/docs-ref-conceptual/index.yml index 5c6b8e5ffd..89cc7b495c 100644 --- a/docs-ref-conceptual/index.yml +++ b/docs-ref-conceptual/index.yml @@ -135,7 +135,37 @@ landingContent: url: /learn/modules/connect-an-app-to-azure-storage - text: Run parallel tasks in Azure Batch url: /learn/modules/run-parallel-tasks-in-azure-batch-with-the-azure-cli - - title: Help & Support + - linkListType: tutorial + links: + - text: Create virtual machines on the same subnet with the Azure CLI + url: azure-cli-vm-tutorial.yml + - text: Create an Azure service principal + url: ./create-an-azure-service-principal-azure-cli.md + - title: Azure CLI extensions + linkLists: + - linkListType: overview + links: + - text: About CLI extensions + url: azure-cli-extensions-overview.md + - linkListType: reference + links: + - text: Available extensions + url: azure-cli-extensions-list.md + - title: Azure CLI reference + linkLists: + - linkListType: reference + links: + - text: Full command reference + url: ../latest/docs-ref-autogen/reference-index.yml + - text: Output formats + url: format-output-azure-cli.md + - text: Configuration settings + url: azure-cli-configuration.md + - text: Query CLI command results + url: query-azure-cli.md + - text: Release notes + url: release-notes-azure-cli.md + - title: Give feedback and get support linkLists: - linkListType: concept links: diff --git a/docs-ref-conceptual/install-azure-cli.md b/docs-ref-conceptual/install-azure-cli.md index bf42c559f1..35c8579bb9 100644 --- a/docs-ref-conceptual/install-azure-cli.md +++ b/docs-ref-conceptual/install-azure-cli.md @@ -14,7 +14,7 @@ keywords: azure cli, install azure cli, azure cli download, download azure cli # How to install the Azure CLI -The Azure CLI is available to install in Windows, macOS and Linux environments. It can also be run in a Docker container and Azure Cloud Shell. +The Azure CLI is available to install in Windows, macOS and Linux environments. It can also be run in a Docker container and Azure Cloud Shell. ## Install @@ -23,7 +23,7 @@ The Azure CLI is available to install in Windows, macOS and Linux environments. * [Install on Windows](install-azure-cli-windows.md) * [Install on macOS](install-azure-cli-macos.md) * Install on Linux or Windows Subsystem for Linux (WSL) ([What is WSL?](/windows/wsl/about)) - + * [Install on RHEL/CentOS with dnf](./install-azure-cli-linux.md?pivots=dnf) * [Install on SLES/OpenSUSE with zypper](./install-azure-cli-linux.md?pivots=zypper) * [Install on Ubuntu/Debian with apt](./install-azure-cli-linux.md?pivots=apt) @@ -35,8 +35,34 @@ The Azure CLI is available to install in Windows, macOS and Linux environments. > [!NOTE] > If you're using the Azure classic deployment model, [install the Azure classic CLI](install-classic-cli.md). +## FAQ + +### Where is the Azure CLI installed? + +When installing the Azure CLI, you can't select an install location. In Windows, the 32-bit Azure CLI installs in `C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2` and the 64-bit in `C:\Program Files\Microsoft SDKs\Azure\CLI2`. In Linux, the Azure CLI is installed in `/opt/az/` on Ubuntu and Debian, and in `/lib64/az/` on CentOS, RHEL and Azure Linux. + +User-specific configuration files are located in `$HOME/.azure` on macOS and Linux, and `%USERPROFILE%\.azure` on Windows. These locations are known as the `AZURE_CONFIG_DIR`. + +### What version of the Azure CLI is installed? + +Type `az version` in a terminal window to know what version of the Azure CLI is installed. Your output looks like this: + +```output +{ + "azure-cli": "x.xx.0x", + "azure-cli-core": "x.xx.x", + "azure-cli-telemetry": "x.x.x", + "extensions": {} +} +``` + +### What extensions are installed? + +Use the `az extension list` command to see installed extension. You can also use `az version`, but `az extension list` provides additional information including the installation path and status. For information on managing extensions, see [Use and manage extensions with the Azure CLI](./azure-cli-extensions-overview.md). + ## See also -- [Update the Azure CLI](./update-azure-cli.md) -- [How to use the Azure CLI successfully](use-cli-effectively.md) -- [Find Azure CLI samples](./samples-index.md) +* [Sign in with the Azure CLI](./authenticate-azure-cli.md) +* [Azure CLI Onboarding cheat sheet](./cheat-sheet-onboarding.md) +* Find Azure CLI [samples](./samples-index.md) and [published docs](./reference-docs-index.md) +* [How to use the Azure CLI successfully](use-cli-effectively.md) diff --git a/docs-ref-conceptual/media/azure-cli-sp-tutorial-aad.png b/docs-ref-conceptual/media/azure-cli-sp-tutorial-aad.png new file mode 100644 index 0000000000..e7c1d75313 Binary files /dev/null and b/docs-ref-conceptual/media/azure-cli-sp-tutorial-aad.png differ diff --git a/docs-ref-conceptual/media/azure-cli-sp-tutorial-app-reg.png b/docs-ref-conceptual/media/azure-cli-sp-tutorial-app-reg.png new file mode 100644 index 0000000000..c702ef4ac6 Binary files /dev/null and b/docs-ref-conceptual/media/azure-cli-sp-tutorial-app-reg.png differ diff --git a/docs-ref-conceptual/media/azure-cli-sp-tutorial-cert.png b/docs-ref-conceptual/media/azure-cli-sp-tutorial-cert.png new file mode 100644 index 0000000000..10649a945f Binary files /dev/null and b/docs-ref-conceptual/media/azure-cli-sp-tutorial-cert.png differ diff --git a/docs-ref-conceptual/media/azure-cli-sp-tutorial-select-sp.png b/docs-ref-conceptual/media/azure-cli-sp-tutorial-select-sp.png new file mode 100644 index 0000000000..506d815525 Binary files /dev/null and b/docs-ref-conceptual/media/azure-cli-sp-tutorial-select-sp.png differ diff --git a/docs-ref-conceptual/what-is-azure-cli.md b/docs-ref-conceptual/what-is-azure-cli.md index ef094760d2..9e41a86c0d 100644 --- a/docs-ref-conceptual/what-is-azure-cli.md +++ b/docs-ref-conceptual/what-is-azure-cli.md @@ -61,7 +61,7 @@ az role assignment create --assignee servicePrincipalName --role Reader --scope az role assignment delete --assignee userSign-inName --role Contributor ``` -See [Create an Azure service principal with the Azure CLI](create-an-azure-service-principal-azure-cli.md) for an in-depth tutorial on managing service principals and role assignments. +See [Create an Azure service principal with the Azure CLI](./azure-cli-sp-tutorial-1.md) for an in-depth tutorial on managing service principals and role assignments. ## PowerShell syntax comparison diff --git a/latest/docs-ref-autogen/TOC.yml b/latest/docs-ref-autogen/TOC.yml index 87ecfea875..1dff315eff 100644 --- a/latest/docs-ref-autogen/TOC.yml +++ b/latest/docs-ref-autogen/TOC.yml @@ -656,6 +656,14 @@ uid: az_scvmm_vm_disk displayName: az scvmm vm disk items: [] + - name: extension + uid: az_scvmm_vm_extension + displayName: az scvmm vm extension + items: [] + - name: guest-agent + uid: az_scvmm_vm_guest-agent + displayName: az scvmm vm guest-agent + items: [] - name: nic uid: az_scvmm_vm_nic displayName: az scvmm vm nic @@ -5600,6 +5608,10 @@ uid: az_aks_egress-endpoints displayName: az aks egress-endpoints items: [] + - name: machine + uid: az_aks_machine + displayName: az aks machine + items: [] - name: maintenanceconfiguration uid: az_aks_maintenanceconfiguration displayName: az aks maintenanceconfiguration @@ -10366,10 +10378,6 @@ uid: az_stack-hci_extension displayName: az stack-hci extension items: [] - - name: Stack HCI VM - uid: sp-Stack_HCI_VM - displayName: Stack HCI VM - items: [] - name: Storage items: - name: Summary diff --git a/latest/docs-ref-autogen/account.yml b/latest/docs-ref-autogen/account.yml index 2785893928..ee275f3de9 100644 --- a/latest/docs-ref-autogen/account.yml +++ b/latest/docs-ref-autogen/account.yml @@ -139,7 +139,12 @@ directCommands: status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py - syntax: az account list-locations + syntax: az account list-locations [--include-extended-locations {0, 1, f, false, n, no, t, true, y, yes}] + optionalParameters: + - name: --include-extended-locations + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + Whether to include extended locations. - uid: az_account_set() name: az account set summary: |- diff --git a/latest/docs-ref-autogen/account/lock.yml b/latest/docs-ref-autogen/account/lock.yml index 8868f4e99e..65cc8fbba7 100644 --- a/latest/docs-ref-autogen/account/lock.yml +++ b/latest/docs-ref-autogen/account/lock.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure subscription level locks. diff --git a/latest/docs-ref-autogen/account/management-group.yml b/latest/docs-ref-autogen/account/management-group.yml index 4581a2922b..697a9365b8 100644 --- a/latest/docs-ref-autogen/account/management-group.yml +++ b/latest/docs-ref-autogen/account/management-group.yml @@ -257,5 +257,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Manage Azure Management Groups. diff --git a/latest/docs-ref-autogen/account/management-group/entities.yml b/latest/docs-ref-autogen/account/management-group/entities.yml index 216e0bf65c..4e4e45263a 100644 --- a/latest/docs-ref-autogen/account/management-group/entities.yml +++ b/latest/docs-ref-autogen/account/management-group/entities.yml @@ -47,5 +47,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Entity operations (Management Group and Subscriptions) for Management Groups. diff --git a/latest/docs-ref-autogen/account/management-group/hierarchy-settings.yml b/latest/docs-ref-autogen/account/management-group/hierarchy-settings.yml index 1765ca90da..8273695000 100644 --- a/latest/docs-ref-autogen/account/management-group/hierarchy-settings.yml +++ b/latest/docs-ref-autogen/account/management-group/hierarchy-settings.yml @@ -177,5 +177,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy. diff --git a/latest/docs-ref-autogen/account/management-group/subscription.yml b/latest/docs-ref-autogen/account/management-group/subscription.yml index 572dfc76f3..523464ad76 100644 --- a/latest/docs-ref-autogen/account/management-group/subscription.yml +++ b/latest/docs-ref-autogen/account/management-group/subscription.yml @@ -130,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Subscription operations for Management Groups. diff --git a/latest/docs-ref-autogen/account/management-group/tenant-backfill.yml b/latest/docs-ref-autogen/account/management-group/tenant-backfill.yml index 037d92a58d..8d240dd236 100644 --- a/latest/docs-ref-autogen/account/management-group/tenant-backfill.yml +++ b/latest/docs-ref-autogen/account/management-group/tenant-backfill.yml @@ -62,5 +62,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/19/2022 + ms.date: 09/19/2023 description: Backfill Tenant Subscription Operations for Management Groups. diff --git a/latest/docs-ref-autogen/acr/agentpool.yml b/latest/docs-ref-autogen/acr/agentpool.yml index a44e57a32f..c8876fb011 100644 --- a/latest/docs-ref-autogen/acr/agentpool.yml +++ b/latest/docs-ref-autogen/acr/agentpool.yml @@ -233,5 +233,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage private Tasks agent pools with Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/cache.yml b/latest/docs-ref-autogen/acr/cache.yml index 67bbcaab50..893ade96f7 100644 --- a/latest/docs-ref-autogen/acr/cache.yml +++ b/latest/docs-ref-autogen/acr/cache.yml @@ -203,5 +203,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage cache rules in Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/config.yml b/latest/docs-ref-autogen/acr/config.yml index a12612412d..02694cb215 100644 --- a/latest/docs-ref-autogen/acr/config.yml +++ b/latest/docs-ref-autogen/acr/config.yml @@ -43,5 +43,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Configure policies for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/config/authentication-as-arm.yml b/latest/docs-ref-autogen/acr/config/authentication-as-arm.yml index 44ef90c1f2..90fd784b28 100644 --- a/latest/docs-ref-autogen/acr/config/authentication-as-arm.yml +++ b/latest/docs-ref-autogen/acr/config/authentication-as-arm.yml @@ -94,5 +94,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage 'Azure AD authenticate as ARM' policy for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/config/content-trust.yml b/latest/docs-ref-autogen/acr/config/content-trust.yml index 13e5b1ea44..2307b788f3 100644 --- a/latest/docs-ref-autogen/acr/config/content-trust.yml +++ b/latest/docs-ref-autogen/acr/config/content-trust.yml @@ -85,5 +85,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage content-trust policy for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/config/retention.yml b/latest/docs-ref-autogen/acr/config/retention.yml index 86c1e72939..76b5b6d863 100644 --- a/latest/docs-ref-autogen/acr/config/retention.yml +++ b/latest/docs-ref-autogen/acr/config/retention.yml @@ -105,5 +105,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage retention policy for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/config/soft-delete.yml b/latest/docs-ref-autogen/acr/config/soft-delete.yml index ef2ca5b5ba..e32e2a688e 100644 --- a/latest/docs-ref-autogen/acr/config/soft-delete.yml +++ b/latest/docs-ref-autogen/acr/config/soft-delete.yml @@ -90,5 +90,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage soft-delete policy for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/connected-registry.yml b/latest/docs-ref-autogen/acr/connected-registry.yml index 635a946f9c..5fdf1fe49a 100644 --- a/latest/docs-ref-autogen/acr/connected-registry.yml +++ b/latest/docs-ref-autogen/acr/connected-registry.yml @@ -332,10 +332,10 @@ directCommands: optionalParameters: - name: --add summary: |- - Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --remove summary: |- - Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -479,5 +479,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage connected registry resources with Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/connected-registry/install.yml b/latest/docs-ref-autogen/acr/connected-registry/install.yml index 60709e6d8d..c7bb7f4d5a 100644 --- a/latest/docs-ref-autogen/acr/connected-registry/install.yml +++ b/latest/docs-ref-autogen/acr/connected-registry/install.yml @@ -119,5 +119,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Help to access the necessary information for installing a connected registry. Please see https://aka.ms/acr/connected-registry for more information. diff --git a/latest/docs-ref-autogen/acr/connected-registry/permissions.yml b/latest/docs-ref-autogen/acr/connected-registry/permissions.yml index b635fd411e..c46c23df1b 100644 --- a/latest/docs-ref-autogen/acr/connected-registry/permissions.yml +++ b/latest/docs-ref-autogen/acr/connected-registry/permissions.yml @@ -75,10 +75,10 @@ directCommands: optionalParameters: - name: --add summary: |- - Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be added to the targeted connected registry and it's ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --remove summary: |- - Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be removed from the targeted connected registry and it's succesors sync scope maps. Use the format "--remove [REPO1 REPO2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -110,5 +110,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage the repository permissions accross multiple connected registries. Please see https://aka.ms/acr/connected-registry for more information. diff --git a/latest/docs-ref-autogen/acr/credential-set.yml b/latest/docs-ref-autogen/acr/credential-set.yml index 266d16fb94..e82322248e 100644 --- a/latest/docs-ref-autogen/acr/credential-set.yml +++ b/latest/docs-ref-autogen/acr/credential-set.yml @@ -196,5 +196,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credential sets in Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/credential.yml b/latest/docs-ref-autogen/acr/credential.yml index 80128cb7a8..186141b45f 100644 --- a/latest/docs-ref-autogen/acr/credential.yml +++ b/latest/docs-ref-autogen/acr/credential.yml @@ -95,5 +95,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage login credentials for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/encryption.yml b/latest/docs-ref-autogen/acr/encryption.yml index 988ac080c5..084fd47a1d 100644 --- a/latest/docs-ref-autogen/acr/encryption.yml +++ b/latest/docs-ref-autogen/acr/encryption.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: For more information, see http://aka.ms/acr/cmk. diff --git a/latest/docs-ref-autogen/acr/helm.yml b/latest/docs-ref-autogen/acr/helm.yml index 004848d689..ff75b77515 100644 --- a/latest/docs-ref-autogen/acr/helm.yml +++ b/latest/docs-ref-autogen/acr/helm.yml @@ -258,5 +258,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage helm charts for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/helm/repo.yml b/latest/docs-ref-autogen/acr/helm/repo.yml index f9c91427b9..41fdece153 100644 --- a/latest/docs-ref-autogen/acr/helm/repo.yml +++ b/latest/docs-ref-autogen/acr/helm/repo.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage helm chart repositories for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/identity.yml b/latest/docs-ref-autogen/acr/identity.yml index c7e57e0e5a..b9601f2ea6 100644 --- a/latest/docs-ref-autogen/acr/identity.yml +++ b/latest/docs-ref-autogen/acr/identity.yml @@ -104,5 +104,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage service (managed) identities for a container registry. diff --git a/latest/docs-ref-autogen/acr/manifest.yml b/latest/docs-ref-autogen/acr/manifest.yml index 7b57d58eac..25810d9a7d 100644 --- a/latest/docs-ref-autogen/acr/manifest.yml +++ b/latest/docs-ref-autogen/acr/manifest.yml @@ -568,5 +568,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage artifact manifests in Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/manifest/metadata.yml b/latest/docs-ref-autogen/acr/manifest/metadata.yml index 688efccfe6..8f6819c925 100644 --- a/latest/docs-ref-autogen/acr/manifest/metadata.yml +++ b/latest/docs-ref-autogen/acr/manifest/metadata.yml @@ -179,5 +179,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage artifact manifest metadata in Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/network-rule.yml b/latest/docs-ref-autogen/acr/network-rule.yml index 4e1b046c58..577b3d6a5e 100644 --- a/latest/docs-ref-autogen/acr/network-rule.yml +++ b/latest/docs-ref-autogen/acr/network-rule.yml @@ -18,12 +18,6 @@ directCommands: [--ip-address] [--resource-group] examples: - - summary: |- - Add a rule to allow access for a subnet in the same resource group as the registry. - syntax: az acr network-rule add -n MyRegistry --vnet-name myvnet --subnet mysubnet - - summary: |- - Add a rule to allow access for a subnet in a different subscription or resource group. - syntax: az acr network-rule add -n MyRegistry --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet - summary: |- Add a rule to allow access for a specific IP address-range. syntax: az acr network-rule add -n MyRegistry --ip-address 23.45.1.0/24 @@ -74,12 +68,6 @@ directCommands: [--ip-address] [--resource-group] examples: - - summary: |- - Remove a rule that allows access for a subnet in the same resource group as the registry. - syntax: az acr network-rule remove -n MyRegistry --vnet-name myvnet --subnet mysubnet - - summary: |- - Remove a rule that allows access for a subnet in a different subscription or resource group. - syntax: az acr network-rule remove -n MyRegistry --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet - summary: |- Remove a rule that allows access for a specific IP address-range. syntax: az acr network-rule remove -n MyRegistry --ip-address 23.45.1.0/24 @@ -124,5 +112,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage network rules for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/pack.yml b/latest/docs-ref-autogen/acr/pack.yml index f66af0a638..9a35cf3680 100644 --- a/latest/docs-ref-autogen/acr/pack.yml +++ b/latest/docs-ref-autogen/acr/pack.yml @@ -121,5 +121,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage Azure Container Registry Tasks that use Cloud Native Buildpacks. diff --git a/latest/docs-ref-autogen/acr/private-endpoint-connection.yml b/latest/docs-ref-autogen/acr/private-endpoint-connection.yml index a27e7156ed..01d5a8863e 100644 --- a/latest/docs-ref-autogen/acr/private-endpoint-connection.yml +++ b/latest/docs-ref-autogen/acr/private-endpoint-connection.yml @@ -172,5 +172,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: To create a private endpoint connection use "az network private-endpoint create". For more information see https://aka.ms/acr/private-link. diff --git a/latest/docs-ref-autogen/acr/private-link-resource.yml b/latest/docs-ref-autogen/acr/private-link-resource.yml index 03c7c6440b..9d87a4289a 100644 --- a/latest/docs-ref-autogen/acr/private-link-resource.yml +++ b/latest/docs-ref-autogen/acr/private-link-resource.yml @@ -52,5 +52,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage registry private link resources. diff --git a/latest/docs-ref-autogen/acr/replication.yml b/latest/docs-ref-autogen/acr/replication.yml index cadc60db42..d0e0848bf7 100644 --- a/latest/docs-ref-autogen/acr/replication.yml +++ b/latest/docs-ref-autogen/acr/replication.yml @@ -228,5 +228,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage geo-replicated regions of Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/repository.yml b/latest/docs-ref-autogen/acr/repository.yml index 971b7969b9..bcfdf0cd70 100644 --- a/latest/docs-ref-autogen/acr/repository.yml +++ b/latest/docs-ref-autogen/acr/repository.yml @@ -422,5 +422,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage repositories (image names) for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/scope-map.yml b/latest/docs-ref-autogen/acr/scope-map.yml index 7bac9698fa..25832cb0ab 100644 --- a/latest/docs-ref-autogen/acr/scope-map.yml +++ b/latest/docs-ref-autogen/acr/scope-map.yml @@ -45,10 +45,10 @@ directCommands: Description for the scope map. Maximum 256 characters are allowed. - name: --gateway summary: |- - Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/write', 'config/read', 'message/read'}. + Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --repository summary: |- - Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -167,19 +167,19 @@ directCommands: optionalParameters: - name: --add-gateway summary: |- - Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/write', 'config/read', 'message/read'}. + Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --add-repository summary: |- - Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --description summary: |- Description for the scope map. Maximum 256 characters are allowed. - name: --remove-gateway summary: |- - Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/write', 'config/read', 'message/read'}. + Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --remove-repository summary: |- - Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -214,5 +214,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage scope access maps for Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/task.yml b/latest/docs-ref-autogen/acr/task.yml index 30adab89ee..bdb54d6165 100644 --- a/latest/docs-ref-autogen/acr/task.yml +++ b/latest/docs-ref-autogen/acr/task.yml @@ -808,5 +808,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage a collection of steps for building, testing and OS & Framework patching container images using Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/task/credential.yml b/latest/docs-ref-autogen/acr/task/credential.yml index 5f72143b91..2b03af8ce1 100644 --- a/latest/docs-ref-autogen/acr/task/credential.yml +++ b/latest/docs-ref-autogen/acr/task/credential.yml @@ -219,5 +219,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credentials for a task. Please see https://aka.ms/acr/tasks/cross-registry-authentication for more information. diff --git a/latest/docs-ref-autogen/acr/task/identity.yml b/latest/docs-ref-autogen/acr/task/identity.yml index c884a8a959..bb6e3837bb 100644 --- a/latest/docs-ref-autogen/acr/task/identity.yml +++ b/latest/docs-ref-autogen/acr/task/identity.yml @@ -145,5 +145,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Managed Identities for Task. Please see https://aka.ms/acr/tasks/task-create-managed-identity for more information. diff --git a/latest/docs-ref-autogen/acr/task/timer.yml b/latest/docs-ref-autogen/acr/task/timer.yml index cadb3b2daf..43572552ad 100644 --- a/latest/docs-ref-autogen/acr/task/timer.yml +++ b/latest/docs-ref-autogen/acr/task/timer.yml @@ -186,5 +186,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage timer triggers for a task. diff --git a/latest/docs-ref-autogen/acr/taskrun.yml b/latest/docs-ref-autogen/acr/taskrun.yml index d60602d4d1..3774ccedd5 100644 --- a/latest/docs-ref-autogen/acr/taskrun.yml +++ b/latest/docs-ref-autogen/acr/taskrun.yml @@ -163,5 +163,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage taskruns using Azure Container Registries. diff --git a/latest/docs-ref-autogen/acr/token.yml b/latest/docs-ref-autogen/acr/token.yml index 9534234f29..37bc7a9797 100644 --- a/latest/docs-ref-autogen/acr/token.yml +++ b/latest/docs-ref-autogen/acr/token.yml @@ -57,14 +57,14 @@ directCommands: Number of days for which the credentials will be valid. If not specified, the expiration will default to the max value "9999-12-31T23:59:59.999999+00:00". - name: --gateway summary: |- - Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/write', 'config/read', 'message/read'}. + Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are ['config/read', 'config/write', 'message/read', 'message/write']. - name: --no-passwords parameterValueGroup: "false, true" summary: |- Do not generate passwords during token creation. You can generate the passwords after the token is created by using `az acr token credentials generate` command. - name: --repository summary: |- - Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'metadata/read', 'content/read'}. + Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are ['content/delete', 'content/read', 'content/write', 'metadata/read', 'metadata/write']. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -231,5 +231,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage tokens for an Azure Container Registry. diff --git a/latest/docs-ref-autogen/acr/token/credential.yml b/latest/docs-ref-autogen/acr/token/credential.yml index ffa6e31909..6df3ae192d 100644 --- a/latest/docs-ref-autogen/acr/token/credential.yml +++ b/latest/docs-ref-autogen/acr/token/credential.yml @@ -118,5 +118,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage credentials of a token for an Azure Container Registry. diff --git a/latest/docs-ref-autogen/acr/webhook.yml b/latest/docs-ref-autogen/acr/webhook.yml index 4afab2dded..421f340e1c 100644 --- a/latest/docs-ref-autogen/acr/webhook.yml +++ b/latest/docs-ref-autogen/acr/webhook.yml @@ -350,5 +350,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/27/2023 + ms.date: 09/15/2023 description: Manage webhooks for Azure Container Registries. diff --git a/latest/docs-ref-autogen/aks.yml b/latest/docs-ref-autogen/aks.yml index 519a70a1ea..091fe04613 100644 --- a/latest/docs-ref-autogen/aks.yml +++ b/latest/docs-ref-autogen/aks.yml @@ -1026,6 +1026,7 @@ directCommands: [--http-proxy-config] [--image-cleaner-interval-hours] [--ip-families] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -1084,7 +1085,7 @@ directCommands: [--snapshot-id] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--vm-set-type] [--vnet-subnet-id] [--windows-admin-password] @@ -1561,6 +1562,10 @@ directCommands: A comma separated list of IP versions to use for cluster networking. description: |- Each IP version should be in the format IPvN. For example, IPv4. + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -1810,7 +1815,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' does not have a financially backed SLA. - name: --vm-set-type @@ -2005,17 +2010,17 @@ directCommands: Enable Kubernetes addons. description: |- These addons are available: - - http_application_routing : configure ingress with automatic public DNS name creation. - - monitoring : turn on Log Analytics monitoring. Requires "--workspace-resource-id". - Requires "--enable-msi-auth-for-monitoring" for managed identity auth. - Requires "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled - If monitoring addon is enabled --no-wait argument will have no effect - - virtual-node : enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. - - azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner. - Learn more at aka.ms/aks/policy. - - ingress-appgw : enable Application Gateway Ingress Controller addon. - - open-service-mesh : enable Open Service Mesh addon. - - azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon. + - http_application_routing : configure ingress with automatic public DNS name creation. + - monitoring : turn on Log Analytics monitoring. Requires "--workspace-resource-id". + Requires "--enable-msi-auth-for-monitoring" for managed identity auth. + Requires "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled + If monitoring addon is enabled --no-wait argument will have no effect + - virtual-node : enable AKS Virtual Node. Requires --subnet-name to provide the name of an existing subnet for the Virtual Node to use. + - azure-policy : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner. + Learn more at aka.ms/aks/policy. + - ingress-appgw : enable Application Gateway Ingress Controller addon. + - open-service-mesh : enable Open Service Mesh addon. + - azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon. status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/acs/_help.py @@ -3034,6 +3039,7 @@ directCommands: [--disable-defender] [--disable-disk-driver] [--disable-file-driver] + [--disable-force-upgrade] [--disable-image-cleaner] [--disable-keda] [--disable-local-accounts] @@ -3041,6 +3047,7 @@ directCommands: [--disable-secret-rotation] [--disable-snapshot-controller] [--disable-vpa] + [--disable-windows-gmsa] [--disable-workload-identity] [--enable-aad] [--enable-ahub] @@ -3052,6 +3059,7 @@ directCommands: [--enable-defender] [--enable-disk-driver] [--enable-file-driver] + [--enable-force-upgrade] [--enable-image-cleaner] [--enable-keda] [--enable-local-accounts] @@ -3090,10 +3098,12 @@ directCommands: [--nodepool-taints] [--outbound-type {loadBalancer, managedNATGateway, userAssignedNATGateway, userDefinedRouting}] [--pod-cidr] + [--private-dns-zone] [--rotation-poll-interval] [--tags] [--tier {free, premium, standard}] [--update-cluster-autoscaler] + [--upgrade-override-until] [--windows-admin-password] [--yes] examples: @@ -3169,6 +3179,9 @@ directCommands: - summary: |- Enable Windows gmsa for a kubernetes cluster without setting DNS server in the vnet used by the cluster. syntax: az aks update -g MyResourceGroup -n MyManagedCluster --enable-windows-gmsa --gmsa-dns-server "10.240.0.4" --gmsa-root-domain-name "contoso.com" + - summary: |- + Disable Windows gmsa for a kubernetes cluster. + syntax: az aks update -g MyResourceGroup -n MyManagedCluster --disable-windows-gmsa - summary: |- Enable KEDA workload autoscaler for an existing kubernetes cluster. syntax: az aks update -g MyResourceGroup -n MyManagedCluster --enable-keda @@ -3275,6 +3288,10 @@ directCommands: defaultValue: "False" summary: |- Disable AzureFile CSI Driver. + - name: --disable-force-upgrade + defaultValue: "False" + summary: |- + Disable forceUpgrade cluster upgrade settings override. - name: --disable-image-cleaner defaultValue: "False" summary: |- @@ -3303,6 +3320,10 @@ directCommands: defaultValue: "False" summary: |- Disable vertical pod autoscaler for cluster. + - name: --disable-windows-gmsa + defaultValue: "False" + summary: |- + Disable Windows gmsa on cluster. - name: --disable-workload-identity defaultValue: "False" summary: |- @@ -3346,6 +3367,10 @@ directCommands: defaultValue: "False" summary: |- Enable AzureFile CSI Driver. + - name: --enable-force-upgrade + defaultValue: "False" + summary: |- + Enable forceUpgrade cluster upgrade settings override. - name: --enable-image-cleaner defaultValue: "False" summary: |- @@ -3503,6 +3528,11 @@ directCommands: - name: --pod-cidr summary: |- Update the pod CIDR for a cluster. Used when updating a cluster from Azure CNI to Azure CNI Overlay. + - name: --private-dns-zone + summary: |- + The private dns zone mode for private cluster. + description: |- + Only allow changing private dns zone from byo/system mode to none for private cluster. Others are denied. - name: --rotation-poll-interval summary: |- Set interval of rotation poll. Use with azure-keyvault-secrets-provider addon. @@ -3517,6 +3547,9 @@ directCommands: defaultValue: "False" summary: |- Update min-count or max-count for cluster autoscaler. + - name: --upgrade-override-until + summary: |- + Until when the cluster upgradeSettings overrides are effective. It needs to be in a valid date-time format that's within the next 30 days. For example, 2023-04-01T13:00:00Z. Note that if --force-upgrade is set to true and --upgrade-override-until is not set, by default it will be set to 3 days from now. - name: --windows-admin-password summary: |- User account password to use on windows node VMs. @@ -3628,6 +3661,7 @@ directCommands: [--guardrails-version] [--http-proxy-config] [--image-cleaner-interval-hours] + [--k8s-support-plan {AKSLongTermSupport, KubernetesOfficial}] [--ksm-metric-annotations-allow-list] [--ksm-metric-labels-allow-list] [--kube-proxy-config] @@ -3655,7 +3689,7 @@ directCommands: [--rotation-poll-interval] [--ssh-key-value] [--tags] - [--tier {free, standard}] + [--tier {free, premium, standard}] [--update-cluster-autoscaler] [--upgrade-override-until] [--windows-admin-password] @@ -4102,6 +4136,10 @@ directCommands: summary: |- ImageCleaner scanning interval. isPreview: true + - name: --k8s-support-plan + parameterValueGroup: "AKSLongTermSupport, KubernetesOfficial" + summary: |- + Choose from "KubernetesOfficial" or "AKSLongTermSupport", with "AKSLongTermSupport" you get 1 extra year of CVE patchs. - name: --ksm-metric-annotations-allow-list summary: |- Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (e.g.'=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'. A single '*' can be provided per resource instead to allow any labels, but that has severe performance implications (e.g. '=pods=[*]'). @@ -4220,7 +4258,7 @@ directCommands: summary: |- The tags of the managed cluster. The managed cluster instance and all resources managed by the cloud provider will be tagged. - name: --tier - parameterValueGroup: "free, standard" + parameterValueGroup: "free, premium, standard" summary: |- Specify SKU tier for managed clusters. '--tier standard' enables a standard managed cluster service with a financially backed SLA. '--tier free' changes a standard managed cluster to a free one. - name: --update-cluster-autoscaler -u @@ -4680,6 +4718,9 @@ commands: - az_aks_kollect(aks-preview) - az_aks_list() - az_aks_list(aks-preview) +- az_aks_machine +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) - az_aks_maintenanceconfiguration - az_aks_maintenanceconfiguration_add() - az_aks_maintenanceconfiguration_add(aks-preview) diff --git a/latest/docs-ref-autogen/aks/command.yml b/latest/docs-ref-autogen/aks/command.yml index a6ae0bd77a..eab2a68208 100644 --- a/latest/docs-ref-autogen/aks/command.yml +++ b/latest/docs-ref-autogen/aks/command.yml @@ -91,5 +91,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/17/2023 + ms.date: 09/19/2023 description: See detail usage in 'az aks command invoke', 'az aks command result'. diff --git a/latest/docs-ref-autogen/aks/machine.yml b/latest/docs-ref-autogen/aks/machine.yml new file mode 100644 index 0000000000..0562e9ba0f --- /dev/null +++ b/latest/docs-ref-autogen/aks/machine.yml @@ -0,0 +1,92 @@ +### YamlMime:AzureCLIGroup +uid: az_aks_machine +name: az aks machine +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **aks-preview** extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an **az aks machine** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Get information about machines in a nodepool of a managed clusters. +status: GA +sourceType: Extension +directCommands: +- uid: az_aks_machine_list(aks-preview) + name: az aks machine list + summary: |- + Get information about IP Addresses, Hostname for all machines in an agentpool. + status: GA + sourceType: Extension + syntax: >- + az aks machine list --cluster-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_aks_machine_show(aks-preview) + name: az aks machine show + summary: |- + Show IP Addresses, Hostname for a specific machine in an agentpool for a managedcluster. + status: GA + sourceType: Extension + syntax: >- + az aks machine show --cluster-name + --machine-name + --nodepool-name + --resource-group + requiredParameters: + - isRequired: true + name: --cluster-name + summary: |- + Name of the managed cluster. + - isRequired: true + name: --machine-name + summary: |- + Get IP Addresses, Hostname for a specific machine in an agentpool. + - isRequired: true + name: --nodepool-name + summary: |- + Name of the agentpool of a managed cluster. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. +commands: +- az_aks_machine_list(aks-preview) +- az_aks_machine_show(aks-preview) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Get information about machines in a nodepool of a managed clusters. diff --git a/latest/docs-ref-autogen/aks/oidc-issuer.yml b/latest/docs-ref-autogen/aks/oidc-issuer.yml index bb713bf3a0..fef307d8c8 100644 --- a/latest/docs-ref-autogen/aks/oidc-issuer.yml +++ b/latest/docs-ref-autogen/aks/oidc-issuer.yml @@ -63,5 +63,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/17/2023 + ms.date: 09/19/2023 description: Oidc issuer related commands. diff --git a/latest/docs-ref-autogen/ams/asset.yml b/latest/docs-ref-autogen/ams/asset.yml index 2f518061fa..6cc2069b90 100644 --- a/latest/docs-ref-autogen/ams/asset.yml +++ b/latest/docs-ref-autogen/ams/asset.yml @@ -125,7 +125,7 @@ directCommands: summary: |- The name of the Azure Media Services account. - name: --expiry - defaultValue: "2023-09-22 07:33:50.141780" + defaultValue: "2023-09-29 11:11:13.888145" summary: |- Specifies the UTC datetime (Y-m-d'T'H:M:S'Z') at which the SAS becomes invalid. This must be less than 24 hours from the current time. - name: --ids diff --git a/latest/docs-ref-autogen/backup.yml b/latest/docs-ref-autogen/backup.yml index 99c64b9529..04c9f4a8d1 100644 --- a/latest/docs-ref-autogen/backup.yml +++ b/latest/docs-ref-autogen/backup.yml @@ -74,6 +74,7 @@ commands: - az_backup_vault_identity_remove() - az_backup_vault_identity_show() - az_backup_vault_list() +- az_backup_vault_list-soft-deleted-containers() - az_backup_vault_resource-guard-mapping - az_backup_vault_resource-guard-mapping_delete() - az_backup_vault_resource-guard-mapping_show() @@ -104,5 +105,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Manage Azure Backups. diff --git a/latest/docs-ref-autogen/backup/container.yml b/latest/docs-ref-autogen/backup/container.yml index 4668b5e63d..1960860f0d 100644 --- a/latest/docs-ref-autogen/backup/container.yml +++ b/latest/docs-ref-autogen/backup/container.yml @@ -248,5 +248,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Resource which houses items or applications to be protected. diff --git a/latest/docs-ref-autogen/backup/item.yml b/latest/docs-ref-autogen/backup/item.yml index a0c63aa04c..7643c90639 100644 --- a/latest/docs-ref-autogen/backup/item.yml +++ b/latest/docs-ref-autogen/backup/item.yml @@ -185,5 +185,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: An item which is already protected or backed up to an Azure Recovery services vault with an associated policy. diff --git a/latest/docs-ref-autogen/backup/job.yml b/latest/docs-ref-autogen/backup/job.yml index 2aa0907091..65c77b43da 100644 --- a/latest/docs-ref-autogen/backup/job.yml +++ b/latest/docs-ref-autogen/backup/job.yml @@ -202,5 +202,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Entity which contains details of the job. diff --git a/latest/docs-ref-autogen/backup/policy.yml b/latest/docs-ref-autogen/backup/policy.yml index 9ff00a98c3..b3910a58d1 100644 --- a/latest/docs-ref-autogen/backup/policy.yml +++ b/latest/docs-ref-autogen/backup/policy.yml @@ -307,5 +307,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: A backup policy defines when you want to take a backup and for how long you would retain each backup copy. diff --git a/latest/docs-ref-autogen/backup/protectable-item.yml b/latest/docs-ref-autogen/backup/protectable-item.yml index c14695f094..3fb317721e 100644 --- a/latest/docs-ref-autogen/backup/protectable-item.yml +++ b/latest/docs-ref-autogen/backup/protectable-item.yml @@ -169,5 +169,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Manage the item which is yet to be protected or backed up to an Azure Recovery services vault with an associated policy. diff --git a/latest/docs-ref-autogen/backup/protection.yml b/latest/docs-ref-autogen/backup/protection.yml index ce0a3130c3..947c454c91 100644 --- a/latest/docs-ref-autogen/backup/protection.yml +++ b/latest/docs-ref-autogen/backup/protection.yml @@ -583,5 +583,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Manage protection of your items, enable protection or disable it, or take on-demand backups. diff --git a/latest/docs-ref-autogen/backup/recoveryconfig.yml b/latest/docs-ref-autogen/backup/recoveryconfig.yml index e549d86089..a47e3b03fa 100644 --- a/latest/docs-ref-autogen/backup/recoveryconfig.yml +++ b/latest/docs-ref-autogen/backup/recoveryconfig.yml @@ -137,5 +137,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Manage recovery configuration of an Azure workload backed up item. diff --git a/latest/docs-ref-autogen/backup/recoverypoint.yml b/latest/docs-ref-autogen/backup/recoverypoint.yml index 7b37adf96c..c929ad774a 100644 --- a/latest/docs-ref-autogen/backup/recoverypoint.yml +++ b/latest/docs-ref-autogen/backup/recoverypoint.yml @@ -283,5 +283,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: A snapshot of data at that point-of-time, stored in Recovery Services Vault, from which you can restore information. diff --git a/latest/docs-ref-autogen/backup/restore.yml b/latest/docs-ref-autogen/backup/restore.yml index 30a49518f5..1a54caf326 100644 --- a/latest/docs-ref-autogen/backup/restore.yml +++ b/latest/docs-ref-autogen/backup/restore.yml @@ -358,5 +358,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Restore backed up items from recovery points in a Recovery Services vault. diff --git a/latest/docs-ref-autogen/backup/restore/files.yml b/latest/docs-ref-autogen/backup/restore/files.yml index 2d97ba3350..7a101c1d1a 100644 --- a/latest/docs-ref-autogen/backup/restore/files.yml +++ b/latest/docs-ref-autogen/backup/restore/files.yml @@ -116,5 +116,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Gives access to all files of a recovery point. diff --git a/latest/docs-ref-autogen/backup/vault.yml b/latest/docs-ref-autogen/backup/vault.yml index e9fb837a2e..262ff9717c 100644 --- a/latest/docs-ref-autogen/backup/vault.yml +++ b/latest/docs-ref-autogen/backup/vault.yml @@ -117,6 +117,42 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_backup_vault_list-soft-deleted-containers() + name: az backup vault list-soft-deleted-containers + summary: |- + List soft-deleted containers within a particular Recovery Services vault. + status: GA + sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/backup/_help.py + syntax: >- + az backup vault list-soft-deleted-containers --backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload} + [--ids] + [--name] + [--resource-group] + [--subscription] + examples: + - summary: |- + List soft deleted containers + syntax: az backup vault list-soft-deleted-containers --name MyRecoveryServicesVault --resource-group MyResourceGroup --backup-management-type AzureIaasVM + requiredParameters: + - isRequired: true + name: --backup-management-type + parameterValueGroup: "AzureIaasVM, AzureStorage, AzureWorkload" + summary: |- + Specify the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name -n + summary: |- + Name of the Recovery services vault. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_backup_vault_show() name: az backup vault show summary: |- @@ -160,6 +196,7 @@ commands: - az_backup_vault_identity_remove() - az_backup_vault_identity_show() - az_backup_vault_list() +- az_backup_vault_list-soft-deleted-containers() - az_backup_vault_resource-guard-mapping - az_backup_vault_resource-guard-mapping_delete() - az_backup_vault_resource-guard-mapping_show() @@ -190,5 +227,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Online storage entity in Azure used to hold data such as backup copies, recovery points and backup policies. diff --git a/latest/docs-ref-autogen/backup/vault/backup-properties.yml b/latest/docs-ref-autogen/backup/vault/backup-properties.yml index 796a780362..e48d2952e2 100644 --- a/latest/docs-ref-autogen/backup/vault/backup-properties.yml +++ b/latest/docs-ref-autogen/backup/vault/backup-properties.yml @@ -22,7 +22,8 @@ directCommands: [--job-failure-alerts {Disable, Enable}] [--name] [--resource-group] - [--soft-delete-feature-state {Disable, Enable}] + [--soft-delete-duration] + [--soft-delete-feature-state {AlwaysOn, Disable, Enable}] [--subscription] [--tenant-id] examples: @@ -59,8 +60,11 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --soft-delete-duration + summary: |- + Set soft-delete retention duration time in days for a Recovery Services Vault. - name: --soft-delete-feature-state - parameterValueGroup: "Disable, Enable" + parameterValueGroup: "AlwaysOn, Disable, Enable" summary: |- Set soft-delete feature state for a Recovery Services Vault. - name: --subscription @@ -126,5 +130,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Properties of the Recovery Services vault. diff --git a/latest/docs-ref-autogen/backup/vault/encryption.yml b/latest/docs-ref-autogen/backup/vault/encryption.yml index 769ef7be46..7f5c0058c7 100644 --- a/latest/docs-ref-autogen/backup/vault/encryption.yml +++ b/latest/docs-ref-autogen/backup/vault/encryption.yml @@ -114,5 +114,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Encryption details of a Recovery Services Vault. diff --git a/latest/docs-ref-autogen/backup/vault/identity.yml b/latest/docs-ref-autogen/backup/vault/identity.yml index a1fc999c8b..130eaeb485 100644 --- a/latest/docs-ref-autogen/backup/vault/identity.yml +++ b/latest/docs-ref-autogen/backup/vault/identity.yml @@ -138,5 +138,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Identity details of a Recovery Services Vault. diff --git a/latest/docs-ref-autogen/backup/vault/resource-guard-mapping.yml b/latest/docs-ref-autogen/backup/vault/resource-guard-mapping.yml index 1627294d5d..59c14e9d06 100644 --- a/latest/docs-ref-autogen/backup/vault/resource-guard-mapping.yml +++ b/latest/docs-ref-autogen/backup/vault/resource-guard-mapping.yml @@ -141,5 +141,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 05/29/2023 + ms.date: 09/19/2023 description: Resource Guard Mapping details of the Recovery Services vault. diff --git a/latest/docs-ref-autogen/containerapp/connection.yml b/latest/docs-ref-autogen/containerapp/connection.yml index c65eca91b8..62f0fe7ed2 100644 --- a/latest/docs-ref-autogen/containerapp/connection.yml +++ b/latest/docs-ref-autogen/containerapp/connection.yml @@ -12,6 +12,7 @@ directCommands: Delete a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection delete [--connection] [--id] @@ -38,14 +39,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -56,6 +57,7 @@ directCommands: List connections of a containerapp. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list [--name] [--resource-group] @@ -73,10 +75,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -86,6 +88,7 @@ directCommands: List source configurations of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection list-configuration [--connection] [--id] @@ -110,16 +113,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_list-support-types() name: az containerapp connection list-support-types summary: |- List client types and auth types supported by containerapp connections. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: az containerapp connection list-support-types [--target-type {appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}] examples: - summary: |- @@ -139,6 +143,7 @@ directCommands: Get the details of a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection show [--connection] [--id] @@ -163,16 +168,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_validate() name: az containerapp connection validate summary: |- Validate a containerapp connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection validate [--connection] [--id] @@ -197,16 +203,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - uid: az_containerapp_connection_wait() name: az containerapp connection wait summary: |- Place the CLI in a waiting state until a condition of the connection is met. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection wait [--connection] [--created] @@ -251,10 +258,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- @@ -344,4 +351,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Commands to manage containerapp connections. diff --git a/latest/docs-ref-autogen/containerapp/connection/create.yml b/latest/docs-ref-autogen/containerapp/connection/create.yml index b07b1e4f10..28f82f023d 100644 --- a/latest/docs-ref-autogen/containerapp/connection/create.yml +++ b/latest/docs-ref-autogen/containerapp/connection/create.yml @@ -12,6 +12,7 @@ directCommands: Create a containerapp connection to appconfig. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create appconfig [--app-config] [--client-type {dotnet, java, nodejs, none, python}] @@ -59,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -116,6 +117,7 @@ directCommands: Create a containerapp connection to confluent-cloud. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create confluent-cloud --bootstrap-server --kafka-key @@ -177,14 +179,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified. @@ -197,6 +199,7 @@ directCommands: Create a containerapp connection to cosmos-cassandra. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-cassandra [--account] [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] @@ -249,7 +252,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -260,7 +263,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,6 +313,7 @@ directCommands: Create a containerapp connection to cosmos-gremlin. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-gremlin [--account] [--client-type {dotnet, java, nodejs, none, php, python}] @@ -366,7 +370,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -377,7 +381,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -427,6 +431,7 @@ directCommands: Create a containerapp connection to cosmos-mongo. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-mongo [--account] [--client-type {dotnet, go, java, nodejs, none, springBoot}] @@ -479,7 +484,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -490,7 +495,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -540,6 +545,7 @@ directCommands: Create a containerapp connection to cosmos-sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-sql [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -592,7 +598,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -603,7 +609,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -653,6 +659,7 @@ directCommands: Create a containerapp connection to cosmos-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create cosmos-table [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -702,7 +709,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -713,7 +720,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -766,6 +773,7 @@ directCommands: Create a containerapp connection to eventhub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -811,7 +819,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -825,7 +833,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -875,6 +883,7 @@ directCommands: Create a containerapp connection to keyvault. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -926,7 +935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -942,7 +951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -992,6 +1001,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1038,7 +1048,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1049,7 +1059,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1087,6 +1097,7 @@ directCommands: Create a containerapp connection to mysql-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1132,14 +1143,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1182,6 +1193,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1236,7 +1248,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1252,7 +1264,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1295,6 +1307,7 @@ directCommands: Create a containerapp connection to postgres-flexible. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1340,14 +1353,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1386,6 +1399,7 @@ directCommands: Create a containerapp connection to redis. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1431,7 +1445,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1442,7 +1456,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1469,6 +1483,7 @@ directCommands: Create a containerapp connection to redis-enterprise. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1513,14 +1528,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1562,7 @@ directCommands: Create a containerapp connection to servicebus. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1592,7 +1608,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1606,7 +1622,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1656,6 +1672,7 @@ directCommands: Create a containerapp connection to signalr. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create signalr [--client-type {dotnet, none}] [--connection] @@ -1700,7 +1717,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1711,7 +1728,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1777,7 @@ directCommands: Create a containerapp connection to sql. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1807,7 +1825,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1818,7 +1836,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1861,6 +1879,7 @@ directCommands: Create a containerapp connection to storage-blob. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-blob [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -1916,7 +1935,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1932,7 +1951,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1982,6 +2001,7 @@ directCommands: Create a containerapp connection to storage-file. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-file [--account] [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] @@ -2027,7 +2047,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2038,7 +2058,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2066,6 +2086,7 @@ directCommands: Create a containerapp connection to storage-queue. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-queue [--account] [--client-type {dotnet, java, nodejs, none, python, springBoot}] @@ -2114,7 +2135,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2125,7 +2146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2175,6 +2196,7 @@ directCommands: Create a containerapp connection to storage-table. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create storage-table [--account] [--client-type {dotnet, java, nodejs, none, python}] @@ -2220,7 +2242,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2231,7 +2253,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2259,6 +2281,7 @@ directCommands: Create a containerapp connection to webpubsub. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection create webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -2303,7 +2326,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2314,7 +2337,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2406,4 +2429,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Create a connection between a containerapp and a target resource. diff --git a/latest/docs-ref-autogen/containerapp/connection/update.yml b/latest/docs-ref-autogen/containerapp/connection/update.yml index 374cae2ad2..11afda4188 100644 --- a/latest/docs-ref-autogen/containerapp/connection/update.yml +++ b/latest/docs-ref-autogen/containerapp/connection/update.yml @@ -12,6 +12,7 @@ directCommands: Update a containerapp to appconfig connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update appconfig [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -53,7 +54,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -64,7 +65,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -101,6 +102,7 @@ directCommands: Update a containerapp to confluent-cloud connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update confluent-cloud --connection [--bootstrap-server] @@ -153,14 +155,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the container app. Required if '--source-id' is not specified. + Name of the container app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--source-id' is not specified. + The resource group which contains the container app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -182,6 +184,7 @@ directCommands: Update a containerapp to cosmos-cassandra connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-cassandra [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -224,7 +227,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -235,7 +238,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -276,6 +279,7 @@ directCommands: Update a containerapp to cosmos-gremlin connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-gremlin [--client-type {dotnet, java, nodejs, none, php, python}] [--connection] @@ -318,7 +322,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -329,7 +333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -370,6 +374,7 @@ directCommands: Update a containerapp to cosmos-mongo connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-mongo [--client-type {dotnet, go, java, nodejs, none, springBoot}] [--connection] @@ -412,7 +417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -423,7 +428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -464,6 +469,7 @@ directCommands: Update a containerapp to cosmos-sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-sql [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -506,7 +512,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -517,7 +523,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -558,6 +564,7 @@ directCommands: Update a containerapp to cosmos-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update cosmos-table [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -600,7 +607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -611,7 +618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,6 +659,7 @@ directCommands: Update a containerapp to eventhub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update eventhub [--client-type {dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot}] [--connection] @@ -694,7 +702,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -705,7 +713,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -746,6 +754,7 @@ directCommands: Update a containerapp to keyvault connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update keyvault [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -787,7 +796,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -798,7 +807,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,6 +845,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -875,7 +885,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -886,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -912,6 +922,7 @@ directCommands: Update a containerapp to mysql-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update mysql-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -950,14 +961,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -988,6 +999,7 @@ directCommands: isDeprecated: true deprecateInfo: This command has been deprecated and will be removed in a future release. sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1028,7 +1040,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1039,7 +1051,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1070,6 +1082,7 @@ directCommands: Update a containerapp to postgres-flexible connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update postgres-flexible [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1108,14 +1121,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,6 +1155,7 @@ directCommands: Update a containerapp to redis connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1180,7 +1194,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1191,7 +1205,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1206,6 +1220,7 @@ directCommands: Update a containerapp to redis-enterprise connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update redis-enterprise [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1243,14 +1258,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1265,6 +1280,7 @@ directCommands: Update a containerapp to servicebus connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update servicebus [--client-type {dotnet, go, java, nodejs, none, python, springBoot}] [--connection] @@ -1307,7 +1323,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1318,7 +1334,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1359,6 +1375,7 @@ directCommands: Update a containerapp to signalr connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update signalr [--client-type {dotnet, none}] [--connection] @@ -1400,7 +1417,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1411,7 +1428,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1448,6 +1465,7 @@ directCommands: Update a containerapp to sql connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update sql [--client-type {django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1488,7 +1506,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1499,7 +1517,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1530,6 +1548,7 @@ directCommands: Update a containerapp to storage-blob connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-blob [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1572,7 +1591,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1583,7 +1602,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1624,6 +1643,7 @@ directCommands: Update a containerapp to storage-file connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-file [--client-type {dotnet, java, nodejs, none, php, python, ruby, springBoot}] [--connection] @@ -1663,7 +1683,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1674,7 +1694,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1693,6 +1713,7 @@ directCommands: Update a containerapp to storage-queue connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-queue [--client-type {dotnet, java, nodejs, none, python, springBoot}] [--connection] @@ -1735,7 +1756,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1746,7 +1767,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1787,6 +1808,7 @@ directCommands: Update a containerapp to storage-table connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update storage-table [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1826,7 +1848,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1837,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1856,6 +1878,7 @@ directCommands: Update a containerapp to webpubsub connection. status: GA sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/containerapp/_help.py syntax: >- az containerapp connection update webpubsub [--client-type {dotnet, java, nodejs, none, python}] [--connection] @@ -1897,7 +1920,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the container app. Required if '--id' is not specified. + Name of the container app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1908,7 +1931,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the container app. Required if '--id' is not specified. + The resource group which contains the container app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1988,4 +2011,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: + ms.date: 09/13/2023 description: Update a containerapp connection. diff --git a/latest/docs-ref-autogen/cosmosdb/postgres.yml b/latest/docs-ref-autogen/cosmosdb/postgres.yml index 0f81a6aa76..c99d74feb7 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres name: az cosmosdb postgres summary: |- Manage Azure Cosmos DB for PostgreSQL resources. -status: Preview -isPreview: true -previewOrExperimentalInfo: 'This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_check-name-availability() name: az cosmosdb postgres check-name-availability summary: |- Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/cluster.yml b/latest/docs-ref-autogen/cosmosdb/postgres/cluster.yml index 9eb2f6c8f4..a6cc2dfd9a 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/cluster.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/cluster.yml @@ -3,18 +3,16 @@ uid: az_cosmosdb_postgres_cluster name: az cosmosdb postgres cluster summary: |- Manage Azure Cosmos DB for PostgreSQL clusters. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_cluster_create() name: az cosmosdb postgres cluster create summary: |- - Create a new cluster with servers. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a new cluster with nodes. + description: |- + Use the following reference to determine supported values for various parameters for Azure Cosmos DB for PostgreSQL clusters and nodes CLI commands: https://learn.microsoft.com/rest/api/postgresqlhsc/#values. + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -45,7 +43,7 @@ directCommands: examples: - summary: |- Create a new single node cluster - syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --login-password "password" + syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password" - summary: |- Create a new cluster as a point in time restore syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --point-in-time-utc "2017-12-14T00:00:37.467Z" --source-location "eastus" --source-resource-id "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster" @@ -54,13 +52,13 @@ directCommands: syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --source-location "eastus" --source-resource-id "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster" - summary: |- Create a new multi-node cluster - syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord false --node-count 3 --node-server-edition "MemoryOptimized" --node-v-cores 8 --node-storage 131072 --postgresql-version "15" --preferred-primary-zone "1" --login-password "password" + syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 8 --coordinator-server-edition "GeneralPurpose" --coordinator-storage 131072 --enable-shards-on-coord false --node-count 3 --node-server-edition "MemoryOptimized" --node-v-cores 8 --node-storage 131072 --postgresql-version "15" --preferred-primary-zone "1" --administrator-login-password "password" - summary: |- Create a new single node Burstable 1 vCore cluster - syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 1 --coordinator-server-edition "BurstableMemoryOptimized" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --login-password "password" + syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 1 --coordinator-server-edition "BurstableMemoryOptimized" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password" - summary: |- Create a new single node Burstable 2 vCores cluster - syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 2 --coordinator-server-edition "BurstableGeneralPurpose" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --login-password "password" + syntax: az cosmosdb postgres cluster create -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --enable-ha false --coordinator-v-cores 2 --coordinator-server-edition "BurstableGeneralPurpose" --coord-public-ip-access true --coordinator-storage 131072 --enable-shards-on-coord true --node-count 0 --preferred-primary-zone "1" --administrator-login-password "password" requiredParameters: - isRequired: true name: --cluster-name --name -n @@ -86,10 +84,10 @@ directCommands: The edition of a coordinator server (default: GeneralPurpose). Required for creation. - name: --coordinator-storage --coordinator-storage-quota-in-mb summary: |- - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The storage of a server in MB. Required for creation. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --coordinator-v-cores summary: |- - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --enable-ha parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- @@ -120,10 +118,10 @@ directCommands: The edition of a node server (default: MemoryOptimized). - name: --node-storage --node-storage-quota-in-mb summary: |- - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The storage in MB on each worker node. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --node-v-cores summary: |- - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --point-in-time-utc summary: |- Date and time in UTC (ISO8601 format) for cluster restore. @@ -145,10 +143,8 @@ directCommands: - uid: az_cosmosdb_postgres_cluster_delete() name: az cosmosdb postgres cluster delete summary: |- - Delete a cluster together with servers in it. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a cluster together with nodes in it. + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -187,9 +183,7 @@ directCommands: name: az cosmosdb postgres cluster list summary: |- List all clusters in a subscription or a resource group. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: az cosmosdb postgres cluster list [--resource-group] @@ -208,9 +202,7 @@ directCommands: name: az cosmosdb postgres cluster promote summary: |- Promotes read replica cluster to an independent read-write cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -244,9 +236,7 @@ directCommands: name: az cosmosdb postgres cluster restart summary: |- Restarts all nodes in the cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -280,9 +270,7 @@ directCommands: name: az cosmosdb postgres cluster show summary: |- Get information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -311,9 +299,7 @@ directCommands: name: az cosmosdb postgres cluster start summary: |- Starts stopped compute on all cluster nodes. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -347,9 +333,7 @@ directCommands: name: az cosmosdb postgres cluster stop summary: |- Stops compute on all cluster nodes. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -383,9 +367,9 @@ directCommands: name: az cosmosdb postgres cluster update summary: |- Update an existing cluster. The request body can contain one or several properties from the cluster definition. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + description: |- + Use the following reference to determine supported values for various parameters for Azure Cosmos DB for PostgreSQL clusters and nodes CLI commands: https://learn.microsoft.com/rest/api/postgresqlhsc/#values. + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -412,20 +396,26 @@ directCommands: [--tags] examples: - summary: |- - Scale compute up or down + Scale worker node compute up or down syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-v-cores 16 - summary: |- Scale out: Add new worker nodes syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-count 2 - summary: |- - Scale up storage - syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --coordinator-storage 2097152 + Scale up worker node storage + syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-storage 2097152 - summary: |- Update multiple configuration settings of the cluster - syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-v-cores 16 --node-count 4 coordinator-v-cores 16 --login-password "newPassword" + syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --node-v-cores 16 --node-count 4 coordinator-v-cores 16 --administrator-login-password "newPassword" - summary: |- Update or define maintenance window syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --maintenance-window day-of-week=1 start-hour=2 --start-minute=0 custom-window="Enabled" + - summary: |- + Upgrade PostgreSQL major version + syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --postgresql-version "15" + - summary: |- + Scale up coordinator storage + syntax: az cosmosdb postgres cluster update -n "test-cluster" -g "testGroup" --subscription "ffffffff-ffff-ffff-ffff-ffffffffffff" --coordinator-storage 2097152 optionalParameters: - name: --administrator-login-password --login-password summary: |- @@ -445,10 +435,10 @@ directCommands: The edition of a coordinator server (default: GeneralPurpose). Required for creation. - name: --coordinator-storage --coordinator-storage-quota-in-mb summary: |- - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The storage of a server in MB. Required for creation. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --coordinator-v-cores summary: |- - The vCores count of the coordinator (max: 96). + The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --enable-ha parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- @@ -472,13 +462,13 @@ directCommands: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. - name: --node-server-edition summary: |- - The edition of a node (default: MemoryOptimized). + The edition of a node server (default: MemoryOptimized). - name: --node-storage --node-storage-quota-in-mb summary: |- - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. + The storage in MB on each worker node. See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --node-v-cores summary: |- - The compute in vCores on each worker node (max: 104). + The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/rest/api/postgresqlhsc/#values for more information. - name: --postgresql-version summary: |- The major PostgreSQL version on all cluster servers. @@ -498,9 +488,7 @@ directCommands: name: az cosmosdb postgres cluster wait summary: |- Place the CLI in a waiting state until a condition is met. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/cluster/server.yml b/latest/docs-ref-autogen/cosmosdb/postgres/cluster/server.yml index d00052bf04..d9f2016536 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/cluster/server.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/cluster/server.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_cluster_server name: az cosmosdb postgres cluster server summary: |- Manage Azure Cosmos DB for PostgreSQL cluster servers. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_cluster_server_list() name: az cosmosdb postgres cluster server list summary: |- - List servers of a cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster server' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List nodes of a cluster. + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -36,10 +32,8 @@ directCommands: - uid: az_cosmosdb_postgres_cluster_server_show() name: az cosmosdb postgres cluster server show summary: |- - Get information about a server in cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres cluster server' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get information about a node in cluster. + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/configuration.yml b/latest/docs-ref-autogen/cosmosdb/postgres/configuration.yml index 3e5df5926f..766012d9e3 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/configuration.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/configuration.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_configuration name: az cosmosdb postgres configuration summary: |- Manage Azure Cosmos DB for PostgreSQL configurations. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_configuration_list() name: az cosmosdb postgres configuration list summary: |- List all the configurations of a cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -37,9 +33,7 @@ directCommands: name: az cosmosdb postgres configuration show summary: |- Get information of a configuration for coordinator and nodes. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/coordinator.yml b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/coordinator.yml index 2aec94249f..205ce9f532 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/coordinator.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/coordinator.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_configuration_coordinator name: az cosmosdb postgres configuration coordinator summary: |- Manage Azure Cosmos DB for PostgreSQL coordinator configurations. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_configuration_coordinator_show() name: az cosmosdb postgres configuration coordinator show summary: |- Get information of a configuration for coordinator. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration coordinator' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -47,9 +43,7 @@ directCommands: name: az cosmosdb postgres configuration coordinator update summary: |- Updates configuration of coordinator in a cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration coordinator' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -91,9 +85,7 @@ directCommands: name: az cosmosdb postgres configuration coordinator wait summary: |- Place the CLI in a waiting state until a condition is met. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration coordinator' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/node.yml b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/node.yml index 13fdfe560e..b11194db62 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/node.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/node.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_configuration_node name: az cosmosdb postgres configuration node summary: |- Manage Azure Cosmos DB for PostgreSQL node configurations. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_configuration_node_show() name: az cosmosdb postgres configuration node show summary: |- Get information of a configuration for worker nodes. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration node' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -47,9 +43,7 @@ directCommands: name: az cosmosdb postgres configuration node update summary: |- Updates configuration of worker nodes in a cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration node' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -91,9 +85,7 @@ directCommands: name: az cosmosdb postgres configuration node wait summary: |- Place the CLI in a waiting state until a condition is met. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration node' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/server.yml b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/server.yml index 1e3a9a8ea8..de196288d2 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/configuration/server.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/configuration/server.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_configuration_server name: az cosmosdb postgres configuration server summary: |- Manage Azure Cosmos DB for PostgreSQL server configurations. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_configuration_server_list() name: az cosmosdb postgres configuration server list summary: |- List all the configurations of a server in cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres configuration server' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/firewall-rule.yml b/latest/docs-ref-autogen/cosmosdb/postgres/firewall-rule.yml index 08defdce40..48d126e4c4 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/firewall-rule.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/firewall-rule.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_firewall-rule name: az cosmosdb postgres firewall-rule summary: |- Manage Azure Cosmos DB for PostgreSQL firewall rules. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_firewall-rule_create() name: az cosmosdb postgres firewall-rule create summary: |- Create a new cluster firewall rule or updates an existing cluster firewall rule. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -58,9 +54,7 @@ directCommands: name: az cosmosdb postgres firewall-rule delete summary: |- Delete a cluster firewall rule. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -103,9 +97,7 @@ directCommands: name: az cosmosdb postgres firewall-rule list summary: |- List all the firewall rules on cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -128,9 +120,7 @@ directCommands: name: az cosmosdb postgres firewall-rule show summary: |- Get information about a cluster firewall rule. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -163,9 +153,7 @@ directCommands: name: az cosmosdb postgres firewall-rule update summary: |- Update an existing cluster firewall rule. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -228,9 +216,7 @@ directCommands: name: az cosmosdb postgres firewall-rule wait summary: |- Place the CLI in a waiting state until a condition is met. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres firewall-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/cosmosdb/postgres/role.yml b/latest/docs-ref-autogen/cosmosdb/postgres/role.yml index 1bfbc71875..22a42629ea 100644 --- a/latest/docs-ref-autogen/cosmosdb/postgres/role.yml +++ b/latest/docs-ref-autogen/cosmosdb/postgres/role.yml @@ -3,18 +3,14 @@ uid: az_cosmosdb_postgres_role name: az cosmosdb postgres role summary: |- Manage Azure Cosmos DB for PostgreSQL roles. -status: Preview -isPreview: true -previewOrExperimentalInfo: "Command group 'az cosmosdb postgres' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Core directCommands: - uid: az_cosmosdb_postgres_role_create() name: az cosmosdb postgres role create summary: |- Create a new role or updates an existing role. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -53,9 +49,7 @@ directCommands: name: az cosmosdb postgres role delete summary: |- Delete a cluster role. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -98,9 +92,7 @@ directCommands: name: az cosmosdb postgres role list summary: |- List all the roles in a given cluster. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -123,9 +115,7 @@ directCommands: name: az cosmosdb postgres role show summary: |- Get information about a cluster role. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -158,9 +148,7 @@ directCommands: name: az cosmosdb postgres role update summary: |- Update an existing role. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- @@ -219,9 +207,7 @@ directCommands: name: az cosmosdb postgres role wait summary: |- Place the CLI in a waiting state until a condition is met. - status: Preview - isPreview: true - previewOrExperimentalInfo: "Command group 'az cosmosdb postgres role' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/cosmosdb/_help.py syntax: >- diff --git a/latest/docs-ref-autogen/deployment.yml b/latest/docs-ref-autogen/deployment.yml index 1152892219..b18313721a 100644 --- a/latest/docs-ref-autogen/deployment.yml +++ b/latest/docs-ref-autogen/deployment.yml @@ -415,5 +415,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/latest/docs-ref-autogen/deployment/group.yml b/latest/docs-ref-autogen/deployment/group.yml index efaa308d36..6db399082b 100644 --- a/latest/docs-ref-autogen/deployment/group.yml +++ b/latest/docs-ref-autogen/deployment/group.yml @@ -83,8 +83,8 @@ directCommands: Create a deployment at resource group scope from a template-spec syntax: az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0" - summary: |- - Create a deployment at resource group scope from a bicep template and a bicepparam parameter file - syntax: az deployment group create --resource-group testrg --template-file azuredeploy.bicep --parameters parameters.bicepparam + Create a deployment at resource group scope from a bicepparam parameter file + syntax: az deployment group create --resource-group testrg --parameters parameters.bicepparam - summary: |- Create a deployment at resource group across tenants syntax: >- @@ -133,7 +133,7 @@ directCommands: summary: |- Supply deployment parameter values. description: |- - 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. Also note if you are providing a bicepparam file with a bicep template then you can use this argument only once. + 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. Also note if you are providing a bicepparam file then you can use this argument only once. - name: --proceed-if-no-change summary: |- Instruct the command to execute the deployment if the What-If result contains no resource changes. Applicable when --confirm-with-what-if is set. @@ -512,5 +512,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at resource group. diff --git a/latest/docs-ref-autogen/deployment/mg.yml b/latest/docs-ref-autogen/deployment/mg.yml index efeb138560..63aba42535 100644 --- a/latest/docs-ref-autogen/deployment/mg.yml +++ b/latest/docs-ref-autogen/deployment/mg.yml @@ -475,5 +475,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at management group. diff --git a/latest/docs-ref-autogen/deployment/operation.yml b/latest/docs-ref-autogen/deployment/operation.yml index a788bc8a58..769e3a3842 100644 --- a/latest/docs-ref-autogen/deployment/operation.yml +++ b/latest/docs-ref-autogen/deployment/operation.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/latest/docs-ref-autogen/deployment/operation/group.yml b/latest/docs-ref-autogen/deployment/operation/group.yml index c950e10e53..f2ba339664 100644 --- a/latest/docs-ref-autogen/deployment/operation/group.yml +++ b/latest/docs-ref-autogen/deployment/operation/group.yml @@ -81,5 +81,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at resource group. diff --git a/latest/docs-ref-autogen/deployment/operation/mg.yml b/latest/docs-ref-autogen/deployment/operation/mg.yml index 0fdc26af22..c2a7a6b9e5 100644 --- a/latest/docs-ref-autogen/deployment/operation/mg.yml +++ b/latest/docs-ref-autogen/deployment/operation/mg.yml @@ -77,5 +77,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at management group. diff --git a/latest/docs-ref-autogen/deployment/operation/sub.yml b/latest/docs-ref-autogen/deployment/operation/sub.yml index eedad853e1..5060c4afd8 100644 --- a/latest/docs-ref-autogen/deployment/operation/sub.yml +++ b/latest/docs-ref-autogen/deployment/operation/sub.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at subscription scope. diff --git a/latest/docs-ref-autogen/deployment/operation/tenant.yml b/latest/docs-ref-autogen/deployment/operation/tenant.yml index e9c9755692..05f9478035 100644 --- a/latest/docs-ref-autogen/deployment/operation/tenant.yml +++ b/latest/docs-ref-autogen/deployment/operation/tenant.yml @@ -66,5 +66,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations at tenant scope. diff --git a/latest/docs-ref-autogen/deployment/sub.yml b/latest/docs-ref-autogen/deployment/sub.yml index f064d0aea5..40a51e3598 100644 --- a/latest/docs-ref-autogen/deployment/sub.yml +++ b/latest/docs-ref-autogen/deployment/sub.yml @@ -419,5 +419,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at subscription scope. diff --git a/latest/docs-ref-autogen/deployment/tenant.yml b/latest/docs-ref-autogen/deployment/tenant.yml index cd1afe4174..711a204ef2 100644 --- a/latest/docs-ref-autogen/deployment/tenant.yml +++ b/latest/docs-ref-autogen/deployment/tenant.yml @@ -423,5 +423,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager template deployment at tenant scope. diff --git a/latest/docs-ref-autogen/dt/model.yml b/latest/docs-ref-autogen/dt/model.yml index a96d5da72b..583a66b870 100644 --- a/latest/docs-ref-autogen/dt/model.yml +++ b/latest/docs-ref-autogen/dt/model.yml @@ -132,7 +132,7 @@ directCommands: List model definitions syntax: az dt model list -n {instance_or_hostname} --definition - summary: |- - List dependencies of particular pre-existing model(s). Space seperate dtmi values. + List dependencies of particular pre-existing model(s). Space separate dtmi values. syntax: az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1} requiredParameters: - isRequired: true diff --git a/latest/docs-ref-autogen/dt/network/private-endpoint/connection.yml b/latest/docs-ref-autogen/dt/network/private-endpoint/connection.yml index 3d46f29499..c1e786c25d 100644 --- a/latest/docs-ref-autogen/dt/network/private-endpoint/connection.yml +++ b/latest/docs-ref-autogen/dt/network/private-endpoint/connection.yml @@ -117,7 +117,7 @@ directCommands: Description for the private endpoint connection. - name: --group-ids summary: |- - Space seperated list of group ids that the private endpoint should connect to. + Space separated list of group ids that the private endpoint should connect to. - name: --no-wait defaultValue: "False" summary: |- diff --git a/latest/docs-ref-autogen/feature.yml b/latest/docs-ref-autogen/feature.yml index 6b944028a7..d37d48c100 100644 --- a/latest/docs-ref-autogen/feature.yml +++ b/latest/docs-ref-autogen/feature.yml @@ -122,5 +122,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource provider features. diff --git a/latest/docs-ref-autogen/feature/registration.yml b/latest/docs-ref-autogen/feature/registration.yml index b776adf60c..0d3f52f706 100644 --- a/latest/docs-ref-autogen/feature/registration.yml +++ b/latest/docs-ref-autogen/feature/registration.yml @@ -123,5 +123,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource provider feature registrations. diff --git a/latest/docs-ref-autogen/functionapp/connection.yml b/latest/docs-ref-autogen/functionapp/connection.yml index 5aa7711ce5..67a0d992a8 100644 --- a/latest/docs-ref-autogen/functionapp/connection.yml +++ b/latest/docs-ref-autogen/functionapp/connection.yml @@ -43,14 +43,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -79,10 +79,10 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -117,10 +117,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_list-support-types() name: az functionapp connection list-support-types summary: |- @@ -172,10 +172,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_validate() name: az functionapp connection validate summary: |- @@ -207,10 +207,10 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - uid: az_functionapp_connection_wait() name: az functionapp connection wait summary: |- @@ -262,10 +262,10 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/latest/docs-ref-autogen/functionapp/connection/create.yml b/latest/docs-ref-autogen/functionapp/connection/create.yml index e92790c539..3767dae0bc 100644 --- a/latest/docs-ref-autogen/functionapp/connection/create.yml +++ b/latest/docs-ref-autogen/functionapp/connection/create.yml @@ -60,7 +60,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -71,7 +71,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -175,14 +175,14 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a functionapp. Required if ['--resource-group', '--name'] are not specified. @@ -244,7 +244,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -255,7 +255,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +358,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -369,7 +369,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -468,7 +468,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -479,7 +479,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -578,7 +578,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -589,7 +589,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -685,7 +685,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -696,7 +696,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -791,7 +791,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -805,7 +805,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -903,7 +903,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -919,7 +919,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1012,7 +1012,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1023,7 +1023,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1103,14 +1103,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1194,14 +1194,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1299,7 +1299,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1315,7 +1315,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1410,7 +1410,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1426,7 +1426,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1515,14 +1515,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1604,14 +1604,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1696,7 +1696,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1707,7 +1707,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1775,14 +1775,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1851,7 +1851,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1865,7 +1865,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +1956,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1967,7 +1967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2060,7 +2060,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2071,7 +2071,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2159,7 +2159,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2170,7 +2170,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2269,7 +2269,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2285,7 +2285,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2377,7 +2377,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2388,7 +2388,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2461,7 +2461,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2472,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2564,7 +2564,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2575,7 +2575,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2644,7 +2644,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2655,7 +2655,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/latest/docs-ref-autogen/functionapp/connection/update.yml b/latest/docs-ref-autogen/functionapp/connection/update.yml index 38d4dd2445..5f86ae02ef 100644 --- a/latest/docs-ref-autogen/functionapp/connection/update.yml +++ b/latest/docs-ref-autogen/functionapp/connection/update.yml @@ -50,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -61,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -151,14 +151,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the function app. Required if '--source-id' is not specified. + Name of the function app. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--source-id' is not specified. + The resource group which contains the function app. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -219,7 +219,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -230,7 +230,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -310,7 +310,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -321,7 +321,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -401,7 +401,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -412,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -492,7 +492,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -503,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -583,7 +583,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -594,7 +594,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -674,7 +674,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -685,7 +685,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -764,7 +764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -775,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -849,7 +849,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -860,7 +860,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -921,14 +921,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -996,7 +996,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1007,7 +1007,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1073,14 +1073,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1142,7 +1142,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1153,7 +1153,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1202,14 +1202,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1263,7 +1263,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1274,7 +1274,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1353,7 +1353,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1364,7 +1364,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1438,7 +1438,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1449,7 +1449,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1519,7 +1519,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1530,7 +1530,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,7 +1607,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1618,7 +1618,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1676,7 +1676,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1687,7 +1687,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1764,7 +1764,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1775,7 +1775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1832,7 +1832,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the function app. Required if '--id' is not specified. + Name of the function app. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1843,7 +1843,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the function app. Required if '--id' is not specified. + The resource group which contains the function app. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. diff --git a/latest/docs-ref-autogen/group.yml b/latest/docs-ref-autogen/group.yml index 8bdfc21fc0..9b8eb04f3b 100644 --- a/latest/docs-ref-autogen/group.yml +++ b/latest/docs-ref-autogen/group.yml @@ -301,5 +301,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource groups and template deployments. diff --git a/latest/docs-ref-autogen/group/deployment.yml b/latest/docs-ref-autogen/group/deployment.yml index bdb6506b2b..845f03e2c5 100644 --- a/latest/docs-ref-autogen/group/deployment.yml +++ b/latest/docs-ref-autogen/group/deployment.yml @@ -376,5 +376,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Resource Manager deployments. diff --git a/latest/docs-ref-autogen/group/deployment/operation.yml b/latest/docs-ref-autogen/group/deployment/operation.yml index 3a10ee2996..1a816fc7b6 100644 --- a/latest/docs-ref-autogen/group/deployment/operation.yml +++ b/latest/docs-ref-autogen/group/deployment/operation.yml @@ -88,5 +88,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage deployment operations. diff --git a/latest/docs-ref-autogen/group/lock.yml b/latest/docs-ref-autogen/group/lock.yml index 6190f384ce..9862bfbf29 100644 --- a/latest/docs-ref-autogen/group/lock.yml +++ b/latest/docs-ref-autogen/group/lock.yml @@ -178,5 +178,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource group locks. diff --git a/latest/docs-ref-autogen/iot/du/account.yml b/latest/docs-ref-autogen/iot/du/account.yml index bb80295b1a..60982b150f 100644 --- a/latest/docs-ref-autogen/iot/du/account.yml +++ b/latest/docs-ref-autogen/iot/du/account.yml @@ -43,7 +43,7 @@ directCommands: Create a Device Update account in target resource group with a system managed identity then assign the system identity to a single scope with the role of Contributor. syntax: az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount - summary: |- - Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-seperated) with a custom specified role. + Create a Device Update account in target resource group with system and user-assigned managed identities then assign the system identity to one or more scopes (space-separated) with a custom specified role. syntax: >- az iot du account create -n {account_name} -g {resouce_group} --assign-identity [system] /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourcegroups/ProResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity --scopes /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount1 /subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount2 diff --git a/latest/docs-ref-autogen/iot/hub/device-identity/children.yml b/latest/docs-ref-autogen/iot/hub/device-identity/children.yml index 9c24473ee3..ffe8446d6a 100644 --- a/latest/docs-ref-autogen/iot/hub/device-identity/children.yml +++ b/latest/docs-ref-autogen/iot/hub/device-identity/children.yml @@ -114,7 +114,7 @@ directCommands: [--resource-group] examples: - summary: |- - Remove a space-seperated list of child devices from a target parent device. + Remove a space-separated list of child devices from a target parent device. syntax: az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name} - summary: |- Remove all child devices from a target parent device. diff --git a/latest/docs-ref-autogen/lock.yml b/latest/docs-ref-autogen/lock.yml index eda6357072..16bc620028 100644 --- a/latest/docs-ref-autogen/lock.yml +++ b/latest/docs-ref-autogen/lock.yml @@ -284,5 +284,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure locks. diff --git a/latest/docs-ref-autogen/managedapp.yml b/latest/docs-ref-autogen/managedapp.yml index eda87aefc3..796ed5b7a6 100644 --- a/latest/docs-ref-autogen/managedapp.yml +++ b/latest/docs-ref-autogen/managedapp.yml @@ -187,5 +187,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage template solutions provided and maintained by Independent Software Vendors (ISVs). diff --git a/latest/docs-ref-autogen/managedapp/definition.yml b/latest/docs-ref-autogen/managedapp/definition.yml index 4bf603ef13..bff48d2565 100644 --- a/latest/docs-ref-autogen/managedapp/definition.yml +++ b/latest/docs-ref-autogen/managedapp/definition.yml @@ -272,5 +272,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure Managed Applications. diff --git a/latest/docs-ref-autogen/mariadb/server.yml b/latest/docs-ref-autogen/mariadb/server.yml index 69eb2270b6..ac6bbe1d4b 100644 --- a/latest/docs-ref-autogen/mariadb/server.yml +++ b/latest/docs-ref-autogen/mariadb/server.yml @@ -48,7 +48,7 @@ directCommands: summary: |- The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. - name: --admin-user -u - defaultValue: "selfishruffs0" + defaultValue: "liquidtoucan3" summary: |- Administrator username for the server. Once set, it cannot be changed. - name: --assign-identity diff --git a/latest/docs-ref-autogen/monitor/account.yml b/latest/docs-ref-autogen/monitor/account.yml index e46cc7baea..5edd6a8c06 100644 --- a/latest/docs-ref-autogen/monitor/account.yml +++ b/latest/docs-ref-autogen/monitor/account.yml @@ -263,5 +263,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage monitor account. diff --git a/latest/docs-ref-autogen/monitor/action-group.yml b/latest/docs-ref-autogen/monitor/action-group.yml index 31d5a69d32..ce3771da1d 100644 --- a/latest/docs-ref-autogen/monitor/action-group.yml +++ b/latest/docs-ref-autogen/monitor/action-group.yml @@ -14,76 +14,77 @@ directCommands: sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor action-group create --name + az monitor action-group create --action-group-name --resource-group [--action] + [--group-short-name] [--location] - [--short-name] [--tags] examples: - summary: |- - Create a new action group (autogenerated) + Create a new action group syntax: az monitor action-group create --action webhook MyActionName https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --name -n + name: --action-group-name --name -n summary: |- - The name of the action group. Required. + The name of the action group. - isRequired: true name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. optionalParameters: - - name: --action -a + - name: --action --actions -a summary: |- Add receivers to the action group during the creation. - description: |- - Usage: --action TYPE NAME [ARG ...] - Email: - Format: --action email NAME EMAIL_ADDRESS [usecommonalertschema] - Example: --action email bob bob@contoso.com - SMS: - Format: --action sms NAME COUNTRY_CODE PHONE_NUMBER - Example: --action sms charli 1 5551234567 - Webhook: - Format: --action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] - Example: --action webhook alert_hook https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema - Arm Role: - Format: --action armrole NAME ROLE_ID [usecommonalertschema] - Example: --action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 - Azure App Push: - Format: --action azureapppush NAME EMAIL_ADDRESS - Example: --action azureapppush test_apppush bob@contoso.com - ITSM: - Format: --action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION - Example: --action itsm test_itsm test_workspace test_conn ticket_blob useast - Automation runbook: - Format: --action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] - Example: --action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema - Voice: - Format: --action voice NAME COUNTRY_CODE PHONE_NUMBER - Example: --action voice charli 1 4441234567 - Logic App: - Format: --action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] - Example: --action logicapp test_logicapp test_rsrc http://callback - 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. + Usage: --action TYPE NAME [ARG ...] + Email: + Format: --action email NAME EMAIL_ADDRESS [usecommonalertschema] + Example: --action email bob bob@contoso.com + SMS: + Format: --action sms NAME COUNTRY_CODE PHONE_NUMBER + Example: --action sms charli 1 5551234567 + Webhook: + Format: --action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] + Example: --action webhook alert_hook https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema + Arm Role: + Format: --action armrole NAME ROLE_ID [usecommonalertschema] + Example: --action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 + Azure App Push: + Format: --action azureapppush NAME EMAIL_ADDRESS + Example: --action azureapppush test_apppush bob@contoso.com + ITSM: + Format: --action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION + Example: --action itsm test_itsm test_workspace test_conn ticket_blob useast + Automation runbook: + Format: --action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] + Example: --action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema + Voice: + Format: --action voice NAME COUNTRY_CODE PHONE_NUMBER + Example: --action voice charli 1 4441234567 + Logic App: + Format: --action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] + Example: --action logicapp test_logicapp test_rsrc http://callback + 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. + Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --group-short-name --short-name + summary: |- + The short name of the action group. This will be used in SMS messages. - name: --location -l + defaultValue: "Global" summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - - name: --short-name - summary: |- - The short name of the action group. + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. When not specified, the location of the resource group will be used. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Space-separated tags: key[=value] [key[=value] ...]. Use '' to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - uid: az_monitor_action-group_delete() name: az monitor action-group delete summary: |- @@ -92,17 +93,17 @@ directCommands: sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor action-group delete [--ids] - [--name] + az monitor action-group delete [--action-group-name] + [--ids] [--resource-group] [--subscription] optionalParameters: + - name: --action-group-name --name -n + summary: |- + The name of the action group. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - - name: --name -n - summary: |- - The name of the action group. Required. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -126,11 +127,11 @@ directCommands: [--subscription] requiredParameters: - isRequired: true - name: --name -n + name: --name --receiver-name -n summary: |- The name of the receiver to resubscribe. optionalParameters: - - name: --action-group + - name: --action-group --action-group-name summary: |- The name of the action group. - name: --ids @@ -153,7 +154,7 @@ directCommands: optionalParameters: - name: --resource-group -g summary: |- - Name of the resource group under which the action groups are being listed. If it is omitted, all the action groups under the current subscription are listed. + Name of resource group. You can configure the default group using `az configure --defaults group=`. - uid: az_monitor_action-group_show() name: az monitor action-group show summary: |- @@ -162,21 +163,21 @@ directCommands: sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor action-group show [--ids] - [--name] + az monitor action-group show [--action-group-name] + [--ids] [--resource-group] [--subscription] examples: - summary: |- - Show the details of an action group (commonly used with --output and --query). (autogenerated) + Show the details of an action group (commonly used with --output and --query). syntax: az monitor action-group show --name MyActionGroup --resource-group MyResourceGroup optionalParameters: + - name: --action-group-name --name -n + summary: |- + The name of the action group. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - - name: --name -n - summary: |- - The name of the action group. Required. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -191,101 +192,97 @@ directCommands: sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor action-group update [--add] + az monitor action-group update [--action-group-name] + [--add] [--add-action] - [--force-string] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--group-short-name] [--ids] - [--name] [--remove] [--remove-action] [--resource-group] [--set] - [--short-name] [--subscription] [--tags] examples: - summary: |- - Update an action group (autogenerated) + Update an action group syntax: az monitor action-group update --name MyActionGroup --resource-group MyResourceGroup --set retentionPolicy.days=365 --subscription MySubscription optionalParameters: + - name: --action-group-name --name -n + summary: |- + The name of the action group. - name: --add - defaultValue: "[]" summary: |- Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - - name: --add-action -a + - name: --add-action --add-actions -a summary: |- Add receivers to the action group. - description: |- - Usage: --add-action TYPE NAME [ARG ...] - Email: - Format: --add-action email NAME EMAIL_ADDRESS [usecommonalertschema] - Example: --add-action email bob bob@contoso.com - SMS: - Format: --add-action sms NAME COUNTRY_CODE PHONE_NUMBER - Example: --add-action sms charli 1 5551234567 - Webhook: - Format: --add-action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] - Example: --add-action https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema - Arm Role: - Format: --add-action armrole NAME ROLE_ID [usecommonalertschema] - Example: --add-action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 - Azure App Push: - Format: --add-action azureapppush NAME EMAIL_ADDRESS - Example: --add-action azureapppush test_apppush bob@contoso.com - ITSM: - Format: --add-action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION - Example: --add-action itsm test_itsm test_workspace test_conn ticket_blob useast - Automation runbook: - Format: --add-action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] - Example: --add-action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema - Voice: - Format: --add-action voice NAME COUNTRY_CODE PHONE_NUMBER - Example: --add-action voice charli 1 4441234567 - Logic App: - Format: --add-action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] - Example: --add-action logicapp test_logicapp test_rsrc http://callback - 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. + Usage: --add-action TYPE NAME [ARG ...] + Email: + Format: --add-action email NAME EMAIL_ADDRESS [usecommonalertschema] + Example: --add-action email bob bob@contoso.com + SMS: + Format: --add-action sms NAME COUNTRY_CODE PHONE_NUMBER + Example: --add-action sms charli 1 5551234567 + Webhook: + Format: --add-action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] + Example: --add-action https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema + Arm Role: + Format: --add-action armrole NAME ROLE_ID [usecommonalertschema] + Example: --add-action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 + Azure App Push: + Format: --add-action azureapppush NAME EMAIL_ADDRESS + Example: --add-action azureapppush test_apppush bob@contoso.com + ITSM: + Format: --add-action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION + Example: --add-action itsm test_itsm test_workspace test_conn ticket_blob useast + Automation runbook: + Format: --add-action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] + Example: --add-action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema + Voice: + Format: --add-action voice NAME COUNTRY_CODE PHONE_NUMBER + Example: --add-action voice charli 1 4441234567 + Logic App: + Format: --add-action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] + Example: --add-action logicapp test_logicapp test_rsrc http://callback + 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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --force-string - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. + - name: --group-short-name --short-name + summary: |- + The short name of the action group. This will be used in SMS messages. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - - name: --name -n - summary: |- - The name of the action group. Required. - name: --remove - defaultValue: "[]" summary: |- Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --remove-action -r summary: |- - Remove receivers from the action group. Accept space-separated list of receiver names. + Remove receivers from the action group. Accept space-separated list of receiver names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --set - defaultValue: "[]" summary: |- Update an object by specifying a property path and value to set. Example: --set property1.property2=. - - name: --short-name - summary: |- - Update the group short name of the action group. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Space-separated tags: key[=value] [key[=value] ...]. Use '' to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - uid: az_monitor_action-group_wait() name: az monitor action-group wait summary: |- @@ -380,5 +377,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage action groups. diff --git a/latest/docs-ref-autogen/monitor/action-group/test-notifications.yml b/latest/docs-ref-autogen/monitor/action-group/test-notifications.yml index 1b34c1f0bd..993f6c4526 100644 --- a/latest/docs-ref-autogen/monitor/action-group/test-notifications.yml +++ b/latest/docs-ref-autogen/monitor/action-group/test-notifications.yml @@ -18,71 +18,67 @@ directCommands: --alert-type --resource-group [--add-action] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Create an action group test-notifications with action group - syntax: >- - az monitor action-group test-notifications create --action-group MyActionGroup \ - - --resource-group MyResourceGroup -a email alice alice@example.com usecommonalertsChema --alert-type budget + syntax: az monitor action-group test-notifications create --action-group MyActionGroup \ --resource-group MyResourceGroup -a email alice alice@example.com usecommonalertsChema --alert-type budget requiredParameters: - isRequired: true - name: --action-group + name: --action-group --action-group-name summary: |- The name of the action group. - isRequired: true name: --alert-type summary: |- - The name of the supported alert type. + The value of the supported alert type. Supported alert type values are: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, budget. - isRequired: true name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. optionalParameters: - - name: --add-action -a + - name: --add-action --add-actions -a summary: |- - Add receivers to the action group test-notifications. - description: |- - Usage: --add-action TYPE NAME [ARG ...] - Email: - Format: --add-action email NAME EMAIL_ADDRESS [usecommonalertschema] - Example: --add-action email bob bob@contoso.com - SMS: - Format: --add-action sms NAME COUNTRY_CODE PHONE_NUMBER - Example: --add-action sms charli 1 5551234567 - Webhook: - Format: --add-action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] - Example: --add-action https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema - Arm Role: - Format: --add-action armrole NAME ROLE_ID [usecommonalertschema] - Example: --add-action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 - Azure App Push: - Format: --add-action azureapppush NAME EMAIL_ADDRESS - Example: --add-action azureapppush test_apppush bob@contoso.com - ITSM: - Format: --add-action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION - Example: --add-action itsm test_itsm test_workspace test_conn ticket_blob useast - Automation runbook: - Format: --add-action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] - Example: --add-action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema - Voice: - Format: --add-action voice NAME COUNTRY_CODE PHONE_NUMBER - Example: --add-action voice charli 1 4441234567 - Logic App: - Format: --add-action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] - Example: --add-action logicapp test_logicapp test_rsrc http://callback - 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. + Add receivers to the action group. + Usage: --add-action TYPE NAME [ARG ...] + Email: + Format: --add-action email NAME EMAIL_ADDRESS [usecommonalertschema] + Example: --add-action email bob bob@contoso.com + SMS: + Format: --add-action sms NAME COUNTRY_CODE PHONE_NUMBER + Example: --add-action sms charli 1 5551234567 + Webhook: + Format: --add-action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] + Example: --add-action https://www.contoso.com/alert useaadauth testobj http://identifier usecommonalertschema + Arm Role: + Format: --add-action armrole NAME ROLE_ID [usecommonalertschema] + Example: --add-action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c4bcb635 + Azure App Push: + Format: --add-action azureapppush NAME EMAIL_ADDRESS + Example: --add-action azureapppush test_apppush bob@contoso.com + ITSM: + Format: --add-action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION + Example: --add-action itsm test_itsm test_workspace test_conn ticket_blob useast + Automation runbook: + Format: --add-action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID SERVICE_URI [isglobalrunbook] [usecommonalertschema] + Example: --add-action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema + Voice: + Format: --add-action voice NAME COUNTRY_CODE PHONE_NUMBER + Example: --add-action voice charli 1 4441234567 + Logic App: + Format: --add-action logicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] + Example: --add-action logicapp test_logicapp test_rsrc http://callback + 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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. commands: @@ -112,5 +108,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage action groups test-notifications. diff --git a/latest/docs-ref-autogen/monitor/activity-log.yml b/latest/docs-ref-autogen/monitor/activity-log.yml index 478b08bec1..7b8c4dad66 100644 --- a/latest/docs-ref-autogen/monitor/activity-log.yml +++ b/latest/docs-ref-autogen/monitor/activity-log.yml @@ -122,5 +122,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage activity logs. diff --git a/latest/docs-ref-autogen/monitor/activity-log/alert.yml b/latest/docs-ref-autogen/monitor/activity-log/alert.yml index 5fbea36cbf..d62b867a80 100644 --- a/latest/docs-ref-autogen/monitor/activity-log/alert.yml +++ b/latest/docs-ref-autogen/monitor/activity-log/alert.yml @@ -258,5 +258,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage activity log alert rules. diff --git a/latest/docs-ref-autogen/monitor/activity-log/alert/action-group.yml b/latest/docs-ref-autogen/monitor/activity-log/alert/action-group.yml index 9aa6f8d414..02e21a5aa3 100644 --- a/latest/docs-ref-autogen/monitor/activity-log/alert/action-group.yml +++ b/latest/docs-ref-autogen/monitor/activity-log/alert/action-group.yml @@ -135,5 +135,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage action groups for activity log alert rules. diff --git a/latest/docs-ref-autogen/monitor/activity-log/alert/scope.yml b/latest/docs-ref-autogen/monitor/activity-log/alert/scope.yml index 73a707bde8..063098b9cf 100644 --- a/latest/docs-ref-autogen/monitor/activity-log/alert/scope.yml +++ b/latest/docs-ref-autogen/monitor/activity-log/alert/scope.yml @@ -105,5 +105,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage scopes for activity log alert rules. diff --git a/latest/docs-ref-autogen/monitor/autoscale.yml b/latest/docs-ref-autogen/monitor/autoscale.yml index b1b146e2d5..4b51275417 100644 --- a/latest/docs-ref-autogen/monitor/autoscale.yml +++ b/latest/docs-ref-autogen/monitor/autoscale.yml @@ -119,22 +119,22 @@ directCommands: - uid: az_monitor_autoscale_delete() name: az monitor autoscale delete summary: |- - Deletes and autoscale setting. + Delete an autoscale setting. status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor autoscale delete [--ids] - [--name] + az monitor autoscale delete [--autoscale-name] + [--ids] [--resource-group] [--subscription] optionalParameters: + - name: --autoscale-name --name -n + summary: |- + The autoscale setting name. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - - name: --name -n - summary: |- - Name of the autoscale settings. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -148,35 +148,45 @@ directCommands: status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py - syntax: az monitor autoscale list --resource-group + syntax: >- + az monitor autoscale list --resource-group + [--max-items] + [--next-token] requiredParameters: - isRequired: true name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. + optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_monitor_autoscale_show() name: az monitor autoscale show summary: |- - Show autoscale setting details. + Get an autoscale setting. status: GA sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- - az monitor autoscale show [--ids] - [--name] + az monitor autoscale show [--autoscale-name] + [--ids] [--resource-group] [--subscription] examples: - summary: |- - Show autoscale setting details. (autogenerated) + Show autoscale setting details. syntax: az monitor autoscale show --name MyAutoscaleSettings --resource-group MyResourceGroup optionalParameters: + - name: --autoscale-name --name -n + summary: |- + The autoscale setting name. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - - name: --name -n - summary: |- - Name of the autoscale settings. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -192,21 +202,19 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/monitor/_help.py syntax: >- az monitor autoscale show-predictive-metric --aggregation - --autoscale-setting-name --interval --metric-name --metric-namespace - --resource-group --timespan + [--autoscale-setting-name] + [--ids] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true name: --aggregation summary: |- The list of aggregation types (comma separated) to retrieve. - - isRequired: true - name: --autoscale-setting-name - summary: |- - The autoscale setting name. - isRequired: true name: --interval summary: |- @@ -219,18 +227,27 @@ directCommands: name: --metric-namespace summary: |- Metric namespace to query metric definitions for. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - isRequired: true name: --timespan summary: |- The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. + optionalParameters: + - name: --autoscale-setting-name + summary: |- + The autoscale setting name. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_monitor_autoscale_update() name: az monitor autoscale update summary: |- - Update autoscale settings. + Update an autoscale setting. description: |- For more information on autoscaling, visit: https://docs.microsoft.com/azure/monitoring-and-diagnostics/monitoring-understanding-autoscale-settings. status: GA @@ -239,15 +256,15 @@ directCommands: syntax: >- az monitor autoscale update [--add] [--add-action] + [--autoscale-name] [--count] - [--email-administrator {false, true}] - [--email-coadministrators {false, true}] - [--enabled {false, true}] - [--force-string] + [--email-administrator {0, 1, f, false, n, no, t, true, y, yes}] + [--email-coadministrators {0, 1, f, false, n, no, t, true, y, yes}] + [--enabled {0, 1, f, false, n, no, t, true, y, yes}] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--max-count] [--min-count] - [--name] [--remove] [--remove-action] [--resource-group] @@ -259,46 +276,46 @@ directCommands: examples: - summary: |- Update autoscale settings to use a fixed 3 instances by default. - syntax: az monitor autoscale update -g {myrg} -n {autoscale-name} --count 3 + syntax: az monitor autoscale update -g myrg -n autoscale-name --count 3 - summary: |- Update autoscale settings to remove an email notification. - syntax: >- - az monitor autoscale update -g {myrg} -n {autoscale-name} \ - --remove-action email bob@contoso.com + syntax: az monitor autoscale update -g myrg -n autoscale-name \ --remove-action email bob@contoso.com - summary: |- - Update autoscale settings. (autogenerated) + Update autoscale settings. syntax: az monitor autoscale update --count 3 --email-administrator true --enabled true --max-count 5 --min-count 2 --name MyAutoscaleSettings --resource-group MyResourceGroup --tags key[=value] optionalParameters: - name: --add - defaultValue: "[]" summary: |- Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - - name: --add-action -a + - name: --add-action --add-actions -a summary: |- Add an action to fire when a scaling event occurs. - description: |- - Usage: --add-action TYPE KEY [ARG ...] - Email: --add-action email bob@contoso.com ann@contoso.com - Webhook: --add-action webhook https://www.contoso.com/alert apiKey=value - Webhook: --add-action webhook https://www.contoso.com/alert?apiKey=value - Multiple actions can be specified by using more than one `--add-action` argument. + Usage: --add-action TYPE KEY [ARG ...] + Email: --add-action email bob@contoso.com ann@contoso.com + Webhook: --add-action webhook https://www.contoso.com/alert apiKey=value + Webhook: --add-action webhook https://www.contoso.com/alert?apiKey=value + Multiple actions can be specified by using more than one `--add-action` argument. + Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --autoscale-name --name -n + summary: |- + The autoscale setting name. - name: --count summary: |- The numer of instances to use. If used with --min/max-count, the default number of instances to use. - name: --email-administrator - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Send email to subscription administrator on scaling. - name: --email-coadministrators - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Send email to subscription co-administrators on scaling. - name: --enabled - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Autoscale settings enabled status. + The enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'. - name: --force-string - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --ids @@ -310,20 +327,16 @@ directCommands: - name: --min-count summary: |- The minimum number of instances. - - name: --name -n - summary: |- - Name of the autoscale settings. - name: --remove - defaultValue: "[]" summary: |- Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - - name: --remove-action -r + - name: --remove-action --remove-actions -r summary: |- Remove one or more actions. - description: |- - Usage: --remove-action TYPE KEY [KEY ...] - Email: --remove-action email bob@contoso.com ann@contoso.com - Webhook: --remove-action webhook https://contoso.com/alert https://alerts.contoso.com. + Usage: --remove-action TYPE KEY [KEY ...] + Email: --remove-action email bob@contoso.com ann@contoso.com + Webhook: --remove-action webhook https://contoso.com/alert https://alerts.contoso.com. + Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -335,7 +348,6 @@ directCommands: summary: |- The predictive autoscale mode. - name: --set - defaultValue: "[]" summary: |- Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --subscription @@ -343,7 +355,7 @@ directCommands: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. commands: - az_monitor_autoscale_create() - az_monitor_autoscale_delete() @@ -387,5 +399,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage autoscale settings. diff --git a/latest/docs-ref-autogen/monitor/autoscale/profile.yml b/latest/docs-ref-autogen/monitor/autoscale/profile.yml index 750a99a8cf..585c56051b 100644 --- a/latest/docs-ref-autogen/monitor/autoscale/profile.yml +++ b/latest/docs-ref-autogen/monitor/autoscale/profile.yml @@ -239,5 +239,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: 'For more information on autoscaling, visit: https://docs.microsoft.com/azure/monitoring-and-diagnostics/monitoring-understanding-autoscale-settings.' diff --git a/latest/docs-ref-autogen/monitor/autoscale/rule.yml b/latest/docs-ref-autogen/monitor/autoscale/rule.yml index 07169ece20..396522da58 100644 --- a/latest/docs-ref-autogen/monitor/autoscale/rule.yml +++ b/latest/docs-ref-autogen/monitor/autoscale/rule.yml @@ -227,5 +227,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: 'For more information on autoscaling, visit: https://docs.microsoft.com/azure/monitoring-and-diagnostics/monitoring-understanding-autoscale-settings.' diff --git a/latest/docs-ref-autogen/monitor/diagnostic-settings.yml b/latest/docs-ref-autogen/monitor/diagnostic-settings.yml index 9662ecad94..d1d591bbfc 100644 --- a/latest/docs-ref-autogen/monitor/diagnostic-settings.yml +++ b/latest/docs-ref-autogen/monitor/diagnostic-settings.yml @@ -311,5 +311,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage service diagnostic settings. diff --git a/latest/docs-ref-autogen/monitor/diagnostic-settings/categories.yml b/latest/docs-ref-autogen/monitor/diagnostic-settings/categories.yml index 3f4e6a6658..8bd63ce86a 100644 --- a/latest/docs-ref-autogen/monitor/diagnostic-settings/categories.yml +++ b/latest/docs-ref-autogen/monitor/diagnostic-settings/categories.yml @@ -108,5 +108,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Retrieve service diagnostic settings categories. diff --git a/latest/docs-ref-autogen/monitor/diagnostic-settings/subscription.yml b/latest/docs-ref-autogen/monitor/diagnostic-settings/subscription.yml index e06245c082..59cf39f600 100644 --- a/latest/docs-ref-autogen/monitor/diagnostic-settings/subscription.yml +++ b/latest/docs-ref-autogen/monitor/diagnostic-settings/subscription.yml @@ -205,5 +205,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage diagnostic settings for subscription. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/cluster.yml b/latest/docs-ref-autogen/monitor/log-analytics/cluster.yml index ad7e4e51e7..6ebd7d627c 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/cluster.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/cluster.yml @@ -355,5 +355,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage Azure log analytics cluster. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/query-pack.yml b/latest/docs-ref-autogen/monitor/log-analytics/query-pack.yml index 747248f899..f428777bb8 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/query-pack.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/query-pack.yml @@ -220,5 +220,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage Azure log analytics query pack. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/query-pack/query.yml b/latest/docs-ref-autogen/monitor/log-analytics/query-pack/query.yml index e048ded01c..7bce9f9902 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/query-pack/query.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/query-pack/query.yml @@ -345,5 +345,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage the query of log analytics query pack. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace.yml index ec6174c3de..073436948f 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace.yml @@ -526,5 +526,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage Azure log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/data-export.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/data-export.yml index 98818b0b9d..ee465e4634 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/data-export.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/data-export.yml @@ -240,5 +240,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage data export ruls for log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-service.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-service.yml index abc750b513..9f1310d0c7 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-service.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-service.yml @@ -315,5 +315,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Linked services is used to define a relation from the workspace to another Azure resource. Log Analytics and Azure resources then leverage this connection in their operations. Example uses of Linked Services in Log Analytics workspace are Automation account and workspace association to CMK. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-storage.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-storage.yml index f1457217a9..86ae170c20 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-storage.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/linked-storage.yml @@ -245,5 +245,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage linked storage account for log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/pack.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/pack.yml index ec72e679ff..b46dc6c547 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/pack.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/pack.yml @@ -114,5 +114,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage intelligent packs for log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/saved-search.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/saved-search.yml index 4310d1d30b..2e60ada3ed 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/saved-search.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/saved-search.yml @@ -228,5 +228,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage saved search for log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table.yml index 4366f2712f..1d5f7d052b 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table.yml @@ -359,5 +359,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage tables for log analytics workspace. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/restore.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/restore.yml index a63873ea31..d425aed256 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/restore.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/restore.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage tables for log analytics workspace restore logs table. diff --git a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/search-job.yml b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/search-job.yml index f857ce894b..95d0e9e130 100644 --- a/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/search-job.yml +++ b/latest/docs-ref-autogen/monitor/log-analytics/workspace/table/search-job.yml @@ -98,5 +98,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage tables for log analytics workspace search results table. diff --git a/latest/docs-ref-autogen/monitor/log-profiles.yml b/latest/docs-ref-autogen/monitor/log-profiles.yml index 58e7c5fd4b..e9a0e317ad 100644 --- a/latest/docs-ref-autogen/monitor/log-profiles.yml +++ b/latest/docs-ref-autogen/monitor/log-profiles.yml @@ -211,5 +211,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage log profiles. diff --git a/latest/docs-ref-autogen/monitor/metrics.yml b/latest/docs-ref-autogen/monitor/metrics.yml index c205ae7a1e..f25b11122c 100644 --- a/latest/docs-ref-autogen/monitor/metrics.yml +++ b/latest/docs-ref-autogen/monitor/metrics.yml @@ -237,5 +237,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: View Azure resource metrics. diff --git a/latest/docs-ref-autogen/monitor/metrics/alert.yml b/latest/docs-ref-autogen/monitor/metrics/alert.yml index dd5ca6b7ad..0b2c0c3c09 100644 --- a/latest/docs-ref-autogen/monitor/metrics/alert.yml +++ b/latest/docs-ref-autogen/monitor/metrics/alert.yml @@ -380,5 +380,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage near-realtime metric alert rules. diff --git a/latest/docs-ref-autogen/monitor/metrics/alert/condition.yml b/latest/docs-ref-autogen/monitor/metrics/alert/condition.yml index 257c025d48..840cc2d874 100644 --- a/latest/docs-ref-autogen/monitor/metrics/alert/condition.yml +++ b/latest/docs-ref-autogen/monitor/metrics/alert/condition.yml @@ -150,5 +150,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage near-realtime metric alert rule conditions. diff --git a/latest/docs-ref-autogen/monitor/metrics/alert/dimension.yml b/latest/docs-ref-autogen/monitor/metrics/alert/dimension.yml index e3c3910527..6bb529fcfa 100644 --- a/latest/docs-ref-autogen/monitor/metrics/alert/dimension.yml +++ b/latest/docs-ref-autogen/monitor/metrics/alert/dimension.yml @@ -65,5 +65,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage near-realtime metric alert rule dimensions. diff --git a/latest/docs-ref-autogen/monitor/private-link-scope.yml b/latest/docs-ref-autogen/monitor/private-link-scope.yml index dbacf0ece9..c02a7a7ab4 100644 --- a/latest/docs-ref-autogen/monitor/private-link-scope.yml +++ b/latest/docs-ref-autogen/monitor/private-link-scope.yml @@ -298,5 +298,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage monitor private link scope resource. diff --git a/latest/docs-ref-autogen/monitor/private-link-scope/private-endpoint-connection.yml b/latest/docs-ref-autogen/monitor/private-link-scope/private-endpoint-connection.yml index b885b4af27..b36e9132d2 100644 --- a/latest/docs-ref-autogen/monitor/private-link-scope/private-endpoint-connection.yml +++ b/latest/docs-ref-autogen/monitor/private-link-scope/private-endpoint-connection.yml @@ -357,5 +357,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage private endpoint connection of a private link scope resource. diff --git a/latest/docs-ref-autogen/monitor/private-link-scope/private-link-resource.yml b/latest/docs-ref-autogen/monitor/private-link-scope/private-link-resource.yml index 451c8e1259..71cf323ccb 100644 --- a/latest/docs-ref-autogen/monitor/private-link-scope/private-link-resource.yml +++ b/latest/docs-ref-autogen/monitor/private-link-scope/private-link-resource.yml @@ -105,5 +105,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage private link resource of a private link scope resource. diff --git a/latest/docs-ref-autogen/monitor/private-link-scope/scoped-resource.yml b/latest/docs-ref-autogen/monitor/private-link-scope/scoped-resource.yml index 77ecb60069..f4686f2802 100644 --- a/latest/docs-ref-autogen/monitor/private-link-scope/scoped-resource.yml +++ b/latest/docs-ref-autogen/monitor/private-link-scope/scoped-resource.yml @@ -258,5 +258,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/18/2023 + ms.date: 09/19/2023 description: Manage scoped resource of a private link scope resource. diff --git a/latest/docs-ref-autogen/mysql/flexible-server.yml b/latest/docs-ref-autogen/mysql/flexible-server.yml index 88981744b6..4ffae8c7e9 100644 --- a/latest/docs-ref-autogen/mysql/flexible-server.yml +++ b/latest/docs-ref-autogen/mysql/flexible-server.yml @@ -247,7 +247,7 @@ directCommands: summary: |- The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. - name: --admin-user -u - defaultValue: "rigidgiraffe0" + defaultValue: "earthyeagle6" summary: |- Administrator username for the server. Once set, it cannot be changed. - name: --auto-scale-iops @@ -697,7 +697,7 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --restore-time - defaultValue: "2023-09-21T08:33:53+00:00" + defaultValue: "2023-09-28T12:11:18+00:00" summary: |- The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+00:00The default value is set to current time. - name: --sku-name diff --git a/latest/docs-ref-autogen/mysql/flexible-server/replica.yml b/latest/docs-ref-autogen/mysql/flexible-server/replica.yml index 8b11144717..3d6919132b 100644 --- a/latest/docs-ref-autogen/mysql/flexible-server/replica.yml +++ b/latest/docs-ref-autogen/mysql/flexible-server/replica.yml @@ -17,12 +17,18 @@ directCommands: az mysql flexible-server replica create --replica-name --resource-group --source-server + [--backup-retention] + [--geo-redundant-backup {Disabled, Enabled}] + [--iops] [--location] [--no-wait] [--private-dns-zone] [--public-access {Disabled, Enabled}] + [--sku-name] + [--storage-size] [--subnet] [--tags] + [--tier] [--vnet] [--zone] examples: @@ -43,6 +49,16 @@ directCommands: summary: |- The name or resource ID of the source server to restore from. optionalParameters: + - name: --backup-retention + summary: |- + The number of days a backup is retained. Range of 1 to 35 days. Default is 7 days. + - name: --geo-redundant-backup + parameterValueGroup: "Disabled, Enabled" + summary: |- + Whether or not geo redundant backup is enabled. + - name: --iops + summary: |- + Number of IOPS to be allocated for this server. You will get certain amount of free IOPS based on compute and storage provisioned. The default value for IOPS is free IOPS. To learn more about IOPS based on compute and storage, refer to IOPS in Azure Database for MySQL Flexible Server. - name: --location -l summary: |- Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. @@ -57,12 +73,21 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: |- Determines the public access. + - name: --sku-name + summary: |- + The name of the compute SKU. Follows the convention Standard_{VM name}. Examples: Standard_B1ms. + - name: --storage-size + summary: |- + The storage capacity of the server. Minimum is 32 GiB and max is 16 TiB. - name: --subnet summary: |- Name or resource ID of a new or existing subnet. This parameter only applies if you are creating cross region replica server with private access. For in-region read replica with private access, source server settings are carried over and this parameter is ignored. If you want to use a subnet from different resource group or subscription, please provide resource ID instead of name. Please note that the subnet will be delegated to flexibleServers. After delegation, this subnet cannot be used for any other type of Azure resources. - name: --tags summary: |- Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --tier + summary: |- + Compute tier of the server. Accepted values: Burstable, GeneralPurpose, MemoryOptimized. - name: --vnet summary: |- Name or ID of a new or existing virtual network. This parameter only applies if you are creating cross region replica server with private access. For in-region read replica with private access, source server settings are carried over and this parameter is ignored. If you want to use a vnet from different resource group or subscription, please provide a resource ID. The name must be between 2 to 64 characters. The name must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens. diff --git a/latest/docs-ref-autogen/mysql/server.yml b/latest/docs-ref-autogen/mysql/server.yml index 3cefca99b6..fe0cf8dc86 100644 --- a/latest/docs-ref-autogen/mysql/server.yml +++ b/latest/docs-ref-autogen/mysql/server.yml @@ -49,7 +49,7 @@ directCommands: summary: |- The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. - name: --admin-user -u - defaultValue: "liquidraisins1" + defaultValue: "stingycake4" summary: |- Administrator username for the server. Once set, it cannot be changed. - name: --assign-identity diff --git a/latest/docs-ref-autogen/netappfiles.yml b/latest/docs-ref-autogen/netappfiles.yml index f04ef67cce..c6b9ebf54e 100644 --- a/latest/docs-ref-autogen/netappfiles.yml +++ b/latest/docs-ref-autogen/netappfiles.yml @@ -98,6 +98,7 @@ commands: - az_netappfiles_volume_backup_create() - az_netappfiles_volume_backup_delete() - az_netappfiles_volume_backup_list() +- az_netappfiles_volume_backup_restore-files() - az_netappfiles_volume_backup_restore-status() - az_netappfiles_volume_backup_show() - az_netappfiles_volume_backup_status() @@ -114,6 +115,7 @@ commands: - az_netappfiles_volume_export-policy_remove() - az_netappfiles_volume_export-policy_wait() - az_netappfiles_volume_finalize-relocation() +- az_netappfiles_volume_get-groupid-list-for-ldapuser() - az_netappfiles_volume_list() - az_netappfiles_volume_list(netappfiles-preview) - az_netappfiles_volume_pool-change() diff --git a/latest/docs-ref-autogen/netappfiles/account.yml b/latest/docs-ref-autogen/netappfiles/account.yml index ec686312df..10fde50df1 100644 --- a/latest/docs-ref-autogen/netappfiles/account.yml +++ b/latest/docs-ref-autogen/netappfiles/account.yml @@ -34,6 +34,9 @@ directCommands: - summary: |- Create an ANF account syntax: az netappfiles account create -g mygroup --name myname -l location --tags testtag1=mytag1 testtag3=mytagg + - summary: |- + Create an ANF account enabling CMK encryption + syntax: az netappfiles account create -g mygroup --name myname -l location --key-source Microsoft.KeyVault --key-name cmkKey --key-vault-uri https://mykvuri.vault.azure.net/ --keyvault-resource-id myKeyVaultResourceId --identity-type UserAssigned --user-assigned-identity myIdenityResourceId requiredParameters: - isRequired: true name: --account-name --name -a -n @@ -366,18 +369,15 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py syntax: >- az netappfiles account update [--account-name] - [--add] [--encryption] - [--force-string] + [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}] [--ids] [--key-name] [--key-source {Microsoft.KeyVault, Microsoft.NetApp}] [--key-vault-uri] [--keyvault-resource-id] [--no-wait] - [--remove] [--resource-group] - [--set] [--subscription] [--tags] [--user-assigned-identity] @@ -389,19 +389,15 @@ directCommands: - name: --account-name --name -a -n summary: |- The name of the ANF account. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --encryption summary: |- Encryption settings. isDeprecated: true deprecateInfo: Argument 'encryption' has been deprecated and will be removed in a future release. Use '--key-source' instead. - - name: --force-string - defaultValue: "False" + - name: --identity-type + parameterValueGroup: "None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned" summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. + The identity type. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -426,17 +422,9 @@ directCommands: defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/latest/docs-ref-autogen/netappfiles/account/ad.yml b/latest/docs-ref-autogen/netappfiles/account/ad.yml index db29c54dda..be455e8ac8 100644 --- a/latest/docs-ref-autogen/netappfiles/account/ad.yml +++ b/latest/docs-ref-autogen/netappfiles/account/ad.yml @@ -21,13 +21,11 @@ directCommands: --username [--account-name] [--ad-name] - [--add] [--administrators] [--aes-encryption {false, true}] [--allow-local-ldap-users {false, true}] [--backup-operators] [--encrypt-dc-conn {false, true}] - [--force-string] [--group-dn] [--group-filter] [--ids] @@ -37,11 +35,9 @@ directCommands: [--no-wait] [--organizational-unit] [--preferred-servers-for-ldap-client] - [--remove] [--resource-group] [--security-operators] [--server-root-ca-cert] - [--set] [--site] [--subscription] [--user-dn] @@ -77,10 +73,6 @@ directCommands: - name: --ad-name summary: |- Name of the active directory machine. This optional parameter is used only while creating kerberos volume. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --administrators summary: |- Users to be added to the Built-in Administrators active directory group. A space separated string of unique usernames without domain specifier. @@ -99,10 +91,6 @@ directCommands: parameterValueGroup: "false, true" summary: |- If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --group-dn summary: |- This specifies the group DN, which overrides the base DN for group lookups. @@ -132,10 +120,6 @@ directCommands: - name: --preferred-servers-for-ldap-client -p summary: |- Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -145,10 +129,6 @@ directCommands: - name: --server-root-ca-cert summary: |- When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --site summary: |- The Active Directory site the service will limit Domain Controller discovery to. @@ -237,13 +217,11 @@ directCommands: --username [--account-name] [--ad-name] - [--add] [--administrators] [--aes-encryption {false, true}] [--allow-local-ldap-users {false, true}] [--backup-operators] [--encrypt-dc-conn {false, true}] - [--force-string] [--group-dn] [--group-filter] [--ids] @@ -252,11 +230,9 @@ directCommands: [--ldap-signing {false, true}] [--no-wait] [--organizational-unit] - [--remove] [--resource-group] [--security-operators] [--server-root-ca-cert] - [--set] [--site] [--subscription] [--user-dn] @@ -296,10 +272,6 @@ directCommands: - name: --ad-name summary: |- Name of the active directory machine. This optional parameter is used only while creating kerberos volume. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --administrators summary: |- Users to be added to the Built-in Administrators active directory group. A space separated list of unique usernames without domain specifier. @@ -318,10 +290,6 @@ directCommands: parameterValueGroup: "false, true" summary: |- If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --group-dn summary: |- This specifies the group DN, which overrides the base DN for group lookups. @@ -348,10 +316,6 @@ directCommands: - name: --organizational-unit summary: |- The Organizational Unit (OU) within the Windows Active Directory. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -361,10 +325,6 @@ directCommands: - name: --server-root-ca-cert summary: |- When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --site summary: |- The Active Directory site the service will limit Domain Controller discovery to. @@ -464,5 +424,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Account active directories. diff --git a/latest/docs-ref-autogen/netappfiles/account/backup-policy.yml b/latest/docs-ref-autogen/netappfiles/account/backup-policy.yml index f448d955ab..4596b1804a 100644 --- a/latest/docs-ref-autogen/netappfiles/account/backup-policy.yml +++ b/latest/docs-ref-autogen/netappfiles/account/backup-policy.yml @@ -339,5 +339,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Backup Policy Resources. diff --git a/latest/docs-ref-autogen/netappfiles/account/backup.yml b/latest/docs-ref-autogen/netappfiles/account/backup.yml index bbb401bd50..3b7b55aa7a 100644 --- a/latest/docs-ref-autogen/netappfiles/account/backup.yml +++ b/latest/docs-ref-autogen/netappfiles/account/backup.yml @@ -195,5 +195,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Account Backup Resources. diff --git a/latest/docs-ref-autogen/netappfiles/pool.yml b/latest/docs-ref-autogen/netappfiles/pool.yml index 941c319c0a..7b4929e70e 100644 --- a/latest/docs-ref-autogen/netappfiles/pool.yml +++ b/latest/docs-ref-autogen/netappfiles/pool.yml @@ -316,16 +316,12 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py syntax: >- az netappfiles pool update [--account-name] - [--add] [--cool-access {false, true}] - [--force-string] [--ids] [--name] [--no-wait] [--qos-type] - [--remove] [--resource-group] - [--set] [--size] [--subscription] [--tags] @@ -337,18 +333,10 @@ directCommands: - name: --account-name -a summary: |- The name of the ANF account. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --cool-access parameterValueGroup: "false, true" summary: |- If enabled (true) the pool can contain cool Access enabled volumes. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -362,17 +350,9 @@ directCommands: - name: --qos-type summary: |- The qos type of the ANF pool. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --size summary: |- The size for the ANF pool. Must be an integer number of tebibytes in multiples of 4. diff --git a/latest/docs-ref-autogen/netappfiles/resource.yml b/latest/docs-ref-autogen/netappfiles/resource.yml index 42fce3c5b3..923c7b61a4 100644 --- a/latest/docs-ref-autogen/netappfiles/resource.yml +++ b/latest/docs-ref-autogen/netappfiles/resource.yml @@ -50,5 +50,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Provides operations for Azure NetApp Files (ANF) Account Resources. diff --git a/latest/docs-ref-autogen/netappfiles/snapshot/policy.yml b/latest/docs-ref-autogen/netappfiles/snapshot/policy.yml index f758675fea..9a787d9e40 100644 --- a/latest/docs-ref-autogen/netappfiles/snapshot/policy.yml +++ b/latest/docs-ref-autogen/netappfiles/snapshot/policy.yml @@ -204,12 +204,10 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py syntax: >- az netappfiles snapshot policy update [--account-name] - [--add] [--daily-hour] [--daily-minute] [--daily-snapshots] [--enabled {false, true}] - [--force-string] [--hourly-minute] [--hourly-snapshots] [--ids] @@ -218,9 +216,7 @@ directCommands: [--monthly-minute] [--monthly-snapshots] [--no-wait] - [--remove] [--resource-group] - [--set] [--snapshot-policy-name] [--subscription] [--tags] @@ -236,10 +232,6 @@ directCommands: - name: --account-name -a summary: |- The name of the ANF account. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --daily-hour summary: |- Which hour in UTC timezone the daily snapshot should be taken. @@ -254,10 +246,6 @@ directCommands: parameterValueGroup: "false, true" summary: |- The property to decide policy is enabled or not. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --hourly-minute summary: |- Which minute the hourly snapshot should be taken. @@ -283,17 +271,9 @@ directCommands: defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --snapshot-policy-name summary: |- The name of the ANF snapshot policy. @@ -444,5 +424,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Snapshot Policy Resources. diff --git a/latest/docs-ref-autogen/netappfiles/subvolume.yml b/latest/docs-ref-autogen/netappfiles/subvolume.yml index 7e15768b92..9d35ea3ead 100644 --- a/latest/docs-ref-autogen/netappfiles/subvolume.yml +++ b/latest/docs-ref-autogen/netappfiles/subvolume.yml @@ -366,5 +366,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Subvolume Resources. diff --git a/latest/docs-ref-autogen/netappfiles/subvolume/metadata.yml b/latest/docs-ref-autogen/netappfiles/subvolume/metadata.yml index 36d718944c..b98e4826f6 100644 --- a/latest/docs-ref-autogen/netappfiles/subvolume/metadata.yml +++ b/latest/docs-ref-autogen/netappfiles/subvolume/metadata.yml @@ -74,5 +74,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Subvolume Metadata Resources. diff --git a/latest/docs-ref-autogen/netappfiles/volume-group.yml b/latest/docs-ref-autogen/netappfiles/volume-group.yml index 323b337403..a1ba66f077 100644 --- a/latest/docs-ref-autogen/netappfiles/volume-group.yml +++ b/latest/docs-ref-autogen/netappfiles/volume-group.yml @@ -19,7 +19,6 @@ directCommands: --pool-name --ppg --resource-group - --sap-sid --vnet [--add-snapshot-capacity] [--backup-nfsv3] @@ -44,6 +43,7 @@ directCommands: [--no-wait] [--number-of-hots] [--prefix] + [--sap-sid] [--shared-repl-skd] [--shared-size] [--shared-src-id] @@ -79,10 +79,6 @@ directCommands: name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --sap-sid - summary: |- - The SAP system ID. Three characters long alpha-numeric string. - isRequired: true name: --vnet summary: |- @@ -162,6 +158,10 @@ directCommands: - name: --prefix summary: |- All volume names will be prefixed with the given text. The default values for prefix text depends on system role. For PRIMARY it will be `""` and HA it will be `"HA-"`. + - name: --sap-sid + defaultValue: "dev" + summary: |- + The SAP system ID. Three characters long alpha-numeric string. - name: --shared-repl-skd summary: |- Replication Schedule for shared volume. @@ -376,5 +376,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Volume Group Resources. diff --git a/latest/docs-ref-autogen/netappfiles/volume.yml b/latest/docs-ref-autogen/netappfiles/volume.yml index 4427865e94..1722e5da51 100644 --- a/latest/docs-ref-autogen/netappfiles/volume.yml +++ b/latest/docs-ref-autogen/netappfiles/volume.yml @@ -91,7 +91,7 @@ directCommands: [--default-user-quota] [--delete-base-snapshot {false, true}] [--enable-subvolumes] - [--encryption-key-source] + [--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}] [--endpoint-type] [--has-root-access {false, true}] [--is-def-quota-enabled {false, true}] @@ -137,6 +137,9 @@ directCommands: - summary: |- Create an ANF volume with zones (Availability Zone) specified syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --zones zone1 + - summary: |- + Create an ANF volume with CMK Encryption + syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --network-features Standard --protocol-types NFSv4.1 --rule-index 1 --allowed-clients '10.7.0.0/24' --kerberos-enabled false --policy-enforced true --encryption-key-source Microsoft.KeyVault --kv-private-endpoint-id myPrivateEndpointId requiredParameters: - isRequired: true name: --account-name -a @@ -211,8 +214,9 @@ directCommands: summary: |- Flag indicating whether subvolume operations are enabled on the volume. Possible values are Enabled and Disabled. Default value is Disabled. - name: --encryption-key-source + parameterValueGroup: "Microsoft.KeyVault, Microsoft.NetApp" summary: |- - Encryption Key Source. + Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. - name: --endpoint-type summary: |- Whether the volume is source ("src") or destination ("dst"). @@ -538,6 +542,54 @@ directCommands: - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- uid: az_netappfiles_volume_get-groupid-list-for-ldapuser() + name: az netappfiles volume get-groupid-list-for-ldapuser + description: |- + Returns the list of group Ids for a specific LDAP User. + status: GA + sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py + syntax: >- + az netappfiles volume get-groupid-list-for-ldapuser --username + [--account-name] + [--ids] + [--name] + [--no-wait] + [--pool-name] + [--resource-group] + [--subscription] + examples: + - summary: |- + Get Group Id List for LDAP User myuser. + syntax: az netappfiles volume get-groupid-list-for-ldapuser -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --username myuser + requiredParameters: + - isRequired: true + name: --username -u + summary: |- + Username is required to fetch the group to which user is part of. + optionalParameters: + - name: --account-name -a + summary: |- + The name of the ANF account. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name --volume-name -n -v + summary: |- + The name of the ANF volume. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --pool-name -p + summary: |- + The name of the ANF pool. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_netappfiles_volume_list() name: az netappfiles volume list summary: |- @@ -906,24 +958,21 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py syntax: >- az netappfiles volume update [--account-name] - [--add] [--backup-enabled {false, true}] [--backup-policy-id] [--cool-access {false, true}] [--coolness-period] [--default-group-quota] [--default-user-quota] - [--force-string] [--ids] [--is-def-quota-enabled {false, true}] [--name] [--no-wait] [--policy-enforced {false, true}] [--pool-name] - [--remove] [--resource-group] [--service-level {Premium, Standard, Ultra}] - [--set] + [--snapshot-dir-visible {false, true}] [--snapshot-policy-id] [--subscription] [--tags] @@ -938,10 +987,6 @@ directCommands: - name: --account-name -a summary: |- The name of the ANF account. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --backup-enabled parameterValueGroup: "false, true" summary: |- @@ -962,10 +1007,6 @@ directCommands: - name: --default-user-quota summary: |- Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -987,10 +1028,6 @@ directCommands: - name: --pool-name -p summary: |- The name of the ANF pool. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -998,10 +1035,10 @@ directCommands: parameterValueGroup: "Premium, Standard, Ultra" summary: |- The service level. - - name: --set - defaultValue: "[]" + - name: --snapshot-dir-visible + parameterValueGroup: "false, true" summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. + If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). - name: --snapshot-policy-id summary: |- Snapshot Policy ResourceId. @@ -1165,6 +1202,7 @@ commands: - az_netappfiles_volume_backup_create() - az_netappfiles_volume_backup_delete() - az_netappfiles_volume_backup_list() +- az_netappfiles_volume_backup_restore-files() - az_netappfiles_volume_backup_restore-status() - az_netappfiles_volume_backup_show() - az_netappfiles_volume_backup_status() @@ -1181,6 +1219,7 @@ commands: - az_netappfiles_volume_export-policy_remove() - az_netappfiles_volume_export-policy_wait() - az_netappfiles_volume_finalize-relocation() +- az_netappfiles_volume_get-groupid-list-for-ldapuser() - az_netappfiles_volume_list() - az_netappfiles_volume_list(netappfiles-preview) - az_netappfiles_volume_pool-change() diff --git a/latest/docs-ref-autogen/netappfiles/volume/backup.yml b/latest/docs-ref-autogen/netappfiles/volume/backup.yml index 7872211f36..1f953067d2 100644 --- a/latest/docs-ref-autogen/netappfiles/volume/backup.yml +++ b/latest/docs-ref-autogen/netappfiles/volume/backup.yml @@ -89,7 +89,7 @@ directCommands: Name of the ANF account. - name: --backup-name -b summary: |- - The name of the backup. Required. + The name of the backup. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -144,6 +144,70 @@ directCommands: name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. +- uid: az_netappfiles_volume_backup_restore-files() + name: az netappfiles volume backup restore-files + summary: |- + Restore the specified files from the specified backup to the active filesystem. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'netappfiles volume backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Core + editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py + syntax: >- + az netappfiles volume backup restore-files --destination-path + --destination-volume-id + --file-paths + [--account-name] + [--backup-name] + [--ids] + [--name] + [--no-wait] + [--pool-name] + [--resource-group] + [--subscription] + examples: + - summary: |- + Restore files from backup + syntax: az netappfiles volume backup restore-files -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname --backup-name mybackupname --file-paths myfilepaths --destination-path mydestinationpath --destination-volume-id volumeresourceid + requiredParameters: + - isRequired: true + name: --destination-path + summary: |- + Destination folder where the files will be restored. + - isRequired: true + name: --destination-volume-id + summary: |- + Resource Id of the destination volume on which the files need to be restored. + - isRequired: true + name: --file-paths + summary: |- + Required. A space separated string of filed to be restored. + optionalParameters: + - name: --account-name -a + summary: |- + The name of the ANF account. + - name: --backup-name -b + summary: |- + The name of the ANF backup. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name --volume-name -n -v + summary: |- + The name of the ANF volume. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --pool-name -p + summary: |- + The name of the ANF pool. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_netappfiles_volume_backup_restore-status() name: az netappfiles volume backup restore-status summary: |- @@ -372,7 +436,7 @@ directCommands: Name of the ANF account. - name: --backup-name -b summary: |- - The name of the backup. Required. + The name of the backup. - name: --created defaultValue: "False" summary: |- @@ -419,6 +483,7 @@ commands: - az_netappfiles_volume_backup_create() - az_netappfiles_volume_backup_delete() - az_netappfiles_volume_backup_list() +- az_netappfiles_volume_backup_restore-files() - az_netappfiles_volume_backup_restore-status() - az_netappfiles_volume_backup_show() - az_netappfiles_volume_backup_status() @@ -449,5 +514,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Volume Backup Resources. diff --git a/latest/docs-ref-autogen/netappfiles/volume/export-policy.yml b/latest/docs-ref-autogen/netappfiles/volume/export-policy.yml index 4e58e90ea6..1f04b06669 100644 --- a/latest/docs-ref-autogen/netappfiles/volume/export-policy.yml +++ b/latest/docs-ref-autogen/netappfiles/volume/export-policy.yml @@ -21,9 +21,7 @@ directCommands: --unix-read-only {false, true} --unix-read-write {false, true} [--account-name] - [--add] [--chown-mode] - [--force-string] [--has-root-access {false, true}] [--ids] [--kerberos5-r] @@ -35,10 +33,8 @@ directCommands: [--name] [--no-wait] [--pool-name] - [--remove] [--resource-group] [--rule-index] - [--set] [--subscription] examples: - summary: |- @@ -78,17 +74,9 @@ directCommands: - name: --account-name -a summary: |- The name of the ANF account. - - name: --add - defaultValue: "[]" - summary: |- - Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . - name: --chown-mode summary: |- This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. Possible values include- Restricted, Unrestricted. Default value- Restricted. - - name: --force-string - defaultValue: "False" - summary: |- - When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --has-root-access parameterValueGroup: "false, true" summary: |- @@ -124,20 +112,12 @@ directCommands: - name: --pool-name -p summary: |- The name of the ANF pool. - - name: --remove - defaultValue: "[]" - summary: |- - Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --rule-index summary: |- Order index. No number can be repeated. Max 6 rules. - - name: --set - defaultValue: "[]" - summary: |- - Update an object by specifying a property path and value to set. Example: --set property1.property2=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -339,5 +319,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Volume export policies. diff --git a/latest/docs-ref-autogen/netappfiles/volume/quota-rule.yml b/latest/docs-ref-autogen/netappfiles/volume/quota-rule.yml index 5239c2e045..21ddedcb10 100644 --- a/latest/docs-ref-autogen/netappfiles/volume/quota-rule.yml +++ b/latest/docs-ref-autogen/netappfiles/volume/quota-rule.yml @@ -388,5 +388,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Volume Quota Rules Resources. diff --git a/latest/docs-ref-autogen/netappfiles/volume/replication.yml b/latest/docs-ref-autogen/netappfiles/volume/replication.yml index 3dc0da6e20..7ff9fe71ef 100644 --- a/latest/docs-ref-autogen/netappfiles/volume/replication.yml +++ b/latest/docs-ref-autogen/netappfiles/volume/replication.yml @@ -393,5 +393,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 06/28/2023 + ms.date: 09/07/2023 description: Manage Azure NetApp Files (ANF) Volume replication operations. diff --git a/latest/docs-ref-autogen/network/virtual-appliance.yml b/latest/docs-ref-autogen/network/virtual-appliance.yml index 2042db679e..f9dfe7f843 100644 --- a/latest/docs-ref-autogen/network/virtual-appliance.yml +++ b/latest/docs-ref-autogen/network/virtual-appliance.yml @@ -20,10 +20,12 @@ directCommands: syntax: >- az network virtual-appliance create --name --resource-group + [--additional-nics] [--asn] [--boot-blobs] [--cloud-blobs] [--cloud-init-config] + [--delegation] [--location] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--scale-unit] @@ -45,6 +47,9 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. optionalParameters: + - name: --additional-nics + summary: |- + Details required for Additional Network Interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --asn summary: |- VirtualAppliance ASN. The valid value ranges from 1 to 4294967295. @@ -57,6 +62,9 @@ directCommands: - name: --cloud-init-config --init-config summary: |- CloudInitConfiguration scripts that will be run during cloud initialization. + - name: --delegation + summary: |- + The delegation for the Virtual Appliance Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. @@ -129,12 +137,21 @@ directCommands: previewOrExperimentalInfo: "Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Core editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/network/_help.py - syntax: az network virtual-appliance list [--resource-group] + syntax: >- + az network virtual-appliance list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all Azure network virtual appliances. syntax: az network virtual-appliance list -g MyRG optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -184,10 +201,12 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/network/_help.py syntax: >- az network virtual-appliance update [--add] + [--additional-nics] [--asn] [--boot-blobs] [--cloud-blobs] [--cloud-init-config] + [--delegation] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--location] @@ -210,6 +229,9 @@ directCommands: - name: --add summary: |- Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --additional-nics + summary: |- + Details required for Additional Network Interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --asn summary: |- VirtualAppliance ASN. The valid value ranges from 1 to 4294967295. @@ -222,6 +244,9 @@ directCommands: - name: --cloud-init-config --init-config summary: |- CloudInitConfiguration scripts that will be run during cloud initialization. + - name: --delegation + summary: |- + The delegation for the Virtual Appliance Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --force-string parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- diff --git a/latest/docs-ref-autogen/network/vnet/subnet.yml b/latest/docs-ref-autogen/network/vnet/subnet.yml index 340848e46f..16647f57b9 100644 --- a/latest/docs-ref-autogen/network/vnet/subnet.yml +++ b/latest/docs-ref-autogen/network/vnet/subnet.yml @@ -20,6 +20,7 @@ directCommands: --resource-group --vnet-name [--address-prefixes] + [--default-outbound {0, 1, f, false, n, no, t, true, y, yes}] [--delegations] [--disable-private-endpoint-network-policies {0, 1, f, false, n, no, t, true, y, yes}] [--disable-private-link-service-network-policies {0, 1, f, false, n, no, t, true, y, yes}] @@ -53,6 +54,10 @@ directCommands: - name: --address-prefixes summary: |- Space-separated list of address prefixes in CIDR format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --default-outbound --default-outbound-access + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. - name: --delegations summary: |- Space-separated list of services to whom the subnet should be delegated, e.g., Microsoft.Sql/servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. @@ -131,6 +136,8 @@ directCommands: syntax: >- az network vnet subnet list --resource-group --vnet-name + [--max-items] + [--next-token] examples: - summary: |- List the subnets in a virtual network. @@ -144,6 +151,13 @@ directCommands: name: --vnet-name summary: |- The virtual network (VNet) name. + optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_network_vnet_subnet_list-available-delegations() name: az network vnet subnet list-available-delegations summary: |- @@ -153,6 +167,8 @@ directCommands: editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/network/_help.py syntax: >- az network vnet subnet list-available-delegations [--location] + [--max-items] + [--next-token] [--resource-group] examples: - summary: |- @@ -165,6 +181,12 @@ directCommands: - name: --location -l summary: |- Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. When not specified, the location of the resource group will be used. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -250,6 +272,7 @@ directCommands: syntax: >- az network vnet subnet update [--add] [--address-prefixes] + [--default-outbound {0, 1, f, false, n, no, t, true, y, yes}] [--delegations] [--disable-private-endpoint-network-policies {0, 1, f, false, n, no, t, true, y, yes}] [--disable-private-link-service-network-policies {0, 1, f, false, n, no, t, true, y, yes}] @@ -287,6 +310,10 @@ directCommands: - name: --address-prefixes summary: |- Space-separated list of address prefixes in CIDR format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --default-outbound --default-outbound-access + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. - name: --delegations summary: |- Space-separated list of services to whom the subnet should be delegated, e.g., Microsoft.Sql/servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. diff --git a/latest/docs-ref-autogen/policy.yml b/latest/docs-ref-autogen/policy.yml index 409a342f6f..0f1e5672c3 100644 --- a/latest/docs-ref-autogen/policy.yml +++ b/latest/docs-ref-autogen/policy.yml @@ -86,5 +86,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policies. diff --git a/latest/docs-ref-autogen/policy/assignment.yml b/latest/docs-ref-autogen/policy/assignment.yml index ace01fd73b..4be66c0ada 100644 --- a/latest/docs-ref-autogen/policy/assignment.yml +++ b/latest/docs-ref-autogen/policy/assignment.yml @@ -268,5 +268,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy assignments. diff --git a/latest/docs-ref-autogen/policy/assignment/identity.yml b/latest/docs-ref-autogen/policy/assignment/identity.yml index b0d6410661..f50f25d8bb 100644 --- a/latest/docs-ref-autogen/policy/assignment/identity.yml +++ b/latest/docs-ref-autogen/policy/assignment/identity.yml @@ -135,5 +135,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage a policy assignment's managed identity. diff --git a/latest/docs-ref-autogen/policy/assignment/non-compliance-message.yml b/latest/docs-ref-autogen/policy/assignment/non-compliance-message.yml index d8033d3a13..dd74741250 100644 --- a/latest/docs-ref-autogen/policy/assignment/non-compliance-message.yml +++ b/latest/docs-ref-autogen/policy/assignment/non-compliance-message.yml @@ -140,5 +140,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage a policy assignment's non-compliance messages. diff --git a/latest/docs-ref-autogen/policy/attestation.yml b/latest/docs-ref-autogen/policy/attestation.yml index 871394018e..2e69e46d2c 100644 --- a/latest/docs-ref-autogen/policy/attestation.yml +++ b/latest/docs-ref-autogen/policy/attestation.yml @@ -332,5 +332,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy attestations. diff --git a/latest/docs-ref-autogen/policy/definition.yml b/latest/docs-ref-autogen/policy/definition.yml index 81f719ba3b..aecf56a570 100644 --- a/latest/docs-ref-autogen/policy/definition.yml +++ b/latest/docs-ref-autogen/policy/definition.yml @@ -240,5 +240,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy definitions. diff --git a/latest/docs-ref-autogen/policy/event.yml b/latest/docs-ref-autogen/policy/event.yml index 6b36dfc575..e9565fe98a 100644 --- a/latest/docs-ref-autogen/policy/event.yml +++ b/latest/docs-ref-autogen/policy/event.yml @@ -158,5 +158,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage policy events. diff --git a/latest/docs-ref-autogen/policy/exemption.yml b/latest/docs-ref-autogen/policy/exemption.yml index a66ca2f3f1..bbbb1e1b7b 100644 --- a/latest/docs-ref-autogen/policy/exemption.yml +++ b/latest/docs-ref-autogen/policy/exemption.yml @@ -261,5 +261,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy exemptions. diff --git a/latest/docs-ref-autogen/policy/metadata.yml b/latest/docs-ref-autogen/policy/metadata.yml index 02c0ee0916..54983d4909 100644 --- a/latest/docs-ref-autogen/policy/metadata.yml +++ b/latest/docs-ref-autogen/policy/metadata.yml @@ -70,5 +70,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get policy metadata resources. diff --git a/latest/docs-ref-autogen/policy/remediation.yml b/latest/docs-ref-autogen/policy/remediation.yml index 6cf1134241..4a388dabce 100644 --- a/latest/docs-ref-autogen/policy/remediation.yml +++ b/latest/docs-ref-autogen/policy/remediation.yml @@ -265,5 +265,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy remediations. diff --git a/latest/docs-ref-autogen/policy/remediation/deployment.yml b/latest/docs-ref-autogen/policy/remediation/deployment.yml index 406ac4968d..c411e11044 100644 --- a/latest/docs-ref-autogen/policy/remediation/deployment.yml +++ b/latest/docs-ref-autogen/policy/remediation/deployment.yml @@ -72,5 +72,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy remediation deployments. diff --git a/latest/docs-ref-autogen/policy/set-definition.yml b/latest/docs-ref-autogen/policy/set-definition.yml index 26bae18277..bf4e79f18a 100644 --- a/latest/docs-ref-autogen/policy/set-definition.yml +++ b/latest/docs-ref-autogen/policy/set-definition.yml @@ -256,5 +256,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource policy set definitions. diff --git a/latest/docs-ref-autogen/policy/state.yml b/latest/docs-ref-autogen/policy/state.yml index a497880a28..e1927c57a7 100644 --- a/latest/docs-ref-autogen/policy/state.yml +++ b/latest/docs-ref-autogen/policy/state.yml @@ -313,5 +313,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage policy compliance states. diff --git a/latest/docs-ref-autogen/postgres/flexible-server.yml b/latest/docs-ref-autogen/postgres/flexible-server.yml index feca100ccc..edb2962dad 100644 --- a/latest/docs-ref-autogen/postgres/flexible-server.yml +++ b/latest/docs-ref-autogen/postgres/flexible-server.yml @@ -80,6 +80,7 @@ directCommands: [--resource-group] [--sku-name] [--standby-zone] + [--storage-auto-grow {Disabled, Enabled}] [--storage-size] [--subnet] [--subnet-prefixes] @@ -251,6 +252,11 @@ directCommands: az postgres flexible-server create -g testGroup -n testServer --location testLocation --geo-redundant-backup Enabled \ --key $keyIdentifier --identity testIdentity --backup-key $geoKeyIdentifier --backup-identity geoIdentity + + + # create flexible server with storage auto-grow as Enabled. Accepted values Enabled / Disabled. Default value for storage auto-grow is "Disabled". + + az postgres flexible-server create -g testGroup -n testServer --location testLocation --storage-auto-grow Enabled optionalParameters: - name: --active-directory-auth defaultValue: "Disabled" @@ -264,7 +270,7 @@ directCommands: summary: |- The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. - name: --admin-user -u - defaultValue: "grouchyoil8" + defaultValue: "violentpolenta4" summary: |- Administrator username for the server. Once set, it cannot be changed. - name: --backup-identity @@ -323,6 +329,11 @@ directCommands: - name: --standby-zone summary: |- The availability zone information of the standby server when high availability is enabled. + - name: --storage-auto-grow + defaultValue: "Disabled" + parameterValueGroup: "Disabled, Enabled" + summary: |- + Enable or disable autogrow of the storage. Default value is Enabled. - name: --storage-size defaultValue: "128" summary: |- @@ -675,7 +686,7 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --restore-time - defaultValue: "2023-09-21T08:33:54+00:00" + defaultValue: "2023-09-28T12:11:17+00:00" summary: |- The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+00:00The default value is set to current time. - name: --subnet @@ -966,6 +977,7 @@ directCommands: [--set] [--sku-name] [--standby-zone] + [--storage-auto-grow {Disabled, Enabled}] [--storage-size] [--subscription] [--tags] @@ -1003,6 +1015,9 @@ directCommands: - summary: |- Update a flexible server to update private DNS zone for a VNET enabled server, using private DNS zone in the different resource group and subscription. Private DNS zone will be linked to the VNET if not already linked. syntax: az postgres flexible-server update --resource-group testGroup --name testserver --private-dns-zone /subscriptions/{SubId2}/resourceGroups/{testGroup2}/providers/Microsoft.Network/privateDnsZones/testDNS.postgres.database.azure.com + - summary: |- + Update a flexible server's storage to enable / disable storage auto-grow. + syntax: az postgres flexible-server update --resource-group testGroup --name testserver --storage-auto-grow Enabled optionalParameters: - name: --active-directory-auth parameterValueGroup: "Disabled, Enabled" @@ -1071,6 +1086,10 @@ directCommands: - name: --standby-zone summary: |- The availability zone information of the standby server when high availability is enabled. + - name: --storage-auto-grow + parameterValueGroup: "Disabled, Enabled" + summary: |- + Enable or disable autogrow of the storage. Default value is Enabled. - name: --storage-size summary: |- The storage capacity of the server. Minimum is 32 GiB and max is 16 TiB. diff --git a/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml b/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml index 9ab9816d44..52b1b32df5 100644 --- a/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -21,22 +21,20 @@ directCommands: previewOrExperimentalInfo: "Command group 'postgres server-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az postgres server-arc endpoint list --name - [--k8s-namespace] + az postgres server-arc endpoint list [--k8s-namespace] + [--name] [--use-k8s] examples: - summary: |- List Azure Arc enabled PostgreSQL server endpoints. syntax: az postgres server-arc endpoint list --name postgres01 --k8s-namespace namespace --use-k8s - requiredParameters: - - isRequired: true - name: --name -n - summary: |- - Name of the Azure Arc enabled PostgreSQL server. optionalParameters: - name: --k8s-namespace -k summary: |- The Kubernetes namespace where the Azure Arc enabled PostgreSQL server is deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used. + - name: --name -n + summary: |- + Name of the Azure Arc enabled PostgreSQL server. - name: --use-k8s summary: |- Use local Kubernetes APIs to perform this action. diff --git a/latest/docs-ref-autogen/postgres/server.yml b/latest/docs-ref-autogen/postgres/server.yml index b45d0d8541..1525a9713e 100644 --- a/latest/docs-ref-autogen/postgres/server.yml +++ b/latest/docs-ref-autogen/postgres/server.yml @@ -48,7 +48,7 @@ directCommands: summary: |- The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters. - name: --admin-user -u - defaultValue: "typicalsparrow7" + defaultValue: "vibrantbuffalo8" summary: |- Administrator username for the server. Once set, it cannot be changed. - name: --assign-identity diff --git a/latest/docs-ref-autogen/provider.yml b/latest/docs-ref-autogen/provider.yml index 5898a00528..cd5a602cb6 100644 --- a/latest/docs-ref-autogen/provider.yml +++ b/latest/docs-ref-autogen/provider.yml @@ -139,5 +139,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage resource providers. diff --git a/latest/docs-ref-autogen/provider/operation.yml b/latest/docs-ref-autogen/provider/operation.yml index 518ec011a4..6544ce6305 100644 --- a/latest/docs-ref-autogen/provider/operation.yml +++ b/latest/docs-ref-autogen/provider/operation.yml @@ -59,5 +59,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Get provider operations metadatas. diff --git a/latest/docs-ref-autogen/provider/permission.yml b/latest/docs-ref-autogen/provider/permission.yml index 95846fb713..b5f93b9261 100644 --- a/latest/docs-ref-autogen/provider/permission.yml +++ b/latest/docs-ref-autogen/provider/permission.yml @@ -46,5 +46,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage permissions for a provider. diff --git a/latest/docs-ref-autogen/resource-mover.yml b/latest/docs-ref-autogen/resource-mover.yml index 3c5aa44f8e..1d9ccf7ffc 100644 --- a/latest/docs-ref-autogen/resource-mover.yml +++ b/latest/docs-ref-autogen/resource-mover.yml @@ -4,12 +4,10 @@ name: az resource-mover extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage Resource Mover Service API. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus' +status: GA sourceType: Extension commands: - az_resource-mover_move-collection diff --git a/latest/docs-ref-autogen/resource-mover/move-collection.yml b/latest/docs-ref-autogen/resource-mover/move-collection.yml index 6b7c846932..dc729bc40b 100644 --- a/latest/docs-ref-autogen/resource-mover/move-collection.yml +++ b/latest/docs-ref-autogen/resource-mover/move-collection.yml @@ -4,31 +4,29 @@ name: az resource-mover move-collection extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-collection** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-collection. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-collection_bulk-remove(resource-mover) name: az resource-mover move-collection bulk-remove summary: |- - Remove the set of move-resources from move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection bulk-remove [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] [--move-resources] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Remove a move-resource in a move-collection. @@ -40,53 +38,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - Name of the move-collection. + The Move Collection Name. - name: --move-resources summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_commit(resource-mover) name: az resource-mover move-collection commit summary: |- - Commit the set of resources. The commit operation is triggered on the move-resources in the move-state 'CommitPending' or 'CommitFailed', on a successful completion the move-resource's move-state do a transition to Committed. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection commit --move-resources - [--ids] + az resource-mover move-collection commit [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Commit a move-resource. + Commit a move-resource in the move-collection (RegionToRegion) syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Commit resources in the move-collection (RegionToZone) + syntax: az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -94,87 +90,100 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_create(resource-mover) name: az resource-mover move-collection create summary: |- - Create a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a move collection. + description: |- + Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- az resource-mover move-collection create --move-collection-name --resource-group [--identity] [--location] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] [--source-region] [--tags] [--target-region] + [--version] examples: - summary: |- - Create a move-collection with system assigned identity. + Create a move-collection with system assigned identity. (RegionToRegion) syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Create a zonal type move-collection with system assigned identity. (RegionToZone) + syntax: az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone requiredParameters: - isRequired: true name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --location -l summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + The geo-location where the resource lives. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. - name: --source-region summary: |- - The source region. + Gets or sets the source region. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --target-region summary: |- - The target region. + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_delete(resource-mover) name: az resource-mover move-collection delete summary: |- - Delete a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a move collection. + description: |- + The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection delete [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -188,14 +197,14 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -206,29 +215,24 @@ directCommands: - uid: az_resource-mover_move-collection_discard(resource-mover) name: az resource-mover move-collection discard summary: |- - Discard the set of resources. The discard operation is triggered on the move-resources in the move-state 'CommitPending' or 'DiscardFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection discard --move-resources - [--ids] + az resource-mover move-collection discard [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Discard a remove-resource. syntax: az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -236,50 +240,51 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_initiate-move(resource-mover) name: az resource-mover move-collection initiate-move summary: |- - Move the set of resources. The move operation is triggered after the move-resources are in the move-state 'MovePending' or 'MoveFailed', on a successful completion the move-resource's move-state do a transition to CommitPending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection initiate-move --move-resources - [--ids] + az resource-mover move-collection initiate-move [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- - Move the set of resources. + Move the set of resources. (RegionToRegion) syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. + - summary: |- + Move VMs into zonal configuration within the same region (RegionToZone) + syntax: az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- @@ -287,33 +292,39 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_list(resource-mover) name: az resource-mover move-collection list summary: |- - List details of the move-collections. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List all the Move Collections in the subscription. + description: |- + The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension - syntax: az resource-mover move-collection list [--resource-group] + syntax: >- + az resource-mover move-collection list [--max-items] + [--next-token] + [--resource-group] examples: - summary: |- List all move-collections. @@ -322,94 +333,114 @@ directCommands: List all move-collections by resource group. syntax: az resource-mover move-collection list -g MyResourceGroup optionalParameters: + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - uid: az_resource-mover_move-collection_list-required-for(resource-mover) name: az resource-mover move-collection list-required-for summary: |- - List the move-resources for which an arm resource is required for. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List of the move resources for which an arm resource is required for. + description: |- + The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection list-required-for --move-collection-name - --resource-group - --source-id - examples: - - summary: |- - List the move-resources for which an arm resource is required for. - syntax: az resource-mover move-collection list-required-for --name MyMoveCollection --resource-group MyResourceGroup --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/nic1" + az resource-mover move-collection list-required-for --source-id + [--ids] + [--move-collection-name] + [--resource-group] + [--subscription] requiredParameters: - isRequired: true - name: --move-collection-name --name -n + name: --source-id + summary: |- + The sourceId for which the api is invoked. + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name --name -n summary: |- The Move Collection Name. - - isRequired: true - name: --resource-group -g + - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. - - isRequired: true - name: --source-id + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --subscription summary: |- - The sourceId for which the api is invoked. + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_list-unresolved-dependency(resource-mover) name: az resource-mover move-collection list-unresolved-dependency summary: |- - List the details of the unresolved dependencies in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Lists a list of unresolved dependencies. + description: |- + The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection list-unresolved-dependency --move-collection-name --resource-group [--dependency-level {Descendant, Direct}] + [--filter] + [--max-items] + [--next-token] + [--orderby] examples: - summary: |- List the unresolved dependencies. syntax: az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. optionalParameters: - name: --dependency-level parameterValueGroup: "Descendant, Direct" summary: |- - The dependency level. + Defines the dependency level. + - name: --filter + summary: |- + The filter to apply on the operation. For example, $apply=filter(count eq 2). + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. + - name: --orderby + summary: |- + OData order by query option. For example, you can use $orderby=Count desc. - uid: az_resource-mover_move-collection_prepare(resource-mover) name: az resource-mover move-collection prepare summary: |- - Prepare the set of resources. The prepare operation is on the move-resources that are in the move-state 'PreparePending' or 'PrepareFailed', on a successful completion the move-resource's move-state do a transition to MovePending. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true. + description: |- + The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario. + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection prepare --move-resources - [--ids] + az resource-mover move-collection prepare [--ids] [--input-type {MoveResourceId, MoveResourceSourceId}] [--move-collection-name] - [--no-wait] + [--move-resources] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] - [--validate-only {false, true}] + [--validate-only {0, 1, f, false, n, no, t, true, y, yes}] examples: - summary: |- Prepare a move-resource. syntax: az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup - requiredParameters: - - isRequired: true - name: --move-resources - summary: |- - The list of resource Id's, by default it accepts move-resource id's unless the input type is switched via --input-type. optionalParameters: - name: --ids summary: |- @@ -417,66 +448,72 @@ directCommands: - name: --input-type parameterValueGroup: "MoveResourceId, MoveResourceSourceId" summary: |- - Define the input type of --move-resources. + Defines the move resource input type. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-resources + summary: |- + Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --validate-only - parameterValueGroup: "false, true" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- - Indicate whether the operation needs to only run pre-requisite. + Gets or sets a value indicating whether the operation needs to only run pre-requisite. - uid: az_resource-mover_move-collection_resolve-dependency(resource-mover) name: az resource-mover move-collection resolve-dependency summary: |- - Compute, resolve and validate the dependencies of the move-resources in the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Computes, resolves and validate the dependencies of the moveResources in the move collection. + description: |- + Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection resolve-dependency [--ids] [--move-collection-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] examples: - summary: |- - Resolve the dependency of the move-resources. + Resolve the dependency of the move-resources. (RegionToRegion) syntax: az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup + - summary: |- + Resolve the dependency of the move-resources. (RegionToZone) + syntax: az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup optionalParameters: - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_show(resource-mover) name: az resource-mover move-collection show summary: |- - Get the details of a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the move collection. + description: |- + The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection show [--ids] @@ -493,64 +530,94 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-collection_update(resource-mover) name: az resource-mover move-collection update summary: |- - Update a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Update a move collection. + description: |- + Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region). + status: GA sourceType: Extension syntax: >- - az resource-mover move-collection update [--identity] + az resource-mover move-collection update [--add] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] + [--identity] [--ids] [--move-collection-name] + [--move-region] + [--move-type {RegionToRegion, RegionToZone}] + [--remove] [--resource-group] + [--set] + [--source-region] [--subscription] [--tags] + [--target-region] + [--version] examples: - summary: |- Update a move-collection. syntax: az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup optionalParameters: + - name: --add + summary: |- + Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty . + - name: --force-string + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: |- + When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON. - name: --identity summary: |- - Define the MSI properties of the move-collection. - description: |- - Usage: --identity type=XX principal-id=XX tenant-id=XX - - type: The type of identity used for the resource mover service. - principal-id: The principal id. - tenant-id: The tenant id. + Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. + - name: --move-region + summary: |- + Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. + - name: --move-type + parameterValueGroup: "RegionToRegion, RegionToZone" + summary: |- + Defines the MoveType. + - name: --remove + summary: |- + Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + - name: --set + summary: |- + Update an object by specifying a property path and value to set. Example: --set property1.property2=. + - name: --source-region + summary: |- + Gets or sets the source region. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - name: --tags summary: |- - Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. + - name: --target-region + summary: |- + Gets or sets the target region. + - name: --version + summary: |- + Gets or sets the version of move collection. - uid: az_resource-mover_move-collection_wait(resource-mover) name: az resource-mover move-collection wait summary: |- - Place the CLI in a waiting state until a condition of the move-collection is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-collection wait [--created] @@ -564,13 +631,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully deleted. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --deleted - - summary: |- - Pause executing next line of CLI script until the move-collection is successfully created. - syntax: az resource-mover move-collection wait --name MyMoveCollection --resource-group MyResourceGroup --created optionalParameters: - name: --created defaultValue: "False" @@ -596,10 +656,10 @@ directCommands: Polling interval in seconds. - name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/latest/docs-ref-autogen/resource-mover/move-resource.yml b/latest/docs-ref-autogen/resource-mover/move-resource.yml index 3f887cf77d..a1af1c1331 100644 --- a/latest/docs-ref-autogen/resource-mover/move-resource.yml +++ b/latest/docs-ref-autogen/resource-mover/move-resource.yml @@ -4,118 +4,86 @@ name: az resource-mover move-resource extensionInformation: >- > [!NOTE] - > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **resource-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az resource-mover move-resource** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. summary: |- Manage move-resource. -status: Experimental -isExperimental: true -previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +status: GA sourceType: Extension directCommands: - uid: az_resource-mover_move-resource_add(resource-mover) name: az resource-mover move-resource add summary: |- - Create or update a move-resource to the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Create a Move Resource in the move collection. + description: |- + The 'az resource-mover move-resource add' command remains same for both 'RegionToRegion' (default) and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- - az resource-mover move-resource add --move-collection-name - --move-resource-name - --resource-group - [--depends-on-overrides] + az resource-mover move-resource add [--depends-on-overrides] [--existing-target-id] - [--no-wait] + [--ids] + [--move-collection-name] + [--move-resource-name] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] + [--resource-group] [--resource-settings] [--source-id] + [--subscription] examples: - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings '{ - "resourceType": "Microsoft.Network/virtualNetworks", - "targetResourceName": "MyVNet-target" - }' + Add a vNet as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet\" --resource-settings '{ \"resourceType\": \"Microsoft.Network/virtualNetworks\", \"targetResourceName\": \"MyVNet-target\" }'" - summary: |- - Add a vNet as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/MyVNet" - - --resource-settings @resource-settings.json + Add a VM as a move-resource to the move-collection. (RegionToZone) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyZonalMoveCollection --name MyVMMoveResource --source-id \"/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetResourceName\": \"MyVM\", \"targetAvailabilityZone\": \"2\", \"targetVmSize\": \"Standard_B2s\" }'" - summary: |- - Add a VM as a move-resource to the move-collection. - syntax: >- - az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName - - --source-id "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM" - - --depends-on-overrides id="/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" target-id="/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC" - - --resource-settings '{ - "resourceType": "Microsoft.Compute/virtualMachines", - "targetAvailabilitySetId": "/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet", - "targetAvailabilityZone": "2", - "targetResourceName": "MyVM-target", - "targetVmSize": null, - "userManagedIdentities": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] - }' - requiredParameters: - - isRequired: true - name: --move-collection-name - summary: |- - The move-collection name. - - isRequired: true - name: --move-resource-name --name -n - summary: |- - The move-resource name. - - isRequired: true - name: --resource-group -g - summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Add a VM as a move-resource to the move-collection. (RegionToRegion) + syntax: "az resource-mover move-resource add --resource-group MyResourceGroup --move-collection-name MyMoveCollection --name MoveResourceName --source-id \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/virtualMachines/MyVM\" --depends-on-overrides id=\"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" target-id=\"/subscriptions/subID/resourceGroups/westusRG/providers/Microsoft.Network/networkInterfaces/MyNIC\" --resource-settings '{ \"resourceType\": \"Microsoft.Compute/virtualMachines\", \"targetAvailabilitySetId\": \"/subscriptions/subID/resourceGroups/eastusRG/providers/Microsoft.Compute/availabilitySets/MyAVSet\", \"targetAvailabilityZone\": \"2\", \"targetResourceName\": \"MyVM-target\", \"targetVmSize\": null, \"userManagedIdentities\": [/subscriptions/subid/resourceGroups/eastusRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/umi1] }'" optionalParameters: - name: --depends-on-overrides summary: |- - The move-resource dependencies overrides. - description: |- - Usage: --depends-on-overrides id=XX target-id=XX - - id: The ARM ID of the dependent resource. - target-id: The resource ARM ID of either the move-resource or the resource ARM ID of the dependent resource. - - Multiple actions can be specified by using more than one --depends-on-overrides argument. + Gets or sets the move resource dependencies overrides. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. - name: --existing-target-id summary: |- - The existing target ARM Id of the resource. + Gets or sets the existing target ARM Id of the resource. + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --move-collection-name + summary: |- + The Move Collection Name. + - name: --move-resource-name --name -n + summary: |- + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --resource-settings summary: |- - The resource settings. Expected value: json-string/@json-file. + The resource settings. Expected value: json-string/@json-file. Support json-file and yaml-file. - name: --source-id summary: |- - The Source ARM Id of the resource. + Gets or sets the Source ARM Id of the resource. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_delete(resource-mover) name: az resource-mover move-resource delete summary: |- - Delete a move-resource from the move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Delete a Move Resource from the move collection. + description: |- + The 'az resource-mover move-resource delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource delete [--ids] [--move-collection-name] [--move-resource-name] - [--no-wait] + [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] [--subscription] [--yes] @@ -129,17 +97,17 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --no-wait - defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -150,34 +118,47 @@ directCommands: - uid: az_resource-mover_move-resource_list(resource-mover) name: az resource-mover move-resource list summary: |- - List the move-resources in a move-collection. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + List the Move Resources in the move collection. + description: |- + The 'az resource-mover move-resource list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource list --move-collection-name --resource-group + [--filter] + [--max-items] + [--next-token] examples: - summary: |- List the move-resources in a move-collection. syntax: az resource-mover move-resource list --move-collection-name MyMoveCollection --resource-group MyResourceGroup requiredParameters: - isRequired: true - name: --move-collection-name + name: --move-collection-name --name -n summary: |- - The move-collection name. + The Move Collection Name. - isRequired: true name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. + optionalParameters: + - name: --filter + summary: |- + The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. + - name: --max-items + summary: |- + Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in `--next-token` argument of a subsequent command. + - name: --next-token + summary: |- + Token to specify where to start paginating. This is the token value from a previously truncated response. - uid: az_resource-mover_move-resource_show(resource-mover) name: az resource-mover move-resource show summary: |- - Get the details of a move-resource. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Get the Move Resource. + description: |- + The 'az resource-mover move-resource show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource show [--ids] @@ -195,23 +176,21 @@ directCommands: One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - uid: az_resource-mover_move-resource_wait(resource-mover) name: az resource-mover move-resource wait summary: |- - Place the CLI in a waiting state until a condition of the move-resource is met. - status: Experimental - isExperimental: true - previewOrExperimentalInfo: "Command group 'resource-mover' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + Place the CLI in a waiting state until a condition is met. + status: GA sourceType: Extension syntax: >- az resource-mover move-resource wait [--created] @@ -226,13 +205,6 @@ directCommands: [--subscription] [--timeout] [--updated] - examples: - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully created. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --created - - summary: |- - Pause executing next line of CLI script until the move-resource is successfully deleted. - syntax: az resource-mover move-resource wait --move-collection-name MyMoveCollection --name MyMoveResource --resource-group MyResourceGroup --deleted optionalParameters: - name: --created defaultValue: "False" @@ -258,13 +230,13 @@ directCommands: Polling interval in seconds. - name: --move-collection-name summary: |- - The move-collection name. + The Move Collection Name. - name: --move-resource-name --name -n summary: |- - The move-resource name. + The Move Resource Name. - name: --resource-group -g summary: |- - Name of resource group. You can configure the default group using `az configure --defaults group=`. + Name of resource group. You can configure the default group using az configure --defaults group=. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. diff --git a/latest/docs-ref-autogen/resource.yml b/latest/docs-ref-autogen/resource.yml index 135aabce03..6b769beb7f 100644 --- a/latest/docs-ref-autogen/resource.yml +++ b/latest/docs-ref-autogen/resource.yml @@ -732,5 +732,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resources. diff --git a/latest/docs-ref-autogen/resource/link.yml b/latest/docs-ref-autogen/resource/link.yml index f2b488a62a..6be731ae36 100644 --- a/latest/docs-ref-autogen/resource/link.yml +++ b/latest/docs-ref-autogen/resource/link.yml @@ -154,5 +154,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Linking is a feature of the Resource Manager. It enables declaring relationships between resources even if they do not reside in the same resource group. Linking has no impact on resource usage, billing, or role-based access. It allows for managing multiple resources across groups as a single unit. diff --git a/latest/docs-ref-autogen/resource/lock.yml b/latest/docs-ref-autogen/resource/lock.yml index 55f2453025..b542c25008 100644 --- a/latest/docs-ref-autogen/resource/lock.yml +++ b/latest/docs-ref-autogen/resource/lock.yml @@ -267,5 +267,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Manage Azure resource level locks. diff --git a/latest/docs-ref-autogen/scvmm.yml b/latest/docs-ref-autogen/scvmm.yml index c68bc47dce..d32b42e906 100644 --- a/latest/docs-ref-autogen/scvmm.yml +++ b/latest/docs-ref-autogen/scvmm.yml @@ -52,6 +52,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/latest/docs-ref-autogen/scvmm/vm.yml b/latest/docs-ref-autogen/scvmm/vm.yml index 56f846f67d..452bb2d8c2 100644 --- a/latest/docs-ref-autogen/scvmm/vm.yml +++ b/latest/docs-ref-autogen/scvmm/vm.yml @@ -22,7 +22,6 @@ directCommands: sourceType: Extension syntax: >- az scvmm vm create --custom-location - --location --name --resource-group [--admin-password] @@ -34,6 +33,7 @@ directCommands: [--dynamic-memory-max] [--dynamic-memory-min] [--inventory-item] + [--location] [--memory-size] [--nic] [--no-wait] @@ -55,10 +55,6 @@ directCommands: name: --custom-location summary: |- Name or ID of the custom location that will manage this resource. - - isRequired: true - name: --location -l - summary: |- - Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - isRequired: true name: --name -n summary: |- @@ -96,6 +92,9 @@ directCommands: - name: --inventory-item -i summary: |- Name or ID of the inventory item. + - name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. - name: --memory-size summary: |- Desired memory size in MBs for the vm. @@ -170,13 +169,13 @@ directCommands: previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: >- - az scvmm vm delete [--deleteFromHost] + az scvmm vm delete [--delete-from-host] + [--delete-machine] [--force] [--ids] [--name] [--no-wait] [--resource-group] - [--retain] [--subscription] [--yes] examples: @@ -196,12 +195,15 @@ directCommands: Delete the VM from SCVMM syntax: az scvmm vm delete --subscription contoso-sub --resource-group contoso-rg --name contoso-avset --deleteFromHost optionalParameters: - - name: --deleteFromHost + - name: --delete-from-host summary: |- - Delete the VM from the SCVMM. + Delete the VM from the VMware host. + - name: --delete-machine + summary: |- + Delete the parent Microsoft.HybridCompute Machine resource. - name: --force summary: |- - Force the resource to be deleted from azure. + Force delete the azure resource. - name: --ids summary: |- One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. @@ -215,9 +217,6 @@ directCommands: - name: --resource-group -g summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - - name: --retain - summary: |- - Disable the VM from azure but retain the VM in VMM. - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. @@ -270,8 +269,10 @@ directCommands: name: az scvmm vm list summary: |- Retrieve a list of VMs. - status: Preview + status: Preview and Deprecated + isDeprecated: true isPreview: true + deprecateInfo: This command has been deprecated and will be removed in a future release. Use 'scvmm vm show' instead. previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" sourceType: Extension syntax: az scvmm vm list [--resource-group] @@ -467,7 +468,6 @@ directCommands: summary: |- Name of resource group. You can configure the default group using `az configure --defaults group=`. - name: --skip-shutdown - defaultValue: "False" parameterValueGroup: "false, true" summary: |- Skip shutdown and power-off immediately. @@ -605,6 +605,15 @@ commands: - az_scvmm_vm_disk_show(scvmm) - az_scvmm_vm_disk_update(scvmm) - az_scvmm_vm_disk_wait(scvmm) +- az_scvmm_vm_extension +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +- az_scvmm_vm_guest-agent +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) - az_scvmm_vm_list(scvmm) - az_scvmm_vm_nic - az_scvmm_vm_nic_add(scvmm) diff --git a/latest/docs-ref-autogen/scvmm/vm/extension.yml b/latest/docs-ref-autogen/scvmm/vm/extension.yml new file mode 100644 index 0000000000..e868aabd26 --- /dev/null +++ b/latest/docs-ref-autogen/scvmm/vm/extension.yml @@ -0,0 +1,304 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_extension +name: az scvmm vm extension +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Manage vm extension with scvmm. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_extension_create(scvmm) + name: az scvmm vm extension create + summary: |- + The operation to create the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension create --location + --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Create a VM Extension + syntax: az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --location -l + summary: |- + Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`. + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +- uid: az_scvmm_vm_extension_delete(scvmm) + name: az scvmm vm extension delete + summary: |- + The operation to delete the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension delete [--ids] + [--name] + [--no-wait] + [--resource-group] + [--subscription] + [--vm-name] + [--yes] + examples: + - summary: |- + Delete a VM Extension + syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm where the extension should be deleted. + - name: --yes -y + defaultValue: "False" + summary: |- + Do not prompt for confirmation. +- uid: az_scvmm_vm_extension_list(scvmm) + name: az scvmm vm extension list + summary: |- + The operation to get all extensions of a non-Azure vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension list --resource-group + --vm-name + [--expand] + examples: + - summary: |- + Get all VM Extensions + syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm containing the extension. + optionalParameters: + - name: --expand + summary: |- + The expand expression to apply on the operation. +- uid: az_scvmm_vm_extension_show(scvmm) + name: az scvmm vm extension show + summary: |- + The operation to get the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension show [--ids] + [--name] + [--resource-group] + [--subscription] + [--vm-name] + examples: + - summary: |- + Get VM Extension + syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg + optionalParameters: + - name: --ids + summary: |- + One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments. + - name: --name + summary: |- + The name of the vm extension. + - name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --vm-name + summary: |- + The name of the vm containing the extension. +- uid: az_scvmm_vm_extension_update(scvmm) + name: az scvmm vm extension update + summary: |- + The operation to update the extension. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm extension update --name + --resource-group + --vm-name + [--auto-upgrade-minor {false, true}] + [--enable-auto-upgrade {false, true}] + [--force-update-tag] + [--no-wait] + [--protected-settings] + [--publisher] + [--settings] + [--tags] + [--type] + [--type-handler-version] + examples: + - summary: |- + Update a VM Extension + syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg + requiredParameters: + - isRequired: true + name: --name + summary: |- + The name of the vm extension. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + The name of the vm where the extension should be created or updated. + optionalParameters: + - name: --auto-upgrade-minor + parameterValueGroup: "false, true" + summary: |- + Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. + - name: --enable-auto-upgrade + parameterValueGroup: "false, true" + summary: |- + Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. + - name: --force-update-tag + summary: |- + How the extension handler should be forced to update even if the extension configuration has not changed. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. + - name: --protected-settings + summary: |- + The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file. + - name: --publisher + summary: |- + The name of the extension handler publisher. + - name: --settings + summary: |- + Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file. + - name: --tags + summary: |- + Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. + - name: --type + summary: |- + Specify the type of the extension; an example is "CustomScriptExtension". + - name: --type-handler-version + summary: |- + Specifies the version of the script handler. +commands: +- az_scvmm_vm_extension_create(scvmm) +- az_scvmm_vm_extension_delete(scvmm) +- az_scvmm_vm_extension_list(scvmm) +- az_scvmm_vm_extension_show(scvmm) +- az_scvmm_vm_extension_update(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Manage vm extension with scvmm. diff --git a/latest/docs-ref-autogen/scvmm/vm/guest-agent.yml b/latest/docs-ref-autogen/scvmm/vm/guest-agent.yml new file mode 100644 index 0000000000..ff7c276ac9 --- /dev/null +++ b/latest/docs-ref-autogen/scvmm/vm/guest-agent.yml @@ -0,0 +1,111 @@ +### YamlMime:AzureCLIGroup +uid: az_scvmm_vm_guest-agent +name: az scvmm vm guest-agent +extensionInformation: >- + > [!NOTE] + + > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm guest-agent** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions. +summary: |- + Vm guest agent. +status: Preview +isPreview: true +previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" +sourceType: Extension +directCommands: +- uid: az_scvmm_vm_guest-agent_enable(scvmm) + name: az scvmm vm guest-agent enable + summary: |- + Enable guest agent on the vm. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent enable --password + --resource-group + --username + --vm-name + [--https-proxy] + [--no-wait] + examples: + - summary: |- + Enable guest agent on the vm + syntax: az scvmm vm guest-agent enable --username contoso-user --password contoso-pass --resource-group contoso-rg --subscription contoso-sub --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --password + summary: |- + Username password credentials to use for connecting to the VM. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --username + summary: |- + Username to use for connecting to the vm. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. + optionalParameters: + - name: --https-proxy + summary: |- + HTTPS proxy server url for the VM. + - name: --no-wait + defaultValue: "False" + summary: |- + Do not wait for the long-running operation to finish. +- uid: az_scvmm_vm_guest-agent_show(scvmm) + name: az scvmm vm guest-agent show + summary: |- + Get details of a guest agent by guest agent name, resource-group and vm name. + status: Preview + isPreview: true + previewOrExperimentalInfo: "Command group 'scvmm' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus" + sourceType: Extension + syntax: >- + az scvmm vm guest-agent show --resource-group + --vm-name + examples: + - summary: |- + Get details of a guest agent + syntax: az scvmm vm guest-agent show --resource-group contoso-rg --vm-name contoso-vm + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --vm-name + summary: |- + Name of the VM. +commands: +- az_scvmm_vm_guest-agent_enable(scvmm) +- az_scvmm_vm_guest-agent_show(scvmm) +globalParameters: +- name: --debug + summary: |- + Increase logging verbosity to show all debug logs. +- name: --help -h + summary: |- + Show this help message and exit. +- name: --only-show-errors + summary: |- + Only show errors, suppressing warnings. +- name: --output -o + defaultValue: "json" + parameterValueGroup: "json, jsonc, table, tsv" + summary: |- + Output format. +- name: --query + summary: |- + JMESPath query string. See http://jmespath.org/ for more information and examples. +- name: --subscription + summary: |- + Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. +- name: --verbose + summary: |- + Increase logging verbosity. Use --debug for full debug logs. +metadata: + description: Vm guest agent. diff --git a/latest/docs-ref-autogen/service-page/Stack HCI VM.yml b/latest/docs-ref-autogen/service-page/Stack HCI VM.yml deleted file mode 100644 index 4a4347faaa..0000000000 --- a/latest/docs-ref-autogen/service-page/Stack HCI VM.yml +++ /dev/null @@ -1,6 +0,0 @@ -### YamlMime:AzureCLIGroup -uid: sp-Stack_HCI_VM -name: Stack HCI VM -commands: -- az_stack-hci-vm -metadata: {} diff --git a/latest/docs-ref-autogen/spring-cloud/connection.yml b/latest/docs-ref-autogen/spring-cloud/connection.yml index 7a19d9b2dc..b8f3501d17 100644 --- a/latest/docs-ref-autogen/spring-cloud/connection.yml +++ b/latest/docs-ref-autogen/spring-cloud/connection.yml @@ -38,14 +38,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -55,10 +57,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -90,17 +92,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -132,23 +136,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_list-support-types() name: az spring-cloud connection list-support-types summary: |- @@ -198,23 +204,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_validate() name: az spring-cloud connection validate summary: |- @@ -243,23 +251,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - uid: az_spring-cloud_connection_wait() name: az spring-cloud connection wait summary: |- @@ -289,7 +299,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring-cloud connection. @@ -307,7 +317,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -321,10 +333,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/latest/docs-ref-autogen/spring-cloud/connection/create.yml b/latest/docs-ref-autogen/spring-cloud/connection/create.yml index 789af0ef1a..a36f6ca536 100644 --- a/latest/docs-ref-autogen/spring-cloud/connection/create.yml +++ b/latest/docs-ref-autogen/spring-cloud/connection/create.yml @@ -48,7 +48,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -65,7 +65,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -76,7 +78,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -84,7 +86,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -176,7 +178,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -190,17 +192,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -252,7 +256,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -266,7 +270,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -280,7 +286,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -288,7 +294,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -373,7 +379,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -390,7 +396,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -404,7 +412,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -412,7 +420,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -496,7 +504,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -513,7 +521,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -524,7 +534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -532,7 +542,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -616,7 +626,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +643,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -644,7 +656,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -652,7 +664,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +748,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -750,7 +762,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -761,7 +775,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -769,7 +783,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -852,7 +866,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -866,7 +880,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -880,7 +896,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -888,7 +904,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -974,7 +990,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -988,7 +1004,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1004,10 +1022,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1088,7 +1106,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1105,7 +1123,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1116,7 +1136,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1134,7 +1154,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1189,7 +1209,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1206,14 +1226,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1231,7 +1253,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1298,7 +1320,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1315,7 +1337,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1331,7 +1355,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1349,7 +1373,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1409,7 +1433,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1426,14 +1450,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1451,7 +1477,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1507,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1524,7 +1550,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1535,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1546,7 +1574,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1596,7 +1624,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1613,14 +1641,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1631,7 +1661,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1685,7 +1715,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1699,7 +1729,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1713,7 +1745,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1721,7 +1753,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1800,7 +1832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1814,7 +1846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1825,7 +1859,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1833,7 +1867,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1911,7 +1945,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1928,7 +1962,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1939,7 +1975,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1957,7 +1993,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2030,7 +2066,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2044,7 +2080,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2060,7 +2098,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2068,7 +2106,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2148,7 +2186,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2162,7 +2200,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2173,7 +2213,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2181,7 +2221,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2242,7 +2282,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2256,7 +2296,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2267,7 +2309,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2275,7 +2317,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2355,7 +2397,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2369,7 +2411,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2380,7 +2424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2388,7 +2432,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2445,7 +2489,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2459,7 +2503,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2470,7 +2516,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2478,7 +2524,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/latest/docs-ref-autogen/spring-cloud/connection/update.yml b/latest/docs-ref-autogen/spring-cloud/connection/update.yml index 153e6b0b18..2dfdbef869 100644 --- a/latest/docs-ref-autogen/spring-cloud/connection/update.yml +++ b/latest/docs-ref-autogen/spring-cloud/connection/update.yml @@ -42,7 +42,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -56,7 +56,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -70,7 +72,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -78,7 +80,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -150,7 +152,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--source-id' is not specified. + Name of the spring-cloud app. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -164,7 +166,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -177,7 +181,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--source-id' is not specified. + The resource group which contains the spring-cloud. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -189,7 +193,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the spring-cloud service. Required if '--source-id' is not specified. + Name of the spring-cloud service. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring-cloud. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -231,7 +235,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -245,7 +249,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -259,7 +265,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -267,7 +273,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -332,7 +338,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -346,7 +352,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -360,7 +368,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -368,7 +376,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -433,7 +441,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -447,7 +455,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -461,7 +471,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -469,7 +479,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -534,7 +544,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -548,7 +558,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -562,7 +574,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -570,7 +582,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -635,7 +647,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -649,7 +661,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -663,7 +677,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -671,7 +685,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -736,7 +750,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -750,7 +764,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -764,7 +780,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -772,7 +788,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -836,7 +852,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -850,7 +866,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -864,10 +882,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -929,7 +947,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -943,7 +961,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -957,7 +977,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -972,7 +992,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1011,7 +1031,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1025,7 +1045,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1035,7 +1057,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1050,7 +1072,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1094,7 +1116,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1108,7 +1130,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1122,7 +1146,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1137,7 +1161,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1181,7 +1205,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1195,7 +1219,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1205,7 +1231,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1220,7 +1246,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1260,7 +1286,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1274,7 +1300,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1288,7 +1316,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1296,7 +1324,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1330,7 +1358,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1344,7 +1372,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1354,7 +1384,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1362,7 +1392,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1401,7 +1431,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1415,7 +1445,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1429,7 +1461,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1437,7 +1469,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1501,7 +1533,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1515,7 +1547,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1529,7 +1563,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1537,7 +1571,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1596,7 +1630,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1610,7 +1644,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1624,7 +1660,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1639,7 +1675,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1687,7 +1723,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1701,7 +1737,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1715,7 +1753,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1723,7 +1761,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1785,7 +1823,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1799,7 +1837,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1813,7 +1853,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1821,7 +1861,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1864,7 +1904,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1878,7 +1918,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1892,7 +1934,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1900,7 +1942,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1962,7 +2004,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1976,7 +2018,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1990,7 +2034,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1998,7 +2042,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2040,7 +2084,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the spring-cloud app. Required if '--id' is not specified. + Name of the spring-cloud app. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2054,7 +2098,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2068,7 +2114,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the spring-cloud. Required if '--id' is not specified. + The resource group which contains the spring-cloud. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,7 +2122,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the spring-cloud service. Required if '--id' is not specified. + Name of the spring-cloud service. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/latest/docs-ref-autogen/spring.yml b/latest/docs-ref-autogen/spring.yml index 485ae7f209..65749e42df 100644 --- a/latest/docs-ref-autogen/spring.yml +++ b/latest/docs-ref-autogen/spring.yml @@ -301,6 +301,30 @@ directCommands: - summary: |- List all plans. syntax: az spring list-marketplace-plan -o table +- uid: az_spring_list-support-server-versions(spring) + name: az spring list-support-server-versions + summary: |- + (Standard and Basic Tier Only) List supported server versions. + status: Preview + isPreview: true + previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + sourceType: Extension + syntax: >- + az spring list-support-server-versions --resource-group + --service + examples: + - summary: |- + List supported server versions. + syntax: az spring list-support-server-versions -o table -s MyService -g MyResourceGroup + requiredParameters: + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. - uid: az_spring_show(spring) name: az spring show summary: |- @@ -566,6 +590,7 @@ commands: - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) - az_spring_config-server - az_spring_config-server_clear(spring) - az_spring_config-server_disable(spring) @@ -675,6 +700,7 @@ commands: - az_spring_gateway_update(spring) - az_spring_list(spring) - az_spring_list-marketplace-plan(spring) +- az_spring_list-support-server-versions(spring) - az_spring_service-registry - az_spring_service-registry_bind(spring) - az_spring_service-registry_create(spring) diff --git a/latest/docs-ref-autogen/spring/app.yml b/latest/docs-ref-autogen/spring/app.yml index ab25b24e0f..1cd618bab9 100644 --- a/latest/docs-ref-autogen/spring/app.yml +++ b/latest/docs-ref-autogen/spring/app.yml @@ -415,6 +415,7 @@ directCommands: [--registry-password] [--registry-username] [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}] + [--server-version] [--source-path] [--startup-probe-config] [--target-module] @@ -426,6 +427,9 @@ directCommands: - summary: |- Deploy a pre-built jar to an app with jvm options and environment variables. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar + - summary: |- + Deploy a pre-built war to an app with server version, jvm options and environment variables (Standard and Basic Tiers Only). + syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar - summary: |- Deploy source code to a specific deployment of an app. syntax: az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path @@ -460,7 +464,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -563,6 +567,9 @@ directCommands: parameterValueGroup: "Java_11, Java_17, Java_8, NetCore_31" summary: |- Runtime version of used language. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --source-path summary: |- Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided. diff --git a/latest/docs-ref-autogen/spring/app/deployment.yml b/latest/docs-ref-autogen/spring/app/deployment.yml index dcc3191376..71c8bd02fb 100644 --- a/latest/docs-ref-autogen/spring/app/deployment.yml +++ b/latest/docs-ref-autogen/spring/app/deployment.yml @@ -58,6 +58,7 @@ directCommands: [--scale-rule-metadata] [--scale-rule-name] [--scale-rule-type] + [--server-version] [--skip-clone-settings] [--source-path] [--startup-probe-config] @@ -99,7 +100,7 @@ directCommands: (Enterprise Tier Only) Space-separated APM names. - name: --artifact-path summary: |- - Deploy the specified pre-built artifact (jar or netcore zip). + Deploy the specified pre-built artifact (jar, war or netcore zip, war is in public preview). - name: --build-certificates summary: |- (Enterprise Tier Only) Space-separated certificate names, the certificates are used during build time. @@ -223,6 +224,9 @@ directCommands: - name: --scale-rule-type --srt summary: |- The type of the scale rule. Default: http. + - name: --server-version + summary: |- + (Standard and Basic Tiers Only) Tomcat server version. List all supported server versions by running `az spring list-support-server-versions -o table`. This feature is in public preview. - name: --skip-clone-settings defaultValue: "False" summary: |- diff --git a/latest/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml b/latest/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml index 13f8eaec64..61a4e22133 100644 --- a/latest/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml +++ b/latest/docs-ref-autogen/spring/application-accelerator/customized-accelerator.yml @@ -28,6 +28,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -35,6 +36,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -80,6 +82,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -102,6 +107,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. @@ -238,6 +247,7 @@ directCommands: [--git-branch] [--git-commit] [--git-interval] + [--git-sub-path] [--git-tag] [--host-key] [--host-key-algorithm] @@ -245,6 +255,7 @@ directCommands: [--no-wait] [--password] [--private-key] + [--type {Accelerator, Fragment}] [--username] examples: - summary: |- @@ -290,6 +301,9 @@ directCommands: - name: --git-interval summary: |- Interval in seconds for checking for updates to Git or image repository. + - name: --git-sub-path + summary: |- + Folder path inside the git repository to consider as the root of the accelerator or fragment. - name: --git-tag summary: |- Git repository tag to be used. @@ -312,6 +326,10 @@ directCommands: - name: --private-key summary: |- Private SSH Key algorithm of git repository. + - name: --type + parameterValueGroup: "Accelerator, Fragment" + summary: |- + Type of customized accelerator. - name: --username summary: |- Username of git repository basic auth. diff --git a/latest/docs-ref-autogen/spring/certificate.yml b/latest/docs-ref-autogen/spring/certificate.yml index 5ed4bdbe1d..4c6a781f4d 100644 --- a/latest/docs-ref-autogen/spring/certificate.yml +++ b/latest/docs-ref-autogen/spring/certificate.yml @@ -20,6 +20,7 @@ directCommands: az spring certificate add --name --resource-group --service + [--enable-auto-sync {false, true}] [--only-public-cert {false, true}] [--public-certificate-file] [--vault-certificate-name] @@ -42,6 +43,11 @@ directCommands: summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. optionalParameters: + - name: --enable-auto-sync + defaultValue: "False" + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. - name: --only-public-cert defaultValue: "False" parameterValueGroup: "false, true" @@ -157,12 +163,49 @@ directCommands: name: --service -s summary: |- The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. +- uid: az_spring_certificate_update(spring) + name: az spring certificate update + summary: |- + Update a certificate in Azure Spring Apps. + status: GA + sourceType: Extension + syntax: >- + az spring certificate update --name + --resource-group + --service + [--enable-auto-sync {false, true}] + examples: + - summary: |- + Enable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true + - summary: |- + Disable auto sync feature of a key vault certificate in Azure Spring Apps. + syntax: az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false + requiredParameters: + - isRequired: true + name: --name -n + summary: |- + Name of certificate. + - isRequired: true + name: --resource-group -g + summary: |- + Name of resource group. You can configure the default group using `az configure --defaults group=`. + - isRequired: true + name: --service -s + summary: |- + The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=. + optionalParameters: + - name: --enable-auto-sync + parameterValueGroup: "false, true" + summary: |- + Whether to automatically synchronize certificate from key vault. commands: - az_spring_certificate_add(spring) - az_spring_certificate_list(spring) - az_spring_certificate_list-reference-app(spring) - az_spring_certificate_remove(spring) - az_spring_certificate_show(spring) +- az_spring_certificate_update(spring) globalParameters: - name: --debug summary: |- diff --git a/latest/docs-ref-autogen/spring/connection.yml b/latest/docs-ref-autogen/spring/connection.yml index f6c6051669..176dcc3111 100644 --- a/latest/docs-ref-autogen/spring/connection.yml +++ b/latest/docs-ref-autogen/spring/connection.yml @@ -34,14 +34,16 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -51,10 +53,10 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --yes -y defaultValue: "False" summary: |- @@ -84,17 +86,19 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -124,23 +128,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_list-support-types() name: az spring connection list-support-types summary: |- @@ -186,23 +192,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_validate() name: az spring connection validate summary: |- @@ -229,23 +237,25 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - uid: az_spring_connection_wait() name: az spring connection wait summary: |- @@ -273,7 +283,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --connection summary: |- Name of the spring connection. @@ -291,7 +301,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --exists defaultValue: "False" summary: |- @@ -305,10 +317,10 @@ directCommands: Polling interval in seconds. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --timeout defaultValue: "3600" summary: |- diff --git a/latest/docs-ref-autogen/spring/connection/create.yml b/latest/docs-ref-autogen/spring/connection/create.yml index a8cb097cd1..29ca0fbf26 100644 --- a/latest/docs-ref-autogen/spring/connection/create.yml +++ b/latest/docs-ref-autogen/spring/connection/create.yml @@ -44,7 +44,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --app-config summary: |- Name of the app configuration. Required if '--target-id' is not specified. @@ -61,7 +61,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -72,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -80,7 +82,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -170,7 +172,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, none, python, springBoot" summary: |- @@ -184,17 +186,19 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -244,7 +248,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -258,7 +262,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --key-space summary: |- Name of the keyspace. Required if '--target-id' is not specified. @@ -272,7 +278,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -280,7 +286,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -363,7 +369,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -380,7 +386,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --graph summary: |- Name of the graph. Required if '--target-id' is not specified. @@ -394,7 +402,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -402,7 +410,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -484,7 +492,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -501,7 +509,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -512,7 +522,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -520,7 +530,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -602,7 +612,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -619,7 +629,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -630,7 +642,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -638,7 +650,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -720,7 +732,7 @@ directCommands: Name of the cosmos database account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -734,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -745,7 +759,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -753,7 +767,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -834,7 +848,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -848,7 +862,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -862,7 +878,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -870,7 +886,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -954,7 +970,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -968,7 +984,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -984,10 +1002,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1068,7 +1086,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1085,7 +1103,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1096,7 +1116,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1114,7 +1134,7 @@ directCommands: Name of the mysql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1167,7 +1187,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1184,14 +1204,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1209,7 +1231,7 @@ directCommands: Name of the mysql flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1276,7 +1298,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1293,7 +1315,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1309,7 +1333,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1327,7 +1351,7 @@ directCommands: Name of postgres server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1385,7 +1409,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1402,14 +1426,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1427,7 +1453,7 @@ directCommands: Name of postgres flexible server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1481,7 +1507,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1498,7 +1524,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1509,7 +1537,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1520,7 +1548,7 @@ directCommands: Name of the redis server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1568,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1585,14 +1613,16 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1603,7 +1633,7 @@ directCommands: Name of the redis enterprise server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -1655,7 +1685,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1669,7 +1699,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1683,7 +1715,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1691,7 +1723,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1768,7 +1800,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1782,7 +1814,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1793,7 +1827,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1801,7 +1835,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1877,7 +1911,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1894,7 +1928,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -1905,7 +1941,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1923,7 +1959,7 @@ directCommands: Name of the sql server. Required if '--target-id' is not specified. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1994,7 +2030,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2008,7 +2044,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2024,7 +2062,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2070,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2110,7 +2148,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -2124,7 +2162,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2135,7 +2175,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2143,7 +2183,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2202,7 +2242,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -2216,7 +2256,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2227,7 +2269,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2235,7 +2277,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2313,7 +2355,7 @@ directCommands: Name of the storage account. Required if '--target-id' is not specified. - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2327,7 +2369,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2338,7 +2382,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2346,7 +2390,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -2401,7 +2445,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2415,7 +2459,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --no-wait defaultValue: "False" summary: |- @@ -2426,7 +2472,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2434,7 +2480,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/latest/docs-ref-autogen/spring/connection/update.yml b/latest/docs-ref-autogen/spring/connection/update.yml index 66da61e2e7..1684f816cd 100644 --- a/latest/docs-ref-autogen/spring/connection/update.yml +++ b/latest/docs-ref-autogen/spring/connection/update.yml @@ -38,7 +38,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -52,7 +52,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -66,7 +68,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -74,7 +76,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -144,7 +146,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --bootstrap-server summary: |- Kafka bootstrap server url. @@ -158,7 +160,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--source-id' is not specified. + The deployment name of the app. Required if '--source-id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --kafka-key summary: |- Kafka API-Key (key). @@ -171,7 +175,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -183,7 +187,7 @@ directCommands: Schema registry API-Key (secret). - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None. - name: --source-id summary: |- The resource id of a spring. Required if ['--resource-group', '--service', '--app', '--deployment'] are not specified. @@ -223,7 +227,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -237,7 +241,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -251,7 +257,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -259,7 +265,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -322,7 +328,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python" summary: |- @@ -336,7 +342,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -350,7 +358,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -358,7 +366,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -421,7 +429,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, springBoot" summary: |- @@ -435,7 +443,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -449,7 +459,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -457,7 +467,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -520,7 +530,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -534,7 +544,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -548,7 +560,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -556,7 +568,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -619,7 +631,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -633,7 +645,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -647,7 +661,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -655,7 +669,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -718,7 +732,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, kafka-springBoot, nodejs, none, python, springBoot" summary: |- @@ -732,7 +746,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -746,7 +762,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -754,7 +770,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -816,7 +832,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -830,7 +846,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -844,10 +862,10 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -909,7 +927,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -923,7 +941,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -937,7 +957,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -952,7 +972,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -989,7 +1009,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1003,7 +1023,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1013,7 +1035,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1028,7 +1050,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1072,7 +1094,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1086,7 +1108,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1100,7 +1124,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1115,7 +1139,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1157,7 +1181,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1171,7 +1195,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1181,7 +1207,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1196,7 +1222,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1234,7 +1260,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1248,7 +1274,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1262,7 +1290,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1270,7 +1298,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1302,7 +1330,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1316,7 +1344,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1326,7 +1356,7 @@ directCommands: Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1334,7 +1364,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1371,7 +1401,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, go, java, nodejs, none, python, springBoot" summary: |- @@ -1385,7 +1415,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1399,7 +1431,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1407,7 +1439,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1469,7 +1501,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, none" summary: |- @@ -1483,7 +1515,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1497,7 +1531,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1505,7 +1539,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. @@ -1562,7 +1596,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "django, dotnet, go, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1576,7 +1610,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1590,7 +1626,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1605,7 +1641,7 @@ directCommands: secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1651,7 +1687,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1665,7 +1701,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1679,7 +1717,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1687,7 +1725,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1747,7 +1785,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, php, python, ruby, springBoot" summary: |- @@ -1761,7 +1799,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1775,7 +1815,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1783,7 +1823,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1824,7 +1864,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python, springBoot" summary: |- @@ -1838,7 +1878,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1852,7 +1894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1860,7 +1902,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1920,7 +1962,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -1934,7 +1976,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -1948,7 +1992,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1956,7 +2000,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -1996,7 +2040,7 @@ directCommands: optionalParameters: - name: --app summary: |- - Name of the app in the Azure Spring Apps. Required if '--id' is not specified. + Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --client-type parameterValueGroup: "dotnet, java, nodejs, none, python" summary: |- @@ -2010,7 +2054,9 @@ directCommands: - name: --deployment defaultValue: "default" summary: |- - The deployment name of the app. Required if '--id' is not specified. + The deployment name of the app. Required if '--id' is not specified. Note: The default value of `--deployment` is deprecated and will be removed in a future release. Use `--deployment default` if you want stay in current behavior. + isDeprecated: true + deprecateInfo: Argument 'deployment' has been deprecated and will be removed in a future release. - name: --id summary: |- The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified. @@ -2024,7 +2070,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified. + The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2032,7 +2078,7 @@ directCommands: Usage: --secret. - name: --service summary: |- - Name of the the Azure Spring Apps resource. Required if '--id' is not specified. + Name of the the Azure Spring Apps resource. Required if '--id' is not specified.None. - name: --service-principal summary: |- The service principal auth info. diff --git a/latest/docs-ref-autogen/sql/failover-group.yml b/latest/docs-ref-autogen/sql/failover-group.yml index 6a8b6d07e5..cfdee77e98 100644 --- a/latest/docs-ref-autogen/sql/failover-group.yml +++ b/latest/docs-ref-autogen/sql/failover-group.yml @@ -129,6 +129,7 @@ directCommands: [--resource-group] [--server] [--subscription] + [--tpbff] examples: - summary: |- Set the primary of the failover group by failing over all databases from the current primary server. (autogenerated) @@ -155,6 +156,10 @@ directCommands: - name: --subscription summary: |- Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + - name: --tpbff --try-planned-before-forced-failover + defaultValue: "False" + summary: |- + Performs a planned failover as the first step, and if it fails for any reason, then initiates a forced failover with potential data loss. This will allow the failover to proceed even if a primary database is unavailable. - uid: az_sql_failover-group_show() name: az sql failover-group show summary: |- diff --git a/latest/docs-ref-autogen/storage/blob/copy.yml b/latest/docs-ref-autogen/storage/blob/copy.yml index dcf7dc0b3e..35fec9c04c 100644 --- a/latest/docs-ref-autogen/storage/blob/copy.yml +++ b/latest/docs-ref-autogen/storage/blob/copy.yml @@ -423,6 +423,7 @@ directCommands: [--destination-path] [--dryrun] [--pattern] + [--rehydrate-priority] [--sas-token] [--source-account-key] [--source-account-name] @@ -471,6 +472,9 @@ directCommands: The pattern used for globbing files or blobs in the source. The supported patterns are '*', '?', '[seq]', and '[!seq]'. For more information, please refer to https://docs.python.org/3.7/library/fnmatch.html. description: |- When you use '*' in --pattern, it will match any character including the the directory separator '/'. + - name: --rehydrate-priority -r + summary: |- + Indicate the priority with which to rehydrate an archived blob. - name: --sas-token summary: |- A Shared Access Signature (SAS). Must be used in conjunction with storage account name or service endpoint. Environment variable: AZURE_STORAGE_SAS_TOKEN. diff --git a/latest/docs-ref-autogen/storage/blob/directory.yml b/latest/docs-ref-autogen/storage/blob/directory.yml index fd2d12feca..7ea3e81023 100644 --- a/latest/docs-ref-autogen/storage/blob/directory.yml +++ b/latest/docs-ref-autogen/storage/blob/directory.yml @@ -573,7 +573,7 @@ directCommands: - isRequired: true name: --destination-path -d summary: |- - The upload destination directory path. It should be an absolute path to container. If the specified destination path does not exist, a new directory path will be created. + The destination path that will be prepended to the blob name. - isRequired: true name: --source -s summary: |- diff --git a/latest/docs-ref-autogen/tag.yml b/latest/docs-ref-autogen/tag.yml index 9046a9a4ec..7bb812cc8f 100644 --- a/latest/docs-ref-autogen/tag.yml +++ b/latest/docs-ref-autogen/tag.yml @@ -216,5 +216,5 @@ globalParameters: summary: |- Increase logging verbosity. Use --debug for full debug logs. metadata: - ms.date: 08/30/2023 + ms.date: 09/13/2023 description: Tag Management on a resource. diff --git a/latest/docs-ref-autogen/webapp.yml b/latest/docs-ref-autogen/webapp.yml index 839c4b700d..f494bb2847 100644 --- a/latest/docs-ref-autogen/webapp.yml +++ b/latest/docs-ref-autogen/webapp.yml @@ -393,9 +393,7 @@ directCommands: name: az webapp deploy summary: |- Deploys a provided artifact to Azure Web Apps. - status: Preview - isPreview: true - previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus' + status: GA sourceType: Core syntax: >- az webapp deploy [--async {false, true}] diff --git a/latest/docs-ref-autogen/webapp/connection.yml b/latest/docs-ref-autogen/webapp/connection.yml index 5cb6b4634d..3768e89313 100644 --- a/latest/docs-ref-autogen/webapp/connection.yml +++ b/latest/docs-ref-autogen/webapp/connection.yml @@ -22,6 +22,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--yes] examples: - summary: |- @@ -42,14 +43,17 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --yes -y defaultValue: "False" summary: |- @@ -63,6 +67,7 @@ directCommands: syntax: >- az webapp connection list [--name] [--resource-group] + [--slot] [--source-id] examples: - summary: |- @@ -77,10 +82,13 @@ directCommands: optionalParameters: - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -95,6 +103,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- List a connection's source configurations interactively @@ -114,10 +123,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_list-support-types() name: az webapp connection list-support-types summary: |- @@ -148,6 +160,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Get a connection interactively @@ -167,10 +180,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_validate() name: az webapp connection validate summary: |- @@ -182,6 +198,7 @@ directCommands: [--id] [--name] [--resource-group] + [--slot] examples: - summary: |- Validate a connection interactively @@ -201,10 +218,13 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - uid: az_webapp_connection_wait() name: az webapp connection wait summary: |- @@ -221,6 +241,7 @@ directCommands: [--interval] [--name] [--resource-group] + [--slot] [--timeout] [--updated] examples: @@ -255,10 +276,13 @@ directCommands: Polling interval in seconds. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --timeout defaultValue: "3600" summary: |- diff --git a/latest/docs-ref-autogen/webapp/connection/create.yml b/latest/docs-ref-autogen/webapp/connection/create.yml index abe31f256d..58170d03b6 100644 --- a/latest/docs-ref-autogen/webapp/connection/create.yml +++ b/latest/docs-ref-autogen/webapp/connection/create.yml @@ -27,6 +27,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -40,6 +41,9 @@ directCommands: - summary: |- Create a connection between webapp and appconfig with resource name syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --tg AppconfigRG --app-config MyConfigStore --system-identity + - summary: |- + Create a connection between webapp slot and appconfig with resource name + syntax: az webapp connection create appconfig -g WebAppRG -n MyWebApp --slot MySlot --tg AppconfigRG --app-config MyConfigStore --system-identity - summary: |- Create a connection between webapp and appconfig with resource id syntax: az webapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity @@ -59,7 +63,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -70,7 +74,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -85,6 +89,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -129,6 +136,7 @@ directCommands: [--name] [--no-wait] [--resource-group] + [--slot] [--source-id] [--vault-id] examples: @@ -173,14 +181,17 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -206,6 +217,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -219,6 +231,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-cassandra with resource name syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-cassandra with resource name + syntax: az webapp connection create cosmos-cassandra -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity - summary: |- Create a connection between webapp and cosmos-cassandra with resource id syntax: az webapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity @@ -241,7 +256,7 @@ directCommands: Name of the keyspace. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -252,7 +267,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -271,6 +286,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -316,6 +334,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -329,6 +348,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-gremlin with resource name syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-gremlin with resource name + syntax: az webapp connection create cosmos-gremlin -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity - summary: |- Create a connection between webapp and cosmos-gremlin with resource id syntax: az webapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity @@ -354,7 +376,7 @@ directCommands: Name of the graph. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -365,7 +387,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -384,6 +406,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -428,6 +453,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -441,6 +467,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-mongo with resource name syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-mongo with resource name + syntax: az webapp connection create cosmos-mongo -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-mongo with resource id syntax: az webapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity @@ -463,7 +492,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -474,7 +503,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -493,6 +522,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -537,6 +569,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -550,6 +583,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-sql with resource name syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --database MyDB --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-sql with resource name + syntax: az webapp connection create cosmos-sql -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --database MyDB --system-identity - summary: |- Create a connection between webapp and cosmos-sql with resource id syntax: az webapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity @@ -572,7 +608,7 @@ directCommands: Name of the database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -583,7 +619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -602,6 +638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -645,6 +684,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--table] @@ -659,6 +699,9 @@ directCommands: - summary: |- Create a connection between webapp and cosmos-table with resource name syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --tg CosmosRG --account MyAccount --table MyTable --system-identity + - summary: |- + Create a connection between webapp slot and cosmos-table with resource name + syntax: az webapp connection create cosmos-table -g WebAppRG -n MyWebApp --slot MySlot --tg CosmosRG --account MyAccount --table MyTable --system-identity - summary: |- Create a connection between webapp and cosmos-table with resource id syntax: az webapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity @@ -678,7 +721,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -689,7 +732,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -708,6 +751,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -754,6 +800,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -767,6 +814,9 @@ directCommands: - summary: |- Create a connection between webapp and eventhub with resource name syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --tg EventhubRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and eventhub with resource name + syntax: az webapp connection create eventhub -g WebAppRG -n MyWebApp --slot MySlot --tg EventhubRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and eventhub with resource id syntax: az webapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity @@ -783,7 +833,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the eventhub namespace. Required if '--target-id' is not specified. @@ -797,7 +847,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -816,6 +866,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -858,6 +911,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -872,6 +926,9 @@ directCommands: - summary: |- Create a connection between webapp and keyvault with resource name syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --tg KeyvaultRG --vault MyVault --system-identity + - summary: |- + Create a connection between webapp slot and keyvault with resource name + syntax: az webapp connection create keyvault -g WebAppRG -n MyWebApp --slot MySlot --tg KeyvaultRG --vault MyVault --system-identity - summary: |- Create a connection between webapp and keyvault with resource id syntax: az webapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity @@ -894,7 +951,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -910,7 +967,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -924,6 +981,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -973,6 +1033,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -984,6 +1045,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql with resource name syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql with resource name + syntax: az webapp connection create mysql -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql with resource id syntax: az webapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1009,7 +1073,7 @@ directCommands: Name of the mysql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1020,7 +1084,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1040,6 +1104,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1069,6 +1136,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1081,6 +1149,9 @@ directCommands: - summary: |- Create a connection between webapp and mysql-flexible with resource name syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and mysql-flexible with resource name + syntax: az webapp connection create mysql-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and mysql-flexible with resource id syntax: az webapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1106,14 +1177,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1129,6 +1200,9 @@ directCommands: - name: --server summary: |- Name of the mysql flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1206,14 +1280,14 @@ directCommands: Name of the mysql flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1293,6 +1367,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1305,6 +1380,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres with resource name syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres with resource name + syntax: az webapp connection create postgres -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres with resource id syntax: az webapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -1336,7 +1414,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1352,7 +1430,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1372,6 +1450,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1456,7 +1537,7 @@ directCommands: Name of postgres database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -1472,7 +1553,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1547,6 +1628,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1559,6 +1641,9 @@ directCommands: - summary: |- Create a connection between webapp and postgres-flexible with resource name syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and postgres-flexible with resource name + syntax: az webapp connection create postgres-flexible -g WebAppRG -n MyWebApp --slot MySlot --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and postgres-flexible with resource id syntax: az webapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX @@ -1584,14 +1669,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1607,6 +1692,9 @@ directCommands: - name: --server summary: |- Name of postgres flexible server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1682,14 +1770,14 @@ directCommands: Name of postgres flexible database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1760,6 +1848,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1771,6 +1860,9 @@ directCommands: - summary: |- Create a connection between webapp and redis with resource name syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis with resource name + syntax: az webapp connection create redis -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis with resource id syntax: az webapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret @@ -1790,7 +1882,7 @@ directCommands: Name of the redis database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1801,7 +1893,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1810,6 +1902,9 @@ directCommands: - name: --server summary: |- Name of the redis server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1838,6 +1933,7 @@ directCommands: [--resource-group] [--secret] [--server] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -1849,6 +1945,9 @@ directCommands: - summary: |- Create a connection between webapp and redis-enterprise with resource name syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --tg RedisRG --server MyServer --database MyDB --secret + - summary: |- + Create a connection between webapp slot and redis-enterprise with resource name + syntax: az webapp connection create redis-enterprise -g WebAppRG -n MyWebApp --slot MySlot --tg RedisRG --server MyServer --database MyDB --secret - summary: |- Create a connection between webapp and redis-enterprise with resource id syntax: az webapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret @@ -1868,14 +1967,14 @@ directCommands: Name of the redis enterprise database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1884,6 +1983,9 @@ directCommands: - name: --server summary: |- Name of the redis enterprise server. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -1914,6 +2016,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -1927,6 +2030,9 @@ directCommands: - summary: |- Create a connection between webapp and servicebus with resource name syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --tg ServicebusRG --namespace MyNamespace --system-identity + - summary: |- + Create a connection between webapp slot and servicebus with resource name + syntax: az webapp connection create servicebus -g WebAppRG -n MyWebApp --slot MySlot --tg ServicebusRG --namespace MyNamespace --system-identity - summary: |- Create a connection between webapp and servicebus with resource id syntax: az webapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity @@ -1943,7 +2049,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --namespace summary: |- Name of the servicebus namespace. Required if '--target-id' is not specified. @@ -1957,7 +2063,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1976,6 +2082,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2018,6 +2127,7 @@ directCommands: [--secret] [--service-principal] [--signalr] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2031,6 +2141,9 @@ directCommands: - summary: |- Create a connection between webapp and signalr with resource name syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --tg SignalrRG --signalr MySignalR --system-identity + - summary: |- + Create a connection between webapp slot and signalr with resource name + syntax: az webapp connection create signalr -g WebAppRG -n MyWebApp --slot MySlot --tg SignalrRG --signalr MySignalR --system-identity - summary: |- Create a connection between webapp and signalr with resource id syntax: az webapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity @@ -2047,7 +2160,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2058,7 +2171,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2076,6 +2189,9 @@ directCommands: - name: --signalr summary: |- Name of the signalr service. Required if '--target-id' is not specified. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2120,6 +2236,7 @@ directCommands: [--secret] [--server] [--service-endpoint {false, true}] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2132,6 +2249,9 @@ directCommands: - summary: |- Create a connection between webapp and sql with resource name syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX + - summary: |- + Create a connection between webapp slot and sql with resource name + syntax: az webapp connection create sql -g WebAppRG -n MyWebApp --slot MySlot --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX - summary: |- Create a connection between webapp and sql with resource id syntax: az webapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX @@ -2157,7 +2277,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2168,7 +2288,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2188,6 +2308,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2265,7 +2388,7 @@ directCommands: Name of the sql database. Required if '--target-id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2276,7 +2399,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2353,6 +2476,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2366,6 +2490,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-blob with resource name syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-blob with resource name + syntax: az webapp connection create storage-blob -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-blob with resource id syntax: az webapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity @@ -2391,7 +2518,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --new defaultValue: "False" parameterValueGroup: "false, true" @@ -2407,7 +2534,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2426,6 +2553,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2468,6 +2598,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2479,6 +2610,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-file with resource name syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-file with resource name + syntax: az webapp connection create storage-file -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-file with resource id syntax: az webapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret @@ -2498,7 +2632,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2509,7 +2643,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2519,6 +2653,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2549,6 +2686,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2562,6 +2700,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-queue with resource name syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --system-identity + - summary: |- + Create a connection between webapp slot and storage-queue with resource name + syntax: az webapp connection create storage-queue -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --system-identity - summary: |- Create a connection between webapp and storage-queue with resource id syntax: az webapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity @@ -2581,7 +2722,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2592,7 +2733,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2611,6 +2752,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2653,6 +2797,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--source-id] [--target-id] [--target-resource-group] @@ -2664,6 +2809,9 @@ directCommands: - summary: |- Create a connection between webapp and storage-table with resource name syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --tg StorageRG --account MyAccount --secret + - summary: |- + Create a connection between webapp slot and storage-table with resource name + syntax: az webapp connection create storage-table -g WebAppRG -n MyWebApp --slot MySlot --tg StorageRG --account MyAccount --secret - summary: |- Create a connection between webapp and storage-table with resource id syntax: az webapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret @@ -2683,7 +2831,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2694,7 +2842,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2704,6 +2852,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -2732,6 +2883,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--source-id] [--system-identity] [--target-id] @@ -2746,6 +2898,9 @@ directCommands: - summary: |- Create a connection between webapp and webpubsub with resource name syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity + - summary: |- + Create a connection between webapp slot and webpubsub with resource name + syntax: az webapp connection create webpubsub -g WebAppRG -n MyWebApp --slot MySlot --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity - summary: |- Create a connection between webapp and webpubsub with resource id syntax: az webapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity @@ -2762,7 +2917,7 @@ directCommands: The customized keys used to change default configuration names. Key is the original name, value is the customized name. - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -2773,7 +2928,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -2788,6 +2943,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. diff --git a/latest/docs-ref-autogen/webapp/connection/update.yml b/latest/docs-ref-autogen/webapp/connection/update.yml index 5e3a0a9a07..5c31692daf 100644 --- a/latest/docs-ref-autogen/webapp/connection/update.yml +++ b/latest/docs-ref-autogen/webapp/connection/update.yml @@ -23,6 +23,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -49,7 +50,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -60,7 +61,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -75,6 +76,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -110,6 +114,7 @@ directCommands: [--schema-key] [--schema-registry] [--schema-secret] + [--slot] [--source-id] [--vault-id] examples: @@ -149,14 +154,14 @@ directCommands: Kafka API-Key (secret). - name: --name -n summary: |- - Name of the webapp. Required if '--source-id' is not specified. + Name of the webapp. Required if '--source-id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--source-id' is not specified. + The resource group which contains the webapp. Required if '--source-id' is not specified.None. - name: --schema-key summary: |- Schema registry API-Key (key). @@ -166,6 +171,9 @@ directCommands: - name: --schema-secret summary: |- Schema registry API-Key (secret). + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --source-id summary: |- The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified. @@ -190,6 +198,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -216,7 +225,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -227,7 +236,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -246,6 +255,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -280,6 +292,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -306,7 +319,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -317,7 +330,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -336,6 +349,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -370,6 +386,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -396,7 +413,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -407,7 +424,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -426,6 +443,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -460,6 +480,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -486,7 +507,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -497,7 +518,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -516,6 +537,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -550,6 +574,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -576,7 +601,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -587,7 +612,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -606,6 +631,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -640,6 +668,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -666,7 +695,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -677,7 +706,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -696,6 +725,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -729,6 +761,7 @@ directCommands: [--resource-group] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -755,7 +788,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -766,7 +799,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --service-endpoint parameterValueGroup: "false, true" summary: |- @@ -780,6 +813,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -816,6 +852,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -846,7 +883,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -857,7 +894,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -874,6 +911,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -893,6 +933,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -924,14 +965,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -944,6 +985,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -974,6 +1018,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1005,7 +1050,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1016,7 +1061,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1033,6 +1078,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1057,6 +1105,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--system-identity] [--vault-id] examples: @@ -1088,14 +1137,14 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1108,6 +1157,9 @@ directCommands: secret : One of is required. Password or account key for secret auth. secret-uri : One of is required. Keyvault secret uri which stores password. secret-name : One of is required. Keyvault secret name which stores password. It's for AKS only. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1132,6 +1184,7 @@ directCommands: [--private-endpoint {false, true}] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1156,7 +1209,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1167,12 +1220,15 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1191,6 +1247,7 @@ directCommands: [--no-wait] [--resource-group] [--secret] + [--slot] [--vault-id] examples: - summary: |- @@ -1215,19 +1272,22 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- Do not wait for the long-running operation to finish. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. description: |- Usage: --secret. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1249,6 +1309,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1275,7 +1336,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1286,7 +1347,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1305,6 +1366,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1338,6 +1402,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1364,7 +1429,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1375,7 +1440,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1390,6 +1455,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1424,6 +1492,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--system-identity] [--vault-id] examples: @@ -1455,7 +1524,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1466,7 +1535,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1483,6 +1552,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1509,6 +1581,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1535,7 +1608,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1546,7 +1619,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1565,6 +1638,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1598,6 +1674,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1622,7 +1699,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1633,7 +1710,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1643,6 +1720,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1664,6 +1744,7 @@ directCommands: [--secret] [--service-endpoint {false, true}] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1690,7 +1771,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1701,7 +1782,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1720,6 +1801,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info. @@ -1753,6 +1837,7 @@ directCommands: [--resource-group] [--secret] [--service-endpoint {false, true}] + [--slot] [--vault-id] examples: - summary: |- @@ -1777,7 +1862,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1788,7 +1873,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1798,6 +1883,9 @@ directCommands: parameterValueGroup: "false, true" summary: |- Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --vault-id summary: |- The id of key vault to store secret value. @@ -1818,6 +1906,7 @@ directCommands: [--resource-group] [--secret] [--service-principal] + [--slot] [--system-identity] [--user-identity] [--vault-id] @@ -1844,7 +1933,7 @@ directCommands: The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified. - name: --name -n summary: |- - Name of the webapp. Required if '--id' is not specified. + Name of the webapp. Required if '--id' is not specified.None. - name: --no-wait defaultValue: "False" summary: |- @@ -1855,7 +1944,7 @@ directCommands: Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead. - name: --resource-group -g summary: |- - The resource group which contains the webapp. Required if '--id' is not specified. + The resource group which contains the webapp. Required if '--id' is not specified.None. - name: --secret summary: |- The secret auth info. @@ -1870,6 +1959,9 @@ directCommands: client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal. + - name: --slot + summary: |- + The name of the slot. Default to the production slot if not specified. - name: --system-identity summary: |- The system assigned identity auth info.