diff --git a/2017-03-09-profile/docs-ref-autogen/acr.yml b/2017-03-09-profile/docs-ref-autogen/acr.yml index b2bf406be7..a248fa3f35 100644 --- a/2017-03-09-profile/docs-ref-autogen/acr.yml +++ b/2017-03-09-profile/docs-ref-autogen/acr.yml @@ -36,7 +36,7 @@ directCommands: summary: The name of the container registry that the query is run against. description: '' optionalParameters: - - name: --password + - name: --password -p summary: Registry password. description: '' - name: --repository @@ -45,7 +45,7 @@ directCommands: - name: --skip-token summary: Skip token to get the next page of the query if applicable. description: '' - - name: --username + - name: --username -u summary: Registry username. description: '' commands: diff --git a/2017-03-09-profile/docs-ref-autogen/ad/ds.yml b/2017-03-09-profile/docs-ref-autogen/ad/ds.yml index 15ed62586d..551b1b7a0d 100644 --- a/2017-03-09-profile/docs-ref-autogen/ad/ds.yml +++ b/2017-03-09-profile/docs-ref-autogen/ad/ds.yml @@ -167,7 +167,6 @@ directCommands: [--name] [--no-wait] [--resource-group] - [--subscription] [--yes] examples: - summary: Delete Domain Service @@ -186,9 +185,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -215,7 +211,6 @@ directCommands: az ad ds show [--ids] [--name] [--resource-group] - [--subscription] examples: - summary: Get Domain Service syntax: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup" @@ -229,9 +224,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - uid: az_ad_ds_update name: az ad ds update summary: Update the existing deployment properties for domain service. @@ -255,7 +247,6 @@ directCommands: [--resource-group] [--settings] [--sku {Enterprise, Premium, Standard}] - [--subscription] [--sync-kerberos-pwd {Disabled, Enabled}] [--sync-ntlm-pwd {Disabled, Enabled}] [--sync-on-prem-pwd {Disabled, Enabled}] @@ -356,9 +347,6 @@ directCommands: parameterValueGroup: "Enterprise, Premium, Standard" summary: Sku Type. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --sync-kerberos-pwd parameterValueGroup: "Disabled, Enabled" summary: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. @@ -391,7 +379,6 @@ directCommands: [--interval] [--name] [--resource-group] - [--subscription] [--timeout] [--updated] examples: @@ -430,9 +417,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --timeout defaultValue: "3600" summary: Maximum wait in seconds. diff --git a/2017-03-09-profile/docs-ref-autogen/aks.yml b/2017-03-09-profile/docs-ref-autogen/aks.yml index ca3c7a16ca..91bc58fb06 100644 --- a/2017-03-09-profile/docs-ref-autogen/aks.yml +++ b/2017-03-09-profile/docs-ref-autogen/aks.yml @@ -804,7 +804,7 @@ directCommands: 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. description: '' - name: --vm-set-type - summary: Agent pool vm set type. VirtualMachineScaleSets or AvailabilitySet. + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. @@ -1476,6 +1476,7 @@ directCommands: [--min-count] [--nat-gateway-idle-timeout] [--nat-gateway-managed-outbound-ip-count] + [--network-dataplane {azure, cilium}] [--network-plugin-mode] [--no-wait] [--node-os-upgrade-channel {NodeImage, None, SecurityPatch, Unmanaged}] @@ -1891,6 +1892,13 @@ directCommands: - name: --nat-gateway-managed-outbound-ip-count summary: NAT gateway managed outbound IP count. description: Desired number of managed outbound IPs for NAT gateway outbound connection. Please specify a value in the range of [1, 16]. Valid for Standard SKU load balancer cluster with managedNATGateway outbound type only. + - name: --network-dataplane + parameterValueGroup: "azure, cilium" + summary: The network dataplane to use. + description: >- + Network dataplane used in the Kubernetes cluster. + + Specify "azure" to use the Azure dataplane (default) or "cilium" to enable Cilium dataplane. - name: --network-plugin-mode summary: The network plugin mode to use. description: >- diff --git a/2017-03-09-profile/docs-ref-autogen/aks/nodepool.yml b/2017-03-09-profile/docs-ref-autogen/aks/nodepool.yml index 5e8fe4ae9e..f2d343520c 100644 --- a/2017-03-09-profile/docs-ref-autogen/aks/nodepool.yml +++ b/2017-03-09-profile/docs-ref-autogen/aks/nodepool.yml @@ -57,6 +57,7 @@ directCommands: [--snapshot-id] [--spot-max-price] [--tags] + [--vm-set-type] [--vnet-subnet-id] [--workload-runtime {KataMshvVmIsolation, OCIContainer, WasmWasi}] [--zones {1, 2, 3}] @@ -236,6 +237,9 @@ directCommands: - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' + - name: --vm-set-type + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). + description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. description: '' diff --git a/2017-03-09-profile/docs-ref-autogen/databox/job.yml b/2017-03-09-profile/docs-ref-autogen/databox/job.yml index 132986a36d..f2b2248809 100644 --- a/2017-03-09-profile/docs-ref-autogen/databox/job.yml +++ b/2017-03-09-profile/docs-ref-autogen/databox/job.yml @@ -78,6 +78,8 @@ directCommands: [--street-address2] [--street-address3] [--tags] + [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}] + [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}] [--transfer-configuration-type {TransferAll, TransferUsingFilter}] [--transfer-filter-details] examples: @@ -181,6 +183,16 @@ directCommands: - name: --tags summary: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. description: '' + - name: --transfer-all-blobs + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure blobs have to be transferred. + description: '' + - name: --transfer-all-files + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure files have to be transferred. + description: '' - name: --transfer-configuration-type parameterValueGroup: "TransferAll, TransferUsingFilter" summary: Type of the configuration for transfer. diff --git a/2017-03-09-profile/docs-ref-autogen/devcenter/admin/devbox-definition.yml b/2017-03-09-profile/docs-ref-autogen/devcenter/admin/devbox-definition.yml index 083c1c27bf..30bea04755 100644 --- a/2017-03-09-profile/docs-ref-autogen/devcenter/admin/devbox-definition.yml +++ b/2017-03-09-profile/docs-ref-autogen/devcenter/admin/devbox-definition.yml @@ -13,8 +13,8 @@ directCommands: summary: Create a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition create --dev-box-definition-name - --dev-center + az devcenter admin devbox-definition create --dev-center + --devbox-definition-name --image-reference --os-storage-type --resource-group @@ -27,14 +27,14 @@ directCommands: - summary: Create syntax: az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" requiredParameters: - - isRequired: true - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - isRequired: true name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - isRequired: true + name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - isRequired: true name: --image-reference summary: Image reference information. Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. @@ -71,8 +71,8 @@ directCommands: summary: Delete a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition delete [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition delete [--dev-center] + [--devbox-definition-name] [--ids] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] @@ -82,12 +82,12 @@ directCommands: - summary: Delete syntax: az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. description: '' @@ -135,8 +135,8 @@ directCommands: summary: Get a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition show [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition show [--dev-center] + [--devbox-definition-name] [--ids] [--project] [--resource-group] @@ -147,12 +147,12 @@ directCommands: - summary: Get project dev box definition syntax: az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the Dev Box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the Dev Box definition. + description: '' - 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. description: '' @@ -171,8 +171,8 @@ directCommands: description: '' syntax: >- az devcenter admin devbox-definition update [--add] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--hibernate-support {Disabled, Enabled}] [--ids] @@ -192,12 +192,12 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. @@ -245,8 +245,8 @@ directCommands: az devcenter admin devbox-definition wait [--created] [--custom] [--deleted] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--exists] [--ids] [--interval] @@ -266,12 +266,12 @@ directCommands: defaultValue: "False" summary: Wait until deleted. description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - name: --exists defaultValue: "False" summary: Wait until the resource exists. diff --git a/2017-03-09-profile/docs-ref-autogen/devcenter/admin/pool.yml b/2017-03-09-profile/docs-ref-autogen/devcenter/admin/pool.yml index 1e5cfe0aed..729ba8be09 100644 --- a/2017-03-09-profile/docs-ref-autogen/devcenter/admin/pool.yml +++ b/2017-03-09-profile/docs-ref-autogen/devcenter/admin/pool.yml @@ -13,7 +13,7 @@ directCommands: summary: Create a pool. description: '' syntax: >- - az devcenter admin pool create --dev-box-definition-name + az devcenter admin pool create --devbox-definition-name --local-administrator {Disabled, Enabled} --name --network-connection-name @@ -27,7 +27,7 @@ directCommands: syntax: az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" requiredParameters: - isRequired: true - name: --dev-box-definition-name -d + name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - isRequired: true @@ -155,7 +155,7 @@ directCommands: description: '' syntax: >- az devcenter admin pool update [--add] - [--dev-box-definition-name] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--local-administrator {Disabled, Enabled}] @@ -175,7 +175,7 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name -d + - name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - name: --force-string diff --git a/2017-03-09-profile/docs-ref-autogen/iot/hub/certificate/root-authority.yml b/2017-03-09-profile/docs-ref-autogen/iot/hub/certificate/root-authority.yml index ca76da049b..7177bda441 100644 --- a/2017-03-09-profile/docs-ref-autogen/iot/hub/certificate/root-authority.yml +++ b/2017-03-09-profile/docs-ref-autogen/iot/hub/certificate/root-authority.yml @@ -29,7 +29,7 @@ directCommands: summary: Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA. description: '' - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: @@ -53,7 +53,7 @@ directCommands: syntax: az iot hub certificate root-authority show --hub-name {iothub_name} requiredParameters: - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: diff --git a/2017-03-09-profile/docs-ref-autogen/mysql.yml b/2017-03-09-profile/docs-ref-autogen/mysql.yml index dce46b92e6..afdf9ab880 100644 --- a/2017-03-09-profile/docs-ref-autogen/mysql.yml +++ b/2017-03-09-profile/docs-ref-autogen/mysql.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az mysql down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az mysql show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_mysql_up name: az mysql up summary: Set up an Azure Database for MySQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/2017-03-09-profile/docs-ref-autogen/postgres.yml b/2017-03-09-profile/docs-ref-autogen/postgres.yml index df119f58d8..948bf54b44 100644 --- a/2017-03-09-profile/docs-ref-autogen/postgres.yml +++ b/2017-03-09-profile/docs-ref-autogen/postgres.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az postgres down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az postgres show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_postgres_up name: az postgres up summary: Set up an Azure Database for PostgreSQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' 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 97329dee25..b83a2d182e 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 @@ -13,19 +13,21 @@ directCommands: summary: List Azure Arc enabled PostgreSQL server endpoints. description: '' syntax: >- - az postgres server-arc endpoint list [--k8s-namespace] - [--name] + az postgres server-arc endpoint list --name + [--k8s-namespace] [--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. + description: '' 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. description: '' - - name: --name -n - summary: Name of the Azure Arc enabled PostgreSQL server. - description: '' - name: --use-k8s summary: Use local Kubernetes APIs to perform this action. description: '' diff --git a/2017-03-09-profile/docs-ref-autogen/sql/instance-failover-group-arc.yml b/2017-03-09-profile/docs-ref-autogen/sql/instance-failover-group-arc.yml index 099cfa981b..b359c7f9e3 100644 --- a/2017-03-09-profile/docs-ref-autogen/sql/instance-failover-group-arc.yml +++ b/2017-03-09-profile/docs-ref-autogen/sql/instance-failover-group-arc.yml @@ -22,6 +22,7 @@ directCommands: [--partner-mirroring-url] [--partner-resource-group] [--partner-sync-mode {async, sync}] + [--primary-mirroring-url] [--resource-group] [--role {primary, secondary}] [--shared-name] @@ -30,7 +31,9 @@ directCommands: - summary: Use the Kubernetes API to create a failover group resource between primary SQL managed instance sqlmi1 and partner SQL managed instance sqlmi2.The partner mirroring endpoint and cert file are required. syntax: az sql instance-failover-group-arc create --name fogcr --shared-name sharedname1 --mi sqlmi1 --role primary --partner-mi sqlmi2 --partner-mirroring-url 10.20.5.20:970 --partner-mirroring-cert-file ./sqlmi2.cer --use-k8s - summary: Use Azure Resource Manager (ARM) to create a failover group resource. - syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --role primary + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async + - summary: Use ARM to create a failover group with custom mirroring URLs. + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --primary-mirroring-url 21.10.6.30:6603 --partner-mirroring-url 10.20.5.20:970 requiredParameters: - isRequired: true name: --mi @@ -65,6 +68,9 @@ directCommands: parameterValueGroup: "async, sync" summary: The partner synchronization mode of the Arc-enabled SQL managed instance. description: '' + - name: --primary-mirroring-url + summary: The mirroring endpoint URL of the primary SQL managed instance. + description: '' - name: --resource-group -g summary: The Azure resource group of the primary Arc-enabled SQL managed instance. description: '' diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover.yml index 45d3a5d4bf..fc5910f2a0 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover.yml @@ -4,7 +4,7 @@ name: az storage-mover extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage top-level Storage Mover resource. description: '' directCommands: @@ -79,11 +79,20 @@ directCommands: name: az storage-mover list summary: Lists all Storage Movers in a subscription. description: '' - syntax: az storage-mover list [--resource-group] + syntax: >- + az storage-mover list [--max-items] + [--next-token] + [--resource-group] examples: - summary: storage-mover list syntax: az storage-mover list -g {rg} 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' @@ -114,31 +123,48 @@ directCommands: description: '' - uid: az_storage-mover_update name: az storage-mover update - summary: Update properties for a Storage Mover resource. Properties not specified in the request body will be unchanged. + summary: Update a top-level Storage Mover resource. description: '' syntax: >- - az storage-mover update [--description] + az storage-mover update [--add] + [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--name] + [--remove] [--resource-group] + [--set] [--subscription] [--tags] examples: - summary: storage-mover update syntax: az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --description summary: A description for the Storage Mover. description: '' + - 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. + description: '' - 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. description: '' - name: --name --storage-mover-name -n summary: The name of the Storage Mover resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --subscription summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. description: '' @@ -212,12 +238,16 @@ commands: - az_storage-mover_delete - az_storage-mover_endpoint - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait - az_storage-mover_job-definition - az_storage-mover_job-definition_create diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover/agent.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover/agent.yml index 008b2ef905..c4e14d37f3 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover/agent.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover/agent.yml @@ -4,7 +4,7 @@ name: az storage-mover agent extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Agent resource, which references a hybrid compute machine that can run jobs. description: '' directCommands: @@ -15,6 +15,8 @@ directCommands: syntax: >- az storage-mover agent list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: agent list syntax: az storage-mover agent list -g {rg} --storage-mover-name {mover_name} @@ -27,6 +29,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_agent_show name: az storage-mover agent show summary: Gets an Agent resource. @@ -97,7 +106,7 @@ directCommands: description: '' - uid: az_storage-mover_agent_update name: az storage-mover agent update - summary: Updates an Agent resource, which references a hybrid compute machine that can run jobs. + summary: Update an Agent resource, which references a hybrid compute machine that can run jobs. description: '' syntax: >- az storage-mover agent update [--add] diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover/endpoint.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover/endpoint.yml index 3abfbc5e5e..138ad149cd 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover/endpoint.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover/endpoint.yml @@ -4,7 +4,7 @@ name: az storage-mover endpoint extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Endpoint resource, which represents a data transfer source or destination. description: '' directCommands: @@ -13,21 +13,17 @@ directCommands: summary: Creates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint create-for-nfs --description - --endpoint-name + az storage-mover endpoint create-for-nfs --endpoint-name --export --host --resource-group --storage-mover-name + [--description] [--nfs-version {NFSauto, NFSv3, NFSv4}] examples: - summary: endpoint create-for-nfs - syntax: az storage-mover endpoint create-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDesc --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip" requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -49,37 +45,122 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - name: --nfs-version parameterValueGroup: "NFSauto, NFSv3, NFSv4" summary: The NFS protocol version. description: '' +- uid: az_storage-mover_endpoint_create-for-smb + name: az storage-mover endpoint create-for-smb + summary: Creates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint create-for-smb --endpoint-name + --host + --resource-group + --share-name + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint create-for-smb + syntax: az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip" + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --host + summary: The host name or IP address of the server exporting the file system. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --share-name + summary: The name of the SMB share being exported from the server. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. + description: '' - uid: az_storage-mover_endpoint_create-for-storage-container name: az storage-mover endpoint create-for-storage-container summary: Creates an Endpoint resource for storage blob container. description: '' syntax: >- az storage-mover endpoint create-for-storage-container --container-name - --description --endpoint-name --resource-group --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint create-for-storage-container - syntax: az storage-mover endpoint create-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --container-name {container_name} --storage-account-id {account_id} --description endpointDesc + syntax: az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc requiredParameters: - isRequired: true name: --container-name summary: The name of the Storage blob container that is the target destination. description: '' - isRequired: true - name: --description + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --storage-account-id + summary: The Azure Resource ID of the storage account that is the target destination. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_create-for-storage-smb-file-share + name: az storage-mover endpoint create-for-storage-smb-file-share + summary: Creates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name + --file-share-name + --resource-group + --storage-account-id + --storage-mover-name + [--description] + examples: + - summary: endpoint create-for-storage-smb-file-share + syntax: az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' + - isRequired: true + name: --file-share-name + summary: The name of the Azure Storage file share. + description: '' - isRequired: true name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -92,6 +173,10 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_delete name: az storage-mover endpoint delete summary: Deletes an Endpoint resource. @@ -138,6 +223,8 @@ directCommands: syntax: >- az storage-mover endpoint list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: endpoint list syntax: az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name} @@ -150,6 +237,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_endpoint_show name: az storage-mover endpoint show summary: Gets an Endpoint resource. @@ -184,32 +278,48 @@ directCommands: summary: Updates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint update-for-nfs --description - --endpoint-name - --export - --host + az storage-mover endpoint update-for-nfs --endpoint-name --resource-group --storage-mover-name - [--nfs-version {NFSauto, NFSv3, NFSv4}] + [--description] examples: - summary: endpoint update-for-nfs - syntax: az storage-mover endpoint update-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDescUpdate --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' - isRequired: true - name: --export - summary: The directory being exported from the server. + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --host - summary: The host name or IP address of the server exporting the file system. + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' +- uid: az_storage-mover_endpoint_update-for-smb + name: az storage-mover endpoint update-for-smb + summary: Updates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint update-for-smb --endpoint-name + --resource-group + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint update-for-smb + syntax: az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. description: '' - isRequired: true name: --resource-group -g @@ -220,33 +330,57 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: - - name: --nfs-version - parameterValueGroup: "NFSauto, NFSv3, NFSv4" - summary: The NFS protocol version. + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. description: '' - uid: az_storage-mover_endpoint_update-for-storage-container name: az storage-mover endpoint update-for-storage-container summary: Updates an Endpoint resource for storage blob container. description: '' syntax: >- - az storage-mover endpoint update-for-storage-container --container-name - --description - --endpoint-name + az storage-mover endpoint update-for-storage-container --endpoint-name --resource-group - --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint update-for-storage-container - syntax: az storage-mover endpoint update-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --description endpointDescUpdate --container-name {container_name} --storage-account-id {account_id} + syntax: az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate requiredParameters: - isRequired: true - name: --container-name - summary: The name of the Storage blob container that is the target destination. + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --description + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_update-for-storage-smb-file-share + name: az storage-mover endpoint update-for-storage-smb-file-share + summary: Updates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name + --resource-group + --storage-mover-name + [--description] + examples: + - summary: endpoint update-for-storage-smb-file-share + syntax: az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -255,14 +389,14 @@ directCommands: name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - isRequired: true - name: --storage-account-id - summary: The Azure Resource ID of the storage account that is the target destination. - description: '' - isRequired: true name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_wait name: az storage-mover endpoint wait summary: Place the CLI in a waiting state until a condition is met. @@ -325,12 +459,16 @@ directCommands: description: '' commands: - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait globalParameters: - name: --debug diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover/job-definition.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover/job-definition.yml index 7c97b6880b..e26619bab6 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover/job-definition.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover/job-definition.yml @@ -4,7 +4,7 @@ name: az storage-mover job-definition extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' directCommands: @@ -121,6 +121,8 @@ directCommands: az storage-mover job-definition list --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-definition list syntax: az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name} @@ -137,6 +139,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-definition_show name: az storage-mover job-definition show summary: Gets a Job Definition resource. @@ -238,22 +247,29 @@ directCommands: description: '' - uid: az_storage-mover_job-definition_update name: az storage-mover job-definition update - summary: Updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + summary: Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' syntax: >- - az storage-mover job-definition update [--agent-name] + az storage-mover job-definition update [--add] + [--agent-name] [--copy-mode {Additive, Mirror}] [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--job-definition-name] [--project-name] + [--remove] [--resource-group] + [--set] [--storage-mover-name] [--subscription] examples: - summary: job-definition update syntax: az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --agent-name summary: Name of the Agent to assign for new Job Runs of this Job Definition. description: '' @@ -264,6 +280,10 @@ directCommands: - name: --description summary: A description for the Job Definition. description: '' + - 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. + description: '' - 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. description: '' @@ -273,9 +293,15 @@ directCommands: - name: --project-name summary: The name of the Project resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover/job-run.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover/job-run.yml index e8e0a9e0ab..d2dc368b1e 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover/job-run.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover/job-run.yml @@ -4,7 +4,7 @@ name: az storage-mover job-run extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Run resource. description: '' directCommands: @@ -17,6 +17,8 @@ directCommands: --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-run list syntax: az storage-mover job-run list -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name} @@ -37,6 +39,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-run_show name: az storage-mover job-run show summary: Gets a Job Run resource. diff --git a/2017-03-09-profile/docs-ref-autogen/storage-mover/project.yml b/2017-03-09-profile/docs-ref-autogen/storage-mover/project.yml index ed11bef4d5..8e427a1285 100644 --- a/2017-03-09-profile/docs-ref-autogen/storage-mover/project.yml +++ b/2017-03-09-profile/docs-ref-autogen/storage-mover/project.yml @@ -4,7 +4,7 @@ name: az storage-mover project extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Project resource, which is a logical grouping of related jobs. description: '' directCommands: @@ -83,6 +83,8 @@ directCommands: syntax: >- az storage-mover project list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: project list syntax: az storage-mover project list -g {rg} --storage-mover-name {mover_name} @@ -95,6 +97,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_project_show name: az storage-mover project show summary: Gets a Project resource. @@ -126,7 +135,7 @@ directCommands: description: '' - uid: az_storage-mover_project_update name: az storage-mover project update - summary: Updates a Project resource, which is a logical grouping of related jobs. + summary: Update a Project resource, which is a logical grouping of related jobs. description: '' syntax: >- az storage-mover project update [--add] 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 f77569f393..f28b72f7fa 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 @@ -496,7 +496,7 @@ directCommands: description: '' - 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. + summary: The destination path that will be prepended to the blob name. description: '' - isRequired: true name: --source -s diff --git a/2018-03-01-hybrid/docs-ref-autogen/acr.yml b/2018-03-01-hybrid/docs-ref-autogen/acr.yml index b2bf406be7..a248fa3f35 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/acr.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/acr.yml @@ -36,7 +36,7 @@ directCommands: summary: The name of the container registry that the query is run against. description: '' optionalParameters: - - name: --password + - name: --password -p summary: Registry password. description: '' - name: --repository @@ -45,7 +45,7 @@ directCommands: - name: --skip-token summary: Skip token to get the next page of the query if applicable. description: '' - - name: --username + - name: --username -u summary: Registry username. description: '' commands: diff --git a/2018-03-01-hybrid/docs-ref-autogen/ad/ds.yml b/2018-03-01-hybrid/docs-ref-autogen/ad/ds.yml index 15ed62586d..551b1b7a0d 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/ad/ds.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/ad/ds.yml @@ -167,7 +167,6 @@ directCommands: [--name] [--no-wait] [--resource-group] - [--subscription] [--yes] examples: - summary: Delete Domain Service @@ -186,9 +185,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -215,7 +211,6 @@ directCommands: az ad ds show [--ids] [--name] [--resource-group] - [--subscription] examples: - summary: Get Domain Service syntax: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup" @@ -229,9 +224,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - uid: az_ad_ds_update name: az ad ds update summary: Update the existing deployment properties for domain service. @@ -255,7 +247,6 @@ directCommands: [--resource-group] [--settings] [--sku {Enterprise, Premium, Standard}] - [--subscription] [--sync-kerberos-pwd {Disabled, Enabled}] [--sync-ntlm-pwd {Disabled, Enabled}] [--sync-on-prem-pwd {Disabled, Enabled}] @@ -356,9 +347,6 @@ directCommands: parameterValueGroup: "Enterprise, Premium, Standard" summary: Sku Type. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --sync-kerberos-pwd parameterValueGroup: "Disabled, Enabled" summary: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. @@ -391,7 +379,6 @@ directCommands: [--interval] [--name] [--resource-group] - [--subscription] [--timeout] [--updated] examples: @@ -430,9 +417,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --timeout defaultValue: "3600" summary: Maximum wait in seconds. diff --git a/2018-03-01-hybrid/docs-ref-autogen/aks.yml b/2018-03-01-hybrid/docs-ref-autogen/aks.yml index ca3c7a16ca..91bc58fb06 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/aks.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/aks.yml @@ -804,7 +804,7 @@ directCommands: 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. description: '' - name: --vm-set-type - summary: Agent pool vm set type. VirtualMachineScaleSets or AvailabilitySet. + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. @@ -1476,6 +1476,7 @@ directCommands: [--min-count] [--nat-gateway-idle-timeout] [--nat-gateway-managed-outbound-ip-count] + [--network-dataplane {azure, cilium}] [--network-plugin-mode] [--no-wait] [--node-os-upgrade-channel {NodeImage, None, SecurityPatch, Unmanaged}] @@ -1891,6 +1892,13 @@ directCommands: - name: --nat-gateway-managed-outbound-ip-count summary: NAT gateway managed outbound IP count. description: Desired number of managed outbound IPs for NAT gateway outbound connection. Please specify a value in the range of [1, 16]. Valid for Standard SKU load balancer cluster with managedNATGateway outbound type only. + - name: --network-dataplane + parameterValueGroup: "azure, cilium" + summary: The network dataplane to use. + description: >- + Network dataplane used in the Kubernetes cluster. + + Specify "azure" to use the Azure dataplane (default) or "cilium" to enable Cilium dataplane. - name: --network-plugin-mode summary: The network plugin mode to use. description: >- diff --git a/2018-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml b/2018-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml index 5e8fe4ae9e..f2d343520c 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml @@ -57,6 +57,7 @@ directCommands: [--snapshot-id] [--spot-max-price] [--tags] + [--vm-set-type] [--vnet-subnet-id] [--workload-runtime {KataMshvVmIsolation, OCIContainer, WasmWasi}] [--zones {1, 2, 3}] @@ -236,6 +237,9 @@ directCommands: - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' + - name: --vm-set-type + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). + description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. description: '' diff --git a/2018-03-01-hybrid/docs-ref-autogen/databox/job.yml b/2018-03-01-hybrid/docs-ref-autogen/databox/job.yml index 132986a36d..f2b2248809 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/databox/job.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/databox/job.yml @@ -78,6 +78,8 @@ directCommands: [--street-address2] [--street-address3] [--tags] + [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}] + [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}] [--transfer-configuration-type {TransferAll, TransferUsingFilter}] [--transfer-filter-details] examples: @@ -181,6 +183,16 @@ directCommands: - name: --tags summary: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. description: '' + - name: --transfer-all-blobs + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure blobs have to be transferred. + description: '' + - name: --transfer-all-files + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure files have to be transferred. + description: '' - name: --transfer-configuration-type parameterValueGroup: "TransferAll, TransferUsingFilter" summary: Type of the configuration for transfer. diff --git a/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml b/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml index 083c1c27bf..30bea04755 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml @@ -13,8 +13,8 @@ directCommands: summary: Create a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition create --dev-box-definition-name - --dev-center + az devcenter admin devbox-definition create --dev-center + --devbox-definition-name --image-reference --os-storage-type --resource-group @@ -27,14 +27,14 @@ directCommands: - summary: Create syntax: az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" requiredParameters: - - isRequired: true - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - isRequired: true name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - isRequired: true + name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - isRequired: true name: --image-reference summary: Image reference information. Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. @@ -71,8 +71,8 @@ directCommands: summary: Delete a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition delete [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition delete [--dev-center] + [--devbox-definition-name] [--ids] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] @@ -82,12 +82,12 @@ directCommands: - summary: Delete syntax: az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. description: '' @@ -135,8 +135,8 @@ directCommands: summary: Get a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition show [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition show [--dev-center] + [--devbox-definition-name] [--ids] [--project] [--resource-group] @@ -147,12 +147,12 @@ directCommands: - summary: Get project dev box definition syntax: az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the Dev Box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the Dev Box definition. + description: '' - 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. description: '' @@ -171,8 +171,8 @@ directCommands: description: '' syntax: >- az devcenter admin devbox-definition update [--add] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--hibernate-support {Disabled, Enabled}] [--ids] @@ -192,12 +192,12 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. @@ -245,8 +245,8 @@ directCommands: az devcenter admin devbox-definition wait [--created] [--custom] [--deleted] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--exists] [--ids] [--interval] @@ -266,12 +266,12 @@ directCommands: defaultValue: "False" summary: Wait until deleted. description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - name: --exists defaultValue: "False" summary: Wait until the resource exists. diff --git a/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml b/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml index 1e5cfe0aed..729ba8be09 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml @@ -13,7 +13,7 @@ directCommands: summary: Create a pool. description: '' syntax: >- - az devcenter admin pool create --dev-box-definition-name + az devcenter admin pool create --devbox-definition-name --local-administrator {Disabled, Enabled} --name --network-connection-name @@ -27,7 +27,7 @@ directCommands: syntax: az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" requiredParameters: - isRequired: true - name: --dev-box-definition-name -d + name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - isRequired: true @@ -155,7 +155,7 @@ directCommands: description: '' syntax: >- az devcenter admin pool update [--add] - [--dev-box-definition-name] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--local-administrator {Disabled, Enabled}] @@ -175,7 +175,7 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name -d + - name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - name: --force-string diff --git a/2018-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml b/2018-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml index ca76da049b..7177bda441 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml @@ -29,7 +29,7 @@ directCommands: summary: Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA. description: '' - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: @@ -53,7 +53,7 @@ directCommands: syntax: az iot hub certificate root-authority show --hub-name {iothub_name} requiredParameters: - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: diff --git a/2018-03-01-hybrid/docs-ref-autogen/mysql.yml b/2018-03-01-hybrid/docs-ref-autogen/mysql.yml index dce46b92e6..afdf9ab880 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/mysql.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/mysql.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az mysql down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az mysql show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_mysql_up name: az mysql up summary: Set up an Azure Database for MySQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/2018-03-01-hybrid/docs-ref-autogen/postgres.yml b/2018-03-01-hybrid/docs-ref-autogen/postgres.yml index df119f58d8..948bf54b44 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/postgres.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/postgres.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az postgres down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az postgres show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_postgres_up name: az postgres up summary: Set up an Azure Database for PostgreSQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' 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 97329dee25..b83a2d182e 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 @@ -13,19 +13,21 @@ directCommands: summary: List Azure Arc enabled PostgreSQL server endpoints. description: '' syntax: >- - az postgres server-arc endpoint list [--k8s-namespace] - [--name] + az postgres server-arc endpoint list --name + [--k8s-namespace] [--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. + description: '' 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. description: '' - - name: --name -n - summary: Name of the Azure Arc enabled PostgreSQL server. - description: '' - name: --use-k8s summary: Use local Kubernetes APIs to perform this action. description: '' diff --git a/2018-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml b/2018-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml index 099cfa981b..b359c7f9e3 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml @@ -22,6 +22,7 @@ directCommands: [--partner-mirroring-url] [--partner-resource-group] [--partner-sync-mode {async, sync}] + [--primary-mirroring-url] [--resource-group] [--role {primary, secondary}] [--shared-name] @@ -30,7 +31,9 @@ directCommands: - summary: Use the Kubernetes API to create a failover group resource between primary SQL managed instance sqlmi1 and partner SQL managed instance sqlmi2.The partner mirroring endpoint and cert file are required. syntax: az sql instance-failover-group-arc create --name fogcr --shared-name sharedname1 --mi sqlmi1 --role primary --partner-mi sqlmi2 --partner-mirroring-url 10.20.5.20:970 --partner-mirroring-cert-file ./sqlmi2.cer --use-k8s - summary: Use Azure Resource Manager (ARM) to create a failover group resource. - syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --role primary + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async + - summary: Use ARM to create a failover group with custom mirroring URLs. + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --primary-mirroring-url 21.10.6.30:6603 --partner-mirroring-url 10.20.5.20:970 requiredParameters: - isRequired: true name: --mi @@ -65,6 +68,9 @@ directCommands: parameterValueGroup: "async, sync" summary: The partner synchronization mode of the Arc-enabled SQL managed instance. description: '' + - name: --primary-mirroring-url + summary: The mirroring endpoint URL of the primary SQL managed instance. + description: '' - name: --resource-group -g summary: The Azure resource group of the primary Arc-enabled SQL managed instance. description: '' diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover.yml index 45d3a5d4bf..fc5910f2a0 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover.yml @@ -4,7 +4,7 @@ name: az storage-mover extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage top-level Storage Mover resource. description: '' directCommands: @@ -79,11 +79,20 @@ directCommands: name: az storage-mover list summary: Lists all Storage Movers in a subscription. description: '' - syntax: az storage-mover list [--resource-group] + syntax: >- + az storage-mover list [--max-items] + [--next-token] + [--resource-group] examples: - summary: storage-mover list syntax: az storage-mover list -g {rg} 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' @@ -114,31 +123,48 @@ directCommands: description: '' - uid: az_storage-mover_update name: az storage-mover update - summary: Update properties for a Storage Mover resource. Properties not specified in the request body will be unchanged. + summary: Update a top-level Storage Mover resource. description: '' syntax: >- - az storage-mover update [--description] + az storage-mover update [--add] + [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--name] + [--remove] [--resource-group] + [--set] [--subscription] [--tags] examples: - summary: storage-mover update syntax: az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --description summary: A description for the Storage Mover. description: '' + - 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. + description: '' - 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. description: '' - name: --name --storage-mover-name -n summary: The name of the Storage Mover resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --subscription summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. description: '' @@ -212,12 +238,16 @@ commands: - az_storage-mover_delete - az_storage-mover_endpoint - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait - az_storage-mover_job-definition - az_storage-mover_job-definition_create diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml index 008b2ef905..c4e14d37f3 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml @@ -4,7 +4,7 @@ name: az storage-mover agent extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Agent resource, which references a hybrid compute machine that can run jobs. description: '' directCommands: @@ -15,6 +15,8 @@ directCommands: syntax: >- az storage-mover agent list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: agent list syntax: az storage-mover agent list -g {rg} --storage-mover-name {mover_name} @@ -27,6 +29,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_agent_show name: az storage-mover agent show summary: Gets an Agent resource. @@ -97,7 +106,7 @@ directCommands: description: '' - uid: az_storage-mover_agent_update name: az storage-mover agent update - summary: Updates an Agent resource, which references a hybrid compute machine that can run jobs. + summary: Update an Agent resource, which references a hybrid compute machine that can run jobs. description: '' syntax: >- az storage-mover agent update [--add] diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml index 3abfbc5e5e..138ad149cd 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml @@ -4,7 +4,7 @@ name: az storage-mover endpoint extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Endpoint resource, which represents a data transfer source or destination. description: '' directCommands: @@ -13,21 +13,17 @@ directCommands: summary: Creates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint create-for-nfs --description - --endpoint-name + az storage-mover endpoint create-for-nfs --endpoint-name --export --host --resource-group --storage-mover-name + [--description] [--nfs-version {NFSauto, NFSv3, NFSv4}] examples: - summary: endpoint create-for-nfs - syntax: az storage-mover endpoint create-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDesc --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip" requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -49,37 +45,122 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - name: --nfs-version parameterValueGroup: "NFSauto, NFSv3, NFSv4" summary: The NFS protocol version. description: '' +- uid: az_storage-mover_endpoint_create-for-smb + name: az storage-mover endpoint create-for-smb + summary: Creates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint create-for-smb --endpoint-name + --host + --resource-group + --share-name + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint create-for-smb + syntax: az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip" + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --host + summary: The host name or IP address of the server exporting the file system. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --share-name + summary: The name of the SMB share being exported from the server. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. + description: '' - uid: az_storage-mover_endpoint_create-for-storage-container name: az storage-mover endpoint create-for-storage-container summary: Creates an Endpoint resource for storage blob container. description: '' syntax: >- az storage-mover endpoint create-for-storage-container --container-name - --description --endpoint-name --resource-group --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint create-for-storage-container - syntax: az storage-mover endpoint create-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --container-name {container_name} --storage-account-id {account_id} --description endpointDesc + syntax: az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc requiredParameters: - isRequired: true name: --container-name summary: The name of the Storage blob container that is the target destination. description: '' - isRequired: true - name: --description + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --storage-account-id + summary: The Azure Resource ID of the storage account that is the target destination. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_create-for-storage-smb-file-share + name: az storage-mover endpoint create-for-storage-smb-file-share + summary: Creates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name + --file-share-name + --resource-group + --storage-account-id + --storage-mover-name + [--description] + examples: + - summary: endpoint create-for-storage-smb-file-share + syntax: az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' + - isRequired: true + name: --file-share-name + summary: The name of the Azure Storage file share. + description: '' - isRequired: true name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -92,6 +173,10 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_delete name: az storage-mover endpoint delete summary: Deletes an Endpoint resource. @@ -138,6 +223,8 @@ directCommands: syntax: >- az storage-mover endpoint list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: endpoint list syntax: az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name} @@ -150,6 +237,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_endpoint_show name: az storage-mover endpoint show summary: Gets an Endpoint resource. @@ -184,32 +278,48 @@ directCommands: summary: Updates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint update-for-nfs --description - --endpoint-name - --export - --host + az storage-mover endpoint update-for-nfs --endpoint-name --resource-group --storage-mover-name - [--nfs-version {NFSauto, NFSv3, NFSv4}] + [--description] examples: - summary: endpoint update-for-nfs - syntax: az storage-mover endpoint update-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDescUpdate --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' - isRequired: true - name: --export - summary: The directory being exported from the server. + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --host - summary: The host name or IP address of the server exporting the file system. + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' +- uid: az_storage-mover_endpoint_update-for-smb + name: az storage-mover endpoint update-for-smb + summary: Updates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint update-for-smb --endpoint-name + --resource-group + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint update-for-smb + syntax: az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. description: '' - isRequired: true name: --resource-group -g @@ -220,33 +330,57 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: - - name: --nfs-version - parameterValueGroup: "NFSauto, NFSv3, NFSv4" - summary: The NFS protocol version. + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. description: '' - uid: az_storage-mover_endpoint_update-for-storage-container name: az storage-mover endpoint update-for-storage-container summary: Updates an Endpoint resource for storage blob container. description: '' syntax: >- - az storage-mover endpoint update-for-storage-container --container-name - --description - --endpoint-name + az storage-mover endpoint update-for-storage-container --endpoint-name --resource-group - --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint update-for-storage-container - syntax: az storage-mover endpoint update-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --description endpointDescUpdate --container-name {container_name} --storage-account-id {account_id} + syntax: az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate requiredParameters: - isRequired: true - name: --container-name - summary: The name of the Storage blob container that is the target destination. + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --description + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_update-for-storage-smb-file-share + name: az storage-mover endpoint update-for-storage-smb-file-share + summary: Updates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name + --resource-group + --storage-mover-name + [--description] + examples: + - summary: endpoint update-for-storage-smb-file-share + syntax: az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -255,14 +389,14 @@ directCommands: name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - isRequired: true - name: --storage-account-id - summary: The Azure Resource ID of the storage account that is the target destination. - description: '' - isRequired: true name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_wait name: az storage-mover endpoint wait summary: Place the CLI in a waiting state until a condition is met. @@ -325,12 +459,16 @@ directCommands: description: '' commands: - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait globalParameters: - name: --debug diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml index 7c97b6880b..e26619bab6 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml @@ -4,7 +4,7 @@ name: az storage-mover job-definition extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' directCommands: @@ -121,6 +121,8 @@ directCommands: az storage-mover job-definition list --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-definition list syntax: az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name} @@ -137,6 +139,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-definition_show name: az storage-mover job-definition show summary: Gets a Job Definition resource. @@ -238,22 +247,29 @@ directCommands: description: '' - uid: az_storage-mover_job-definition_update name: az storage-mover job-definition update - summary: Updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + summary: Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' syntax: >- - az storage-mover job-definition update [--agent-name] + az storage-mover job-definition update [--add] + [--agent-name] [--copy-mode {Additive, Mirror}] [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--job-definition-name] [--project-name] + [--remove] [--resource-group] + [--set] [--storage-mover-name] [--subscription] examples: - summary: job-definition update syntax: az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --agent-name summary: Name of the Agent to assign for new Job Runs of this Job Definition. description: '' @@ -264,6 +280,10 @@ directCommands: - name: --description summary: A description for the Job Definition. description: '' + - 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. + description: '' - 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. description: '' @@ -273,9 +293,15 @@ directCommands: - name: --project-name summary: The name of the Project resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml index e8e0a9e0ab..d2dc368b1e 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml @@ -4,7 +4,7 @@ name: az storage-mover job-run extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Run resource. description: '' directCommands: @@ -17,6 +17,8 @@ directCommands: --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-run list syntax: az storage-mover job-run list -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name} @@ -37,6 +39,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-run_show name: az storage-mover job-run show summary: Gets a Job Run resource. diff --git a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml index ed11bef4d5..8e427a1285 100644 --- a/2018-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml +++ b/2018-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml @@ -4,7 +4,7 @@ name: az storage-mover project extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Project resource, which is a logical grouping of related jobs. description: '' directCommands: @@ -83,6 +83,8 @@ directCommands: syntax: >- az storage-mover project list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: project list syntax: az storage-mover project list -g {rg} --storage-mover-name {mover_name} @@ -95,6 +97,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_project_show name: az storage-mover project show summary: Gets a Project resource. @@ -126,7 +135,7 @@ directCommands: description: '' - uid: az_storage-mover_project_update name: az storage-mover project update - summary: Updates a Project resource, which is a logical grouping of related jobs. + summary: Update a Project resource, which is a logical grouping of related jobs. description: '' syntax: >- az storage-mover project update [--add] 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 f77569f393..f28b72f7fa 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 @@ -496,7 +496,7 @@ directCommands: description: '' - 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. + summary: The destination path that will be prepended to the blob name. description: '' - isRequired: true name: --source -s diff --git a/2019-03-01-hybrid/docs-ref-autogen/acr.yml b/2019-03-01-hybrid/docs-ref-autogen/acr.yml index b2bf406be7..a248fa3f35 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/acr.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/acr.yml @@ -36,7 +36,7 @@ directCommands: summary: The name of the container registry that the query is run against. description: '' optionalParameters: - - name: --password + - name: --password -p summary: Registry password. description: '' - name: --repository @@ -45,7 +45,7 @@ directCommands: - name: --skip-token summary: Skip token to get the next page of the query if applicable. description: '' - - name: --username + - name: --username -u summary: Registry username. description: '' commands: diff --git a/2019-03-01-hybrid/docs-ref-autogen/ad/ds.yml b/2019-03-01-hybrid/docs-ref-autogen/ad/ds.yml index 15ed62586d..551b1b7a0d 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/ad/ds.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/ad/ds.yml @@ -167,7 +167,6 @@ directCommands: [--name] [--no-wait] [--resource-group] - [--subscription] [--yes] examples: - summary: Delete Domain Service @@ -186,9 +185,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -215,7 +211,6 @@ directCommands: az ad ds show [--ids] [--name] [--resource-group] - [--subscription] examples: - summary: Get Domain Service syntax: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup" @@ -229,9 +224,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - uid: az_ad_ds_update name: az ad ds update summary: Update the existing deployment properties for domain service. @@ -255,7 +247,6 @@ directCommands: [--resource-group] [--settings] [--sku {Enterprise, Premium, Standard}] - [--subscription] [--sync-kerberos-pwd {Disabled, Enabled}] [--sync-ntlm-pwd {Disabled, Enabled}] [--sync-on-prem-pwd {Disabled, Enabled}] @@ -356,9 +347,6 @@ directCommands: parameterValueGroup: "Enterprise, Premium, Standard" summary: Sku Type. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --sync-kerberos-pwd parameterValueGroup: "Disabled, Enabled" summary: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. @@ -391,7 +379,6 @@ directCommands: [--interval] [--name] [--resource-group] - [--subscription] [--timeout] [--updated] examples: @@ -430,9 +417,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --timeout defaultValue: "3600" summary: Maximum wait in seconds. diff --git a/2019-03-01-hybrid/docs-ref-autogen/aks.yml b/2019-03-01-hybrid/docs-ref-autogen/aks.yml index ca3c7a16ca..91bc58fb06 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/aks.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/aks.yml @@ -804,7 +804,7 @@ directCommands: 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. description: '' - name: --vm-set-type - summary: Agent pool vm set type. VirtualMachineScaleSets or AvailabilitySet. + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. @@ -1476,6 +1476,7 @@ directCommands: [--min-count] [--nat-gateway-idle-timeout] [--nat-gateway-managed-outbound-ip-count] + [--network-dataplane {azure, cilium}] [--network-plugin-mode] [--no-wait] [--node-os-upgrade-channel {NodeImage, None, SecurityPatch, Unmanaged}] @@ -1891,6 +1892,13 @@ directCommands: - name: --nat-gateway-managed-outbound-ip-count summary: NAT gateway managed outbound IP count. description: Desired number of managed outbound IPs for NAT gateway outbound connection. Please specify a value in the range of [1, 16]. Valid for Standard SKU load balancer cluster with managedNATGateway outbound type only. + - name: --network-dataplane + parameterValueGroup: "azure, cilium" + summary: The network dataplane to use. + description: >- + Network dataplane used in the Kubernetes cluster. + + Specify "azure" to use the Azure dataplane (default) or "cilium" to enable Cilium dataplane. - name: --network-plugin-mode summary: The network plugin mode to use. description: >- diff --git a/2019-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml b/2019-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml index 5e8fe4ae9e..f2d343520c 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/aks/nodepool.yml @@ -57,6 +57,7 @@ directCommands: [--snapshot-id] [--spot-max-price] [--tags] + [--vm-set-type] [--vnet-subnet-id] [--workload-runtime {KataMshvVmIsolation, OCIContainer, WasmWasi}] [--zones {1, 2, 3}] @@ -236,6 +237,9 @@ directCommands: - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' + - name: --vm-set-type + summary: Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(internal use only). + description: '' - name: --vnet-subnet-id summary: The ID of a subnet in an existing VNet into which to deploy the cluster. description: '' diff --git a/2019-03-01-hybrid/docs-ref-autogen/databox/job.yml b/2019-03-01-hybrid/docs-ref-autogen/databox/job.yml index 132986a36d..f2b2248809 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/databox/job.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/databox/job.yml @@ -78,6 +78,8 @@ directCommands: [--street-address2] [--street-address3] [--tags] + [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}] + [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}] [--transfer-configuration-type {TransferAll, TransferUsingFilter}] [--transfer-filter-details] examples: @@ -181,6 +183,16 @@ directCommands: - name: --tags summary: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. description: '' + - name: --transfer-all-blobs + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure blobs have to be transferred. + description: '' + - name: --transfer-all-files + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure files have to be transferred. + description: '' - name: --transfer-configuration-type parameterValueGroup: "TransferAll, TransferUsingFilter" summary: Type of the configuration for transfer. diff --git a/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml b/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml index 083c1c27bf..30bea04755 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml @@ -13,8 +13,8 @@ directCommands: summary: Create a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition create --dev-box-definition-name - --dev-center + az devcenter admin devbox-definition create --dev-center + --devbox-definition-name --image-reference --os-storage-type --resource-group @@ -27,14 +27,14 @@ directCommands: - summary: Create syntax: az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" requiredParameters: - - isRequired: true - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - isRequired: true name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - isRequired: true + name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - isRequired: true name: --image-reference summary: Image reference information. Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. @@ -71,8 +71,8 @@ directCommands: summary: Delete a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition delete [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition delete [--dev-center] + [--devbox-definition-name] [--ids] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] @@ -82,12 +82,12 @@ directCommands: - summary: Delete syntax: az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. description: '' @@ -135,8 +135,8 @@ directCommands: summary: Get a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition show [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition show [--dev-center] + [--devbox-definition-name] [--ids] [--project] [--resource-group] @@ -147,12 +147,12 @@ directCommands: - summary: Get project dev box definition syntax: az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the Dev Box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the Dev Box definition. + description: '' - 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. description: '' @@ -171,8 +171,8 @@ directCommands: description: '' syntax: >- az devcenter admin devbox-definition update [--add] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--hibernate-support {Disabled, Enabled}] [--ids] @@ -192,12 +192,12 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. @@ -245,8 +245,8 @@ directCommands: az devcenter admin devbox-definition wait [--created] [--custom] [--deleted] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--exists] [--ids] [--interval] @@ -266,12 +266,12 @@ directCommands: defaultValue: "False" summary: Wait until deleted. description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - name: --exists defaultValue: "False" summary: Wait until the resource exists. diff --git a/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml b/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml index 1e5cfe0aed..729ba8be09 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml @@ -13,7 +13,7 @@ directCommands: summary: Create a pool. description: '' syntax: >- - az devcenter admin pool create --dev-box-definition-name + az devcenter admin pool create --devbox-definition-name --local-administrator {Disabled, Enabled} --name --network-connection-name @@ -27,7 +27,7 @@ directCommands: syntax: az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" requiredParameters: - isRequired: true - name: --dev-box-definition-name -d + name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - isRequired: true @@ -155,7 +155,7 @@ directCommands: description: '' syntax: >- az devcenter admin pool update [--add] - [--dev-box-definition-name] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--local-administrator {Disabled, Enabled}] @@ -175,7 +175,7 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name -d + - name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - name: --force-string diff --git a/2019-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml b/2019-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml index ca76da049b..7177bda441 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml @@ -29,7 +29,7 @@ directCommands: summary: Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA. description: '' - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: @@ -53,7 +53,7 @@ directCommands: syntax: az iot hub certificate root-authority show --hub-name {iothub_name} requiredParameters: - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: diff --git a/2019-03-01-hybrid/docs-ref-autogen/mysql.yml b/2019-03-01-hybrid/docs-ref-autogen/mysql.yml index dce46b92e6..afdf9ab880 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/mysql.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/mysql.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az mysql down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az mysql show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_mysql_up name: az mysql up summary: Set up an Azure Database for MySQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/2019-03-01-hybrid/docs-ref-autogen/postgres.yml b/2019-03-01-hybrid/docs-ref-autogen/postgres.yml index df119f58d8..948bf54b44 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/postgres.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/postgres.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az postgres down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az postgres show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_postgres_up name: az postgres up summary: Set up an Azure Database for PostgreSQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' 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 97329dee25..b83a2d182e 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 @@ -13,19 +13,21 @@ directCommands: summary: List Azure Arc enabled PostgreSQL server endpoints. description: '' syntax: >- - az postgres server-arc endpoint list [--k8s-namespace] - [--name] + az postgres server-arc endpoint list --name + [--k8s-namespace] [--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. + description: '' 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. description: '' - - name: --name -n - summary: Name of the Azure Arc enabled PostgreSQL server. - description: '' - name: --use-k8s summary: Use local Kubernetes APIs to perform this action. description: '' diff --git a/2019-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml b/2019-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml index 099cfa981b..b359c7f9e3 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml @@ -22,6 +22,7 @@ directCommands: [--partner-mirroring-url] [--partner-resource-group] [--partner-sync-mode {async, sync}] + [--primary-mirroring-url] [--resource-group] [--role {primary, secondary}] [--shared-name] @@ -30,7 +31,9 @@ directCommands: - summary: Use the Kubernetes API to create a failover group resource between primary SQL managed instance sqlmi1 and partner SQL managed instance sqlmi2.The partner mirroring endpoint and cert file are required. syntax: az sql instance-failover-group-arc create --name fogcr --shared-name sharedname1 --mi sqlmi1 --role primary --partner-mi sqlmi2 --partner-mirroring-url 10.20.5.20:970 --partner-mirroring-cert-file ./sqlmi2.cer --use-k8s - summary: Use Azure Resource Manager (ARM) to create a failover group resource. - syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --role primary + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async + - summary: Use ARM to create a failover group with custom mirroring URLs. + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --primary-mirroring-url 21.10.6.30:6603 --partner-mirroring-url 10.20.5.20:970 requiredParameters: - isRequired: true name: --mi @@ -65,6 +68,9 @@ directCommands: parameterValueGroup: "async, sync" summary: The partner synchronization mode of the Arc-enabled SQL managed instance. description: '' + - name: --primary-mirroring-url + summary: The mirroring endpoint URL of the primary SQL managed instance. + description: '' - name: --resource-group -g summary: The Azure resource group of the primary Arc-enabled SQL managed instance. description: '' diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover.yml index 45d3a5d4bf..fc5910f2a0 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover.yml @@ -4,7 +4,7 @@ name: az storage-mover extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage top-level Storage Mover resource. description: '' directCommands: @@ -79,11 +79,20 @@ directCommands: name: az storage-mover list summary: Lists all Storage Movers in a subscription. description: '' - syntax: az storage-mover list [--resource-group] + syntax: >- + az storage-mover list [--max-items] + [--next-token] + [--resource-group] examples: - summary: storage-mover list syntax: az storage-mover list -g {rg} 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' @@ -114,31 +123,48 @@ directCommands: description: '' - uid: az_storage-mover_update name: az storage-mover update - summary: Update properties for a Storage Mover resource. Properties not specified in the request body will be unchanged. + summary: Update a top-level Storage Mover resource. description: '' syntax: >- - az storage-mover update [--description] + az storage-mover update [--add] + [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--name] + [--remove] [--resource-group] + [--set] [--subscription] [--tags] examples: - summary: storage-mover update syntax: az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --description summary: A description for the Storage Mover. description: '' + - 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. + description: '' - 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. description: '' - name: --name --storage-mover-name -n summary: The name of the Storage Mover resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --subscription summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. description: '' @@ -212,12 +238,16 @@ commands: - az_storage-mover_delete - az_storage-mover_endpoint - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait - az_storage-mover_job-definition - az_storage-mover_job-definition_create diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml index 008b2ef905..c4e14d37f3 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/agent.yml @@ -4,7 +4,7 @@ name: az storage-mover agent extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Agent resource, which references a hybrid compute machine that can run jobs. description: '' directCommands: @@ -15,6 +15,8 @@ directCommands: syntax: >- az storage-mover agent list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: agent list syntax: az storage-mover agent list -g {rg} --storage-mover-name {mover_name} @@ -27,6 +29,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_agent_show name: az storage-mover agent show summary: Gets an Agent resource. @@ -97,7 +106,7 @@ directCommands: description: '' - uid: az_storage-mover_agent_update name: az storage-mover agent update - summary: Updates an Agent resource, which references a hybrid compute machine that can run jobs. + summary: Update an Agent resource, which references a hybrid compute machine that can run jobs. description: '' syntax: >- az storage-mover agent update [--add] diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml index 3abfbc5e5e..138ad149cd 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml @@ -4,7 +4,7 @@ name: az storage-mover endpoint extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Endpoint resource, which represents a data transfer source or destination. description: '' directCommands: @@ -13,21 +13,17 @@ directCommands: summary: Creates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint create-for-nfs --description - --endpoint-name + az storage-mover endpoint create-for-nfs --endpoint-name --export --host --resource-group --storage-mover-name + [--description] [--nfs-version {NFSauto, NFSv3, NFSv4}] examples: - summary: endpoint create-for-nfs - syntax: az storage-mover endpoint create-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDesc --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip" requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -49,37 +45,122 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - name: --nfs-version parameterValueGroup: "NFSauto, NFSv3, NFSv4" summary: The NFS protocol version. description: '' +- uid: az_storage-mover_endpoint_create-for-smb + name: az storage-mover endpoint create-for-smb + summary: Creates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint create-for-smb --endpoint-name + --host + --resource-group + --share-name + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint create-for-smb + syntax: az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip" + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --host + summary: The host name or IP address of the server exporting the file system. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --share-name + summary: The name of the SMB share being exported from the server. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. + description: '' - uid: az_storage-mover_endpoint_create-for-storage-container name: az storage-mover endpoint create-for-storage-container summary: Creates an Endpoint resource for storage blob container. description: '' syntax: >- az storage-mover endpoint create-for-storage-container --container-name - --description --endpoint-name --resource-group --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint create-for-storage-container - syntax: az storage-mover endpoint create-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --container-name {container_name} --storage-account-id {account_id} --description endpointDesc + syntax: az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc requiredParameters: - isRequired: true name: --container-name summary: The name of the Storage blob container that is the target destination. description: '' - isRequired: true - name: --description + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --storage-account-id + summary: The Azure Resource ID of the storage account that is the target destination. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_create-for-storage-smb-file-share + name: az storage-mover endpoint create-for-storage-smb-file-share + summary: Creates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name + --file-share-name + --resource-group + --storage-account-id + --storage-mover-name + [--description] + examples: + - summary: endpoint create-for-storage-smb-file-share + syntax: az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' + - isRequired: true + name: --file-share-name + summary: The name of the Azure Storage file share. + description: '' - isRequired: true name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -92,6 +173,10 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_delete name: az storage-mover endpoint delete summary: Deletes an Endpoint resource. @@ -138,6 +223,8 @@ directCommands: syntax: >- az storage-mover endpoint list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: endpoint list syntax: az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name} @@ -150,6 +237,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_endpoint_show name: az storage-mover endpoint show summary: Gets an Endpoint resource. @@ -184,32 +278,48 @@ directCommands: summary: Updates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint update-for-nfs --description - --endpoint-name - --export - --host + az storage-mover endpoint update-for-nfs --endpoint-name --resource-group --storage-mover-name - [--nfs-version {NFSauto, NFSv3, NFSv4}] + [--description] examples: - summary: endpoint update-for-nfs - syntax: az storage-mover endpoint update-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDescUpdate --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' - isRequired: true - name: --export - summary: The directory being exported from the server. + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --host - summary: The host name or IP address of the server exporting the file system. + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' +- uid: az_storage-mover_endpoint_update-for-smb + name: az storage-mover endpoint update-for-smb + summary: Updates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint update-for-smb --endpoint-name + --resource-group + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint update-for-smb + syntax: az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. description: '' - isRequired: true name: --resource-group -g @@ -220,33 +330,57 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: - - name: --nfs-version - parameterValueGroup: "NFSauto, NFSv3, NFSv4" - summary: The NFS protocol version. + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. description: '' - uid: az_storage-mover_endpoint_update-for-storage-container name: az storage-mover endpoint update-for-storage-container summary: Updates an Endpoint resource for storage blob container. description: '' syntax: >- - az storage-mover endpoint update-for-storage-container --container-name - --description - --endpoint-name + az storage-mover endpoint update-for-storage-container --endpoint-name --resource-group - --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint update-for-storage-container - syntax: az storage-mover endpoint update-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --description endpointDescUpdate --container-name {container_name} --storage-account-id {account_id} + syntax: az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate requiredParameters: - isRequired: true - name: --container-name - summary: The name of the Storage blob container that is the target destination. + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --description + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_update-for-storage-smb-file-share + name: az storage-mover endpoint update-for-storage-smb-file-share + summary: Updates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name + --resource-group + --storage-mover-name + [--description] + examples: + - summary: endpoint update-for-storage-smb-file-share + syntax: az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -255,14 +389,14 @@ directCommands: name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - isRequired: true - name: --storage-account-id - summary: The Azure Resource ID of the storage account that is the target destination. - description: '' - isRequired: true name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_wait name: az storage-mover endpoint wait summary: Place the CLI in a waiting state until a condition is met. @@ -325,12 +459,16 @@ directCommands: description: '' commands: - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait globalParameters: - name: --debug diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml index 7c97b6880b..e26619bab6 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml @@ -4,7 +4,7 @@ name: az storage-mover job-definition extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' directCommands: @@ -121,6 +121,8 @@ directCommands: az storage-mover job-definition list --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-definition list syntax: az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name} @@ -137,6 +139,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-definition_show name: az storage-mover job-definition show summary: Gets a Job Definition resource. @@ -238,22 +247,29 @@ directCommands: description: '' - uid: az_storage-mover_job-definition_update name: az storage-mover job-definition update - summary: Updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + summary: Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' syntax: >- - az storage-mover job-definition update [--agent-name] + az storage-mover job-definition update [--add] + [--agent-name] [--copy-mode {Additive, Mirror}] [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--job-definition-name] [--project-name] + [--remove] [--resource-group] + [--set] [--storage-mover-name] [--subscription] examples: - summary: job-definition update syntax: az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --agent-name summary: Name of the Agent to assign for new Job Runs of this Job Definition. description: '' @@ -264,6 +280,10 @@ directCommands: - name: --description summary: A description for the Job Definition. description: '' + - 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. + description: '' - 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. description: '' @@ -273,9 +293,15 @@ directCommands: - name: --project-name summary: The name of the Project resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml index e8e0a9e0ab..d2dc368b1e 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml @@ -4,7 +4,7 @@ name: az storage-mover job-run extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Run resource. description: '' directCommands: @@ -17,6 +17,8 @@ directCommands: --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-run list syntax: az storage-mover job-run list -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name} @@ -37,6 +39,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-run_show name: az storage-mover job-run show summary: Gets a Job Run resource. diff --git a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml index ed11bef4d5..8e427a1285 100644 --- a/2019-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml +++ b/2019-03-01-hybrid/docs-ref-autogen/storage-mover/project.yml @@ -4,7 +4,7 @@ name: az storage-mover project extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Project resource, which is a logical grouping of related jobs. description: '' directCommands: @@ -83,6 +83,8 @@ directCommands: syntax: >- az storage-mover project list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: project list syntax: az storage-mover project list -g {rg} --storage-mover-name {mover_name} @@ -95,6 +97,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_project_show name: az storage-mover project show summary: Gets a Project resource. @@ -126,7 +135,7 @@ directCommands: description: '' - uid: az_storage-mover_project_update name: az storage-mover project update - summary: Updates a Project resource, which is a logical grouping of related jobs. + summary: Update a Project resource, which is a logical grouping of related jobs. description: '' syntax: >- az storage-mover project update [--add] 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 f77569f393..f28b72f7fa 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 @@ -496,7 +496,7 @@ directCommands: description: '' - 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. + summary: The destination path that will be prepended to the blob name. description: '' - isRequired: true name: --source -s diff --git a/2020-09-01-hybrid/docs-ref-autogen/acr.yml b/2020-09-01-hybrid/docs-ref-autogen/acr.yml index 55273fb9f7..ae5983f5f5 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr.yml @@ -393,7 +393,7 @@ directCommands: summary: The name of the container registry that the query is run against. description: '' optionalParameters: - - name: --password + - name: --password -p summary: Registry password. description: '' - name: --repository @@ -402,7 +402,7 @@ directCommands: - name: --skip-token summary: Skip token to get the next page of the query if applicable. description: '' - - name: --username + - name: --username -u summary: Registry username. description: '' - uid: az_acr_run 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 7322897ffc..a49cfebf23 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 @@ -281,10 +281,10 @@ directCommands: description: '' 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', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - 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', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. 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 1672ccb94d..77931bb114 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 @@ -57,10 +57,10 @@ directCommands: description: '' 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', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - 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', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. 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 5e92c45b8d..8458eace78 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 @@ -37,10 +37,10 @@ directCommands: summary: Description for the scope map. Maximum 256 characters are allowed. description: '' - 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'}. + summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'message/read', 'config/write', 'message/write'}. description: '' - name: --repository - summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'content/read', 'metadata/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -147,19 +147,19 @@ directCommands: description: '' 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'}. + summary: Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'message/read', 'config/write', 'message/write'}. description: '' - name: --add-repository - summary: Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - name: --description summary: Description for the scope map. Maximum 256 characters are allowed. description: '' - 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'}. + summary: Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'message/read', 'config/write', 'message/write'}. description: '' - name: --remove-repository - summary: Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + 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', 'content/read', 'metadata/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. 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 2ab470520c..4315357d54 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/acr/token.yml @@ -47,14 +47,14 @@ directCommands: summary: 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". description: '' - 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'}. + summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'message/read', 'config/write', 'message/write'}. description: '' - 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. description: '' - name: --repository - summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/read', 'metadata/read', 'content/delete', 'metadata/write', 'content/write'}. + summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'metadata/write', 'content/delete', 'content/read', 'metadata/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. diff --git a/2020-09-01-hybrid/docs-ref-autogen/ad/ds.yml b/2020-09-01-hybrid/docs-ref-autogen/ad/ds.yml index 15ed62586d..551b1b7a0d 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/ad/ds.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/ad/ds.yml @@ -167,7 +167,6 @@ directCommands: [--name] [--no-wait] [--resource-group] - [--subscription] [--yes] examples: - summary: Delete Domain Service @@ -186,9 +185,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -215,7 +211,6 @@ directCommands: az ad ds show [--ids] [--name] [--resource-group] - [--subscription] examples: - summary: Get Domain Service syntax: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup" @@ -229,9 +224,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - uid: az_ad_ds_update name: az ad ds update summary: Update the existing deployment properties for domain service. @@ -255,7 +247,6 @@ directCommands: [--resource-group] [--settings] [--sku {Enterprise, Premium, Standard}] - [--subscription] [--sync-kerberos-pwd {Disabled, Enabled}] [--sync-ntlm-pwd {Disabled, Enabled}] [--sync-on-prem-pwd {Disabled, Enabled}] @@ -356,9 +347,6 @@ directCommands: parameterValueGroup: "Enterprise, Premium, Standard" summary: Sku Type. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --sync-kerberos-pwd parameterValueGroup: "Disabled, Enabled" summary: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. @@ -391,7 +379,6 @@ directCommands: [--interval] [--name] [--resource-group] - [--subscription] [--timeout] [--updated] examples: @@ -430,9 +417,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --timeout defaultValue: "3600" summary: Maximum wait in seconds. diff --git a/2020-09-01-hybrid/docs-ref-autogen/databox/job.yml b/2020-09-01-hybrid/docs-ref-autogen/databox/job.yml index 132986a36d..f2b2248809 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/databox/job.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/databox/job.yml @@ -78,6 +78,8 @@ directCommands: [--street-address2] [--street-address3] [--tags] + [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}] + [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}] [--transfer-configuration-type {TransferAll, TransferUsingFilter}] [--transfer-filter-details] examples: @@ -181,6 +183,16 @@ directCommands: - name: --tags summary: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. description: '' + - name: --transfer-all-blobs + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure blobs have to be transferred. + description: '' + - name: --transfer-all-files + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure files have to be transferred. + description: '' - name: --transfer-configuration-type parameterValueGroup: "TransferAll, TransferUsingFilter" summary: Type of the configuration for transfer. diff --git a/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml b/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml index 083c1c27bf..30bea04755 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/devbox-definition.yml @@ -13,8 +13,8 @@ directCommands: summary: Create a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition create --dev-box-definition-name - --dev-center + az devcenter admin devbox-definition create --dev-center + --devbox-definition-name --image-reference --os-storage-type --resource-group @@ -27,14 +27,14 @@ directCommands: - summary: Create syntax: az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" requiredParameters: - - isRequired: true - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - isRequired: true name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - isRequired: true + name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - isRequired: true name: --image-reference summary: Image reference information. Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. @@ -71,8 +71,8 @@ directCommands: summary: Delete a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition delete [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition delete [--dev-center] + [--devbox-definition-name] [--ids] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] @@ -82,12 +82,12 @@ directCommands: - summary: Delete syntax: az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. description: '' @@ -135,8 +135,8 @@ directCommands: summary: Get a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition show [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition show [--dev-center] + [--devbox-definition-name] [--ids] [--project] [--resource-group] @@ -147,12 +147,12 @@ directCommands: - summary: Get project dev box definition syntax: az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the Dev Box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the Dev Box definition. + description: '' - 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. description: '' @@ -171,8 +171,8 @@ directCommands: description: '' syntax: >- az devcenter admin devbox-definition update [--add] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--hibernate-support {Disabled, Enabled}] [--ids] @@ -192,12 +192,12 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. @@ -245,8 +245,8 @@ directCommands: az devcenter admin devbox-definition wait [--created] [--custom] [--deleted] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--exists] [--ids] [--interval] @@ -266,12 +266,12 @@ directCommands: defaultValue: "False" summary: Wait until deleted. description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - name: --exists defaultValue: "False" summary: Wait until the resource exists. diff --git a/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml b/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml index 1e5cfe0aed..729ba8be09 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/devcenter/admin/pool.yml @@ -13,7 +13,7 @@ directCommands: summary: Create a pool. description: '' syntax: >- - az devcenter admin pool create --dev-box-definition-name + az devcenter admin pool create --devbox-definition-name --local-administrator {Disabled, Enabled} --name --network-connection-name @@ -27,7 +27,7 @@ directCommands: syntax: az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" requiredParameters: - isRequired: true - name: --dev-box-definition-name -d + name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - isRequired: true @@ -155,7 +155,7 @@ directCommands: description: '' syntax: >- az devcenter admin pool update [--add] - [--dev-box-definition-name] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--local-administrator {Disabled, Enabled}] @@ -175,7 +175,7 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name -d + - name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - name: --force-string diff --git a/2020-09-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml b/2020-09-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml index ca76da049b..7177bda441 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/iot/hub/certificate/root-authority.yml @@ -29,7 +29,7 @@ directCommands: summary: Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA. description: '' - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: @@ -53,7 +53,7 @@ directCommands: syntax: az iot hub certificate root-authority show --hub-name {iothub_name} requiredParameters: - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: diff --git a/2020-09-01-hybrid/docs-ref-autogen/mysql.yml b/2020-09-01-hybrid/docs-ref-autogen/mysql.yml index dce46b92e6..afdf9ab880 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/mysql.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/mysql.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az mysql down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az mysql show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_mysql_up name: az mysql up summary: Set up an Azure Database for MySQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/2020-09-01-hybrid/docs-ref-autogen/postgres.yml b/2020-09-01-hybrid/docs-ref-autogen/postgres.yml index df119f58d8..948bf54b44 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/postgres.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/postgres.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az postgres down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az postgres show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_postgres_up name: az postgres up summary: Set up an Azure Database for PostgreSQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' 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 97329dee25..b83a2d182e 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 @@ -13,19 +13,21 @@ directCommands: summary: List Azure Arc enabled PostgreSQL server endpoints. description: '' syntax: >- - az postgres server-arc endpoint list [--k8s-namespace] - [--name] + az postgres server-arc endpoint list --name + [--k8s-namespace] [--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. + description: '' 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. description: '' - - name: --name -n - summary: Name of the Azure Arc enabled PostgreSQL server. - description: '' - name: --use-k8s summary: Use local Kubernetes APIs to perform this action. description: '' diff --git a/2020-09-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml b/2020-09-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml index 099cfa981b..b359c7f9e3 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/sql/instance-failover-group-arc.yml @@ -22,6 +22,7 @@ directCommands: [--partner-mirroring-url] [--partner-resource-group] [--partner-sync-mode {async, sync}] + [--primary-mirroring-url] [--resource-group] [--role {primary, secondary}] [--shared-name] @@ -30,7 +31,9 @@ directCommands: - summary: Use the Kubernetes API to create a failover group resource between primary SQL managed instance sqlmi1 and partner SQL managed instance sqlmi2.The partner mirroring endpoint and cert file are required. syntax: az sql instance-failover-group-arc create --name fogcr --shared-name sharedname1 --mi sqlmi1 --role primary --partner-mi sqlmi2 --partner-mirroring-url 10.20.5.20:970 --partner-mirroring-cert-file ./sqlmi2.cer --use-k8s - summary: Use Azure Resource Manager (ARM) to create a failover group resource. - syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --role primary + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async + - summary: Use ARM to create a failover group with custom mirroring URLs. + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --primary-mirroring-url 21.10.6.30:6603 --partner-mirroring-url 10.20.5.20:970 requiredParameters: - isRequired: true name: --mi @@ -65,6 +68,9 @@ directCommands: parameterValueGroup: "async, sync" summary: The partner synchronization mode of the Arc-enabled SQL managed instance. description: '' + - name: --primary-mirroring-url + summary: The mirroring endpoint URL of the primary SQL managed instance. + description: '' - name: --resource-group -g summary: The Azure resource group of the primary Arc-enabled SQL managed instance. description: '' diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover.yml index 45d3a5d4bf..fc5910f2a0 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover.yml @@ -4,7 +4,7 @@ name: az storage-mover extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage top-level Storage Mover resource. description: '' directCommands: @@ -79,11 +79,20 @@ directCommands: name: az storage-mover list summary: Lists all Storage Movers in a subscription. description: '' - syntax: az storage-mover list [--resource-group] + syntax: >- + az storage-mover list [--max-items] + [--next-token] + [--resource-group] examples: - summary: storage-mover list syntax: az storage-mover list -g {rg} 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' @@ -114,31 +123,48 @@ directCommands: description: '' - uid: az_storage-mover_update name: az storage-mover update - summary: Update properties for a Storage Mover resource. Properties not specified in the request body will be unchanged. + summary: Update a top-level Storage Mover resource. description: '' syntax: >- - az storage-mover update [--description] + az storage-mover update [--add] + [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--name] + [--remove] [--resource-group] + [--set] [--subscription] [--tags] examples: - summary: storage-mover update syntax: az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --description summary: A description for the Storage Mover. description: '' + - 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. + description: '' - 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. description: '' - name: --name --storage-mover-name -n summary: The name of the Storage Mover resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --subscription summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. description: '' @@ -212,12 +238,16 @@ commands: - az_storage-mover_delete - az_storage-mover_endpoint - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait - az_storage-mover_job-definition - az_storage-mover_job-definition_create diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/agent.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/agent.yml index 008b2ef905..c4e14d37f3 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/agent.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/agent.yml @@ -4,7 +4,7 @@ name: az storage-mover agent extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Agent resource, which references a hybrid compute machine that can run jobs. description: '' directCommands: @@ -15,6 +15,8 @@ directCommands: syntax: >- az storage-mover agent list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: agent list syntax: az storage-mover agent list -g {rg} --storage-mover-name {mover_name} @@ -27,6 +29,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_agent_show name: az storage-mover agent show summary: Gets an Agent resource. @@ -97,7 +106,7 @@ directCommands: description: '' - uid: az_storage-mover_agent_update name: az storage-mover agent update - summary: Updates an Agent resource, which references a hybrid compute machine that can run jobs. + summary: Update an Agent resource, which references a hybrid compute machine that can run jobs. description: '' syntax: >- az storage-mover agent update [--add] diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml index 3abfbc5e5e..138ad149cd 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/endpoint.yml @@ -4,7 +4,7 @@ name: az storage-mover endpoint extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Endpoint resource, which represents a data transfer source or destination. description: '' directCommands: @@ -13,21 +13,17 @@ directCommands: summary: Creates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint create-for-nfs --description - --endpoint-name + az storage-mover endpoint create-for-nfs --endpoint-name --export --host --resource-group --storage-mover-name + [--description] [--nfs-version {NFSauto, NFSv3, NFSv4}] examples: - summary: endpoint create-for-nfs - syntax: az storage-mover endpoint create-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDesc --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip" requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -49,37 +45,122 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - name: --nfs-version parameterValueGroup: "NFSauto, NFSv3, NFSv4" summary: The NFS protocol version. description: '' +- uid: az_storage-mover_endpoint_create-for-smb + name: az storage-mover endpoint create-for-smb + summary: Creates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint create-for-smb --endpoint-name + --host + --resource-group + --share-name + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint create-for-smb + syntax: az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip" + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --host + summary: The host name or IP address of the server exporting the file system. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --share-name + summary: The name of the SMB share being exported from the server. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. + description: '' - uid: az_storage-mover_endpoint_create-for-storage-container name: az storage-mover endpoint create-for-storage-container summary: Creates an Endpoint resource for storage blob container. description: '' syntax: >- az storage-mover endpoint create-for-storage-container --container-name - --description --endpoint-name --resource-group --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint create-for-storage-container - syntax: az storage-mover endpoint create-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --container-name {container_name} --storage-account-id {account_id} --description endpointDesc + syntax: az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc requiredParameters: - isRequired: true name: --container-name summary: The name of the Storage blob container that is the target destination. description: '' - isRequired: true - name: --description + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --storage-account-id + summary: The Azure Resource ID of the storage account that is the target destination. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_create-for-storage-smb-file-share + name: az storage-mover endpoint create-for-storage-smb-file-share + summary: Creates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name + --file-share-name + --resource-group + --storage-account-id + --storage-mover-name + [--description] + examples: + - summary: endpoint create-for-storage-smb-file-share + syntax: az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' + - isRequired: true + name: --file-share-name + summary: The name of the Azure Storage file share. + description: '' - isRequired: true name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -92,6 +173,10 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_delete name: az storage-mover endpoint delete summary: Deletes an Endpoint resource. @@ -138,6 +223,8 @@ directCommands: syntax: >- az storage-mover endpoint list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: endpoint list syntax: az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name} @@ -150,6 +237,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_endpoint_show name: az storage-mover endpoint show summary: Gets an Endpoint resource. @@ -184,32 +278,48 @@ directCommands: summary: Updates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint update-for-nfs --description - --endpoint-name - --export - --host + az storage-mover endpoint update-for-nfs --endpoint-name --resource-group --storage-mover-name - [--nfs-version {NFSauto, NFSv3, NFSv4}] + [--description] examples: - summary: endpoint update-for-nfs - syntax: az storage-mover endpoint update-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDescUpdate --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' - isRequired: true - name: --export - summary: The directory being exported from the server. + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --host - summary: The host name or IP address of the server exporting the file system. + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' +- uid: az_storage-mover_endpoint_update-for-smb + name: az storage-mover endpoint update-for-smb + summary: Updates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint update-for-smb --endpoint-name + --resource-group + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint update-for-smb + syntax: az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. description: '' - isRequired: true name: --resource-group -g @@ -220,33 +330,57 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: - - name: --nfs-version - parameterValueGroup: "NFSauto, NFSv3, NFSv4" - summary: The NFS protocol version. + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. description: '' - uid: az_storage-mover_endpoint_update-for-storage-container name: az storage-mover endpoint update-for-storage-container summary: Updates an Endpoint resource for storage blob container. description: '' syntax: >- - az storage-mover endpoint update-for-storage-container --container-name - --description - --endpoint-name + az storage-mover endpoint update-for-storage-container --endpoint-name --resource-group - --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint update-for-storage-container - syntax: az storage-mover endpoint update-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --description endpointDescUpdate --container-name {container_name} --storage-account-id {account_id} + syntax: az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate requiredParameters: - isRequired: true - name: --container-name - summary: The name of the Storage blob container that is the target destination. + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --description + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_update-for-storage-smb-file-share + name: az storage-mover endpoint update-for-storage-smb-file-share + summary: Updates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name + --resource-group + --storage-mover-name + [--description] + examples: + - summary: endpoint update-for-storage-smb-file-share + syntax: az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -255,14 +389,14 @@ directCommands: name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - isRequired: true - name: --storage-account-id - summary: The Azure Resource ID of the storage account that is the target destination. - description: '' - isRequired: true name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_wait name: az storage-mover endpoint wait summary: Place the CLI in a waiting state until a condition is met. @@ -325,12 +459,16 @@ directCommands: description: '' commands: - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait globalParameters: - name: --debug diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml index 7c97b6880b..e26619bab6 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-definition.yml @@ -4,7 +4,7 @@ name: az storage-mover job-definition extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' directCommands: @@ -121,6 +121,8 @@ directCommands: az storage-mover job-definition list --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-definition list syntax: az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name} @@ -137,6 +139,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-definition_show name: az storage-mover job-definition show summary: Gets a Job Definition resource. @@ -238,22 +247,29 @@ directCommands: description: '' - uid: az_storage-mover_job-definition_update name: az storage-mover job-definition update - summary: Updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + summary: Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' syntax: >- - az storage-mover job-definition update [--agent-name] + az storage-mover job-definition update [--add] + [--agent-name] [--copy-mode {Additive, Mirror}] [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--job-definition-name] [--project-name] + [--remove] [--resource-group] + [--set] [--storage-mover-name] [--subscription] examples: - summary: job-definition update syntax: az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --agent-name summary: Name of the Agent to assign for new Job Runs of this Job Definition. description: '' @@ -264,6 +280,10 @@ directCommands: - name: --description summary: A description for the Job Definition. description: '' + - 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. + description: '' - 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. description: '' @@ -273,9 +293,15 @@ directCommands: - name: --project-name summary: The name of the Project resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml index e8e0a9e0ab..d2dc368b1e 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/job-run.yml @@ -4,7 +4,7 @@ name: az storage-mover job-run extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Run resource. description: '' directCommands: @@ -17,6 +17,8 @@ directCommands: --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-run list syntax: az storage-mover job-run list -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name} @@ -37,6 +39,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-run_show name: az storage-mover job-run show summary: Gets a Job Run resource. diff --git a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/project.yml b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/project.yml index ed11bef4d5..8e427a1285 100644 --- a/2020-09-01-hybrid/docs-ref-autogen/storage-mover/project.yml +++ b/2020-09-01-hybrid/docs-ref-autogen/storage-mover/project.yml @@ -4,7 +4,7 @@ name: az storage-mover project extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Project resource, which is a logical grouping of related jobs. description: '' directCommands: @@ -83,6 +83,8 @@ directCommands: syntax: >- az storage-mover project list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: project list syntax: az storage-mover project list -g {rg} --storage-mover-name {mover_name} @@ -95,6 +97,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_project_show name: az storage-mover project show summary: Gets a Project resource. @@ -126,7 +135,7 @@ directCommands: description: '' - uid: az_storage-mover_project_update name: az storage-mover project update - summary: Updates a Project resource, which is a logical grouping of related jobs. + summary: Update a Project resource, which is a logical grouping of related jobs. description: '' syntax: >- az storage-mover project update [--add] 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 f77569f393..f28b72f7fa 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 @@ -496,7 +496,7 @@ directCommands: description: '' - 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. + summary: The destination path that will be prepended to the blob name. description: '' - isRequired: true name: --source -s diff --git a/docs-ref-conceptual/authenticate-azure-cli.md b/docs-ref-conceptual/authenticate-azure-cli.md index f827bd51b1..09d307318e 100644 --- a/docs-ref-conceptual/authenticate-azure-cli.md +++ b/docs-ref-conceptual/authenticate-azure-cli.md @@ -124,12 +124,14 @@ To learn more about managed identities for Azure resources, see [Configure manag ## 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. Using WAM has several benefits: +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.) -_ 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. +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. @@ -140,8 +142,8 @@ 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, 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. +- 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. ## See also diff --git a/docs-ref-conceptual/azure-cli-endpoints.md b/docs-ref-conceptual/azure-cli-endpoints.md index cc147bcd77..437eaf67e6 100644 --- a/docs-ref-conceptual/azure-cli-endpoints.md +++ b/docs-ref-conceptual/azure-cli-endpoints.md @@ -7,7 +7,7 @@ ms.author: dbradish ms.prod: non-product-specific ms.topic: conceptual ms.custom: devx-track-azurecli -ms.date: 07/13/2023 +ms.date: 08/1/2023 ms.tool: azure-cli --- @@ -17,7 +17,7 @@ If your organization is secured with a firewall or proxy server, you must add ce Two URLs are used during installation to download Python packages: **pypi.org** and **files.pythonhosted.org**. -The following tables provide lists of the endpoints and suffixes used by the Azure CLI. These endpoints are specific to the Azure cloud where your organization is deployed. We do not recommend adding additional Azure CLI-related URLs aside from those needed for specific Azure CLI reference groups, although you may want to add URLs related to other Microsoft products and services. +The following tables provide lists of the endpoints and suffixes used by the Azure CLI. These endpoints are specific to the Azure cloud where your organization is deployed. We don't recommend adding other Azure CLI-related URLs aside from the URLs needed for specific Azure CLI reference groups, although you may want to add URLs related to other Microsoft products and services. ## Endpoints diff --git a/docs-ref-conceptual/azure-cli-extensions-list.md b/docs-ref-conceptual/azure-cli-extensions-list.md index 1e1333f1a3..dfbe8d2312 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: 08/02/2023 +ms.date: 08/08/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.44.0 | Provides a preview for upcoming AKS features | Preview | [0.5.149](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.44.0 | Provides a preview for upcoming AKS features | Preview | [0.5.150](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) | @@ -41,7 +41,7 @@ You will be prompted to install an extension on first use. |[application-insights](https://github.com/Azure/azure-cli-extensions/tree/main/src/application-insights) | 2.38.0 | Support for managing Application Insights components and querying metrics, events, and logs from such components. | Preview | [0.1.19](https://github.com/Azure/azure-cli-extensions/tree/main/src/application-insights/HISTORY.rst) | |[appservice-kube](https://github.com/Azure/azure-cli-extensions/tree/main/src/appservice-kube) | 2.34.1 | Microsoft Azure Command-Line Tools App Service on Kubernetes Extension | Preview | [0.1.8](https://github.com/Azure/azure-cli-extensions/tree/main/src/appservice-kube/HISTORY.rst) | |[arcappliance](https://msazure.visualstudio.com/AzureArcPlatform/_git/arcappliance-cli-extensions) | 2.41.0 | Microsoft Azure Command-Line Tools Arcappliance Extension | Preview | [0.2.32](https://msazure.visualstudio.com/AzureArcPlatform/_git/arcappliance-cli-extensions) | -|[arcdata](https://docs.microsoft.com/en-us/azure/azure-arc/data/) | 2.3.1 | Tools for managing ArcData. | GA | [1.5.3](https://docs.microsoft.com/en-us/azure/azure-arc/data/) | +|[arcdata](https://docs.microsoft.com/en-us/azure/azure-arc/data/) | 2.3.1 | Tools for managing ArcData. | GA | [1.5.4](https://docs.microsoft.com/en-us/azure/azure-arc/data/) | |[attestation](https://github.com/Azure/azure-cli-extensions/tree/main/src/attestation) | 2.11.0 | Microsoft Azure Command-Line Tools AttestationManagementClient Extension | Preview | [0.2.1](https://github.com/Azure/azure-cli-extensions/tree/main/src/attestation/HISTORY.rst) | |[authV2](https://github.com/Azure/azure-cli-extensions/tree/main/src/authV2) | 2.23.0 | Microsoft Azure Command-Line Tools Authv2 Extension | GA | [0.1.2](https://github.com/Azure/azure-cli-extensions/tree/main/src/authV2/HISTORY.rst) | |[automanage](https://github.com/Azure/azure-cli-extensions/tree/main/src/automanage) | 2.44.1 | Microsoft Azure Command-Line Tools Automanage Extension. | Preview | [0.1.2](https://github.com/Azure/azure-cli-extensions/tree/main/src/automanage/HISTORY.rst) | @@ -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.45.0 | Manage Azure Firewall resources. | Preview | [0.14.8](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.4](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.21.5](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,7 +66,7 @@ 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.15](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.3.20](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.0](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.15.0 | Microsoft Azure Command-Line Tools ConnectedMachine Extension | GA | [0.5.1](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.1.12](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) | @@ -144,7 +144,7 @@ You will be prompted to install an extension on first use. |[next](https://github.com/Azure/azure-cli-extensions/tree/main/src/next) | 2.20.0 | Microsoft Azure Command-Line Tools Next Extension | Experimental | [0.1.3](https://github.com/Azure/azure-cli-extensions/tree/main/src/next/HISTORY.rst) | |[nginx](https://github.com/Azure/azure-cli-extensions) | 2.40.0 | Microsoft Azure Command-Line Tools Nginx Extension | GA | [0.1.1](https://github.com/Azure/azure-cli-extensions) | |[notification-hub](https://github.com/Azure/azure-cli-extensions/tree/main/src/notification-hub) | 2.49.0 | Microsoft Azure Command-Line Tools Notification Hub Extension | GA | [1.0.0a1](https://github.com/Azure/azure-cli-extensions/tree/main/src/notification-hub/HISTORY.rst) | -|[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.0](https://github.com/Azure/azure-cli-extensions/tree/main/src/nsp/HISTORY.rst) | +|[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.50.0 | Microsoft Azure Command-Line Tools PaloAltoNetworks Extension. | Preview | [1.0.0b1](https://github.com/Azure/azure-cli-extensions/tree/main/src/palo-alto-networks/HISTORY.rst) | diff --git a/docs-ref-conceptual/includes/cli-install-linux-dnf.md b/docs-ref-conceptual/includes/cli-install-linux-dnf.md index 904005301e..56bdbe7211 100644 --- a/docs-ref-conceptual/includes/cli-install-linux-dnf.md +++ b/docs-ref-conceptual/includes/cli-install-linux-dnf.md @@ -2,18 +2,18 @@ author: chasecrum ms.author: chasecrum manager: mamccrea -ms.date: 08/01/2023 +ms.date: 08/1/2023 ms.topic: include ms.custom: devx-track-azurecli --- ## Before you begin -- Azure CLI [2.38.0](/cli/azure/release-notes-azure-cli#july-05-2022) (released on 07/05/2022) is the last version supported on RHEL 7 and Centos 7 and will continue to receive security fixes until the end of life of the operating systems. Microsoft will not provide additional updates or bug fixes for these distributions. +- Azure CLI [2.38.0](/cli/azure/release-notes-azure-cli#july-05-2022) (released on July 5, 2022) is the last version supported on RHEL 7 and Centos 7 and will continue to receive security fixes until the end of life of the operating systems. Microsoft isn't providing other updates or bug fixes for these distributions. -- Azure CLI and the Linux [Install script](/cli/azure/install-azure-cli-linux?pivots=script) will continue to be developed and supported by Microsoft. Packages provided by Red Hat and CentOS repositories are maintained and supported by their respective distributions. +- Microsoft continues to develop and support Azure CLI and the Linux [Install script](/cli/azure/install-azure-cli-linux?pivots=script). Red Hat and CentOS distributions provide packages, while maintaining and supporting their respective repositories. -- Use the `yum` package manager if you are using a Linux system that doesn't support the `dnf` package manager. +- Use the `yum` package manager if you're using a Linux system that doesn't support the `dnf` package manager. ## Install Azure CLI @@ -56,7 +56,7 @@ To install the Azure CLI, follow these steps: ## Install specific version -To install a specific version, first configure the `azure-cli` repository information as shown above. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md). +You must first configure `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: @@ -113,8 +113,7 @@ Here are some common problems seen when installing with `dnf`. If you experience ### Install on RHEL 7.6 or other systems without Python 3 -The RPM package of the Azure CLI depends on the `python3` package. If you are able, upgrade your system to a version with official support for the `python 3.6+` package. -Otherwise, you need to first install a `python3` package then install Azure CLI without dependency. +If you're able, upgrade your system to a version with official support for `python 3.6+` package. Otherwise, you need to first install a `python3` package, then install Azure CLI without dependency. You can use the following command to download and install the Azure CLI install script with `python 3.6` built from source: @@ -124,7 +123,7 @@ curl -sL https://azurecliprod.blob.core.windows.net/rhel7_6_install.sh | sudo ba You can also do it step by step: -First, Azure CLI requires `SSL 1.1+` and you will need to build `openssl 1.1` from source before building `python3`: +First, Azure CLI requires `SSL 1.1+` and you need to build `openssl 1.1` from source before building `python3`: ```bash sudo dnf install gcc gcc-c++ make ncurses patch wget tar zlib zlib-devel -y @@ -158,14 +157,14 @@ Finally, follow steps 1 and 2 of the [install instruction](#install-azure-cli) t > [!NOTE] > -> If the dnf download plugin isn't already installed, you will encounter a `command not found` error when executing the code below. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin. +> If the dnf download plugin isn't already installed, you will encounter a `command not found` error when executing the following code. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin. ```bash sudo dnf download azure-cli sudo rpm -ivh --nodeps azure-cli-*.rpm ``` -As an alternative, you can also install Python 3 using an [additional repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Use this method, if you have set up `python3` but are still getting the error `python3: command not found`. Make sure it has been include it in your path. +As an alternative, you can also install Python 3 using [another repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Use this method, if you have set up `python3` but are still getting the error `python3: command not found`. Make sure it has been included it in your path. ```bash scl enable rh-python36 bash @@ -175,7 +174,7 @@ scl enable rh-python36 bash [!INCLUDE[configure-proxy](configure-proxy.md)] -You may also want to explicitly configure `dnf` to use this proxy at all times. Make sure that the following +You may also want to explicitly configure `dnf` to always use this proxy. Make sure that the following lines appear under the `[main]` section of `/etc/dnf/dnf.conf`: ```dnf.conf diff --git a/docs-ref-conceptual/includes/specific-version.md b/docs-ref-conceptual/includes/specific-version.md new file mode 100644 index 0000000000..72da97178c --- /dev/null +++ b/docs-ref-conceptual/includes/specific-version.md @@ -0,0 +1,13 @@ +--- +author: dbradish-microsoft +ms.author: dbradish +manager: barbkess +ms.date: 08/08/2023 +ms.topic: include +ms.custom: devx-track-azurecli +--- +To download the MSI installer for a specific version, change the version segment in URL `https://azcliprod.blob.core.windows.net/msi/azure-cli-.msi` (32-bit) or `https://azcliprod.blob.core.windows.net/msi/azure-cli--x64.msi` (64-bit) and download it. + +For example, to install the 32-bit MSI of Azure CLI version [2.51.0](/cli/azure/release-notes-azure-cli#august-01-2023), your URL would be `https://azcliprod.blob.core.windows.net/msi/azure-cli-2.51.0.msi`. The corresponding 64-bit install would be `https://azcliprod.blob.core.windows.net/msi/azure-cli-2.51.0-x64.msi`. + +Available Azure CLI versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md). The 64-bit MSI is available from version [2.51.0](/cli/azure/release-notes-azure-cli#august-01-2023). \ No newline at end of file diff --git a/docs-ref-conceptual/includes/troubleshoot-wsl.md b/docs-ref-conceptual/includes/troubleshoot-wsl.md index 03e9709d79..22e930f39c 100644 --- a/docs-ref-conceptual/includes/troubleshoot-wsl.md +++ b/docs-ref-conceptual/includes/troubleshoot-wsl.md @@ -1,7 +1,7 @@ --- author: dbradish-microsoft ms.author: dbradish -ms.date: 07/05/2023 +ms.date: 08/1/2023 ms.topic: include ms.custom: devx-track-azurecli --- @@ -15,13 +15,13 @@ there's a good chance it's an issue with WSL and not with the CLI install proces To troubleshoot your WSL installation and possibly resolve issues: * If you can, run an identical install process on a Linux machine or VM to see if it succeeds. If it does, - your issue is almost certainly related to WSL. To start a Linux VM in Azure, see the - [create a Linux VM in the Azure Portal](/azure/virtual-machines/linux/quick-create-portal) documentation. + your issue is likely related to WSL. To start a Linux VM in Azure, see the + [create a Linux VM in the Azure portal](/azure/virtual-machines/linux/quick-create-portal) documentation. * Make sure that you're running the latest version of WSL. To get the latest version, [update your Windows 10 installation](https://support.microsoft.com/help/4027667/windows-10-update). -* Check for any [open issues](https://github.com/Microsoft/WSL/issues) with WSL which might address your problem. - Often there will be suggestions on how to work around the problem, or information about a release where - the issue will be fixed. +* Check for any [open issues](https://github.com/Microsoft/WSL/issues) with WSL that might address your problem. + Often there are suggestions on how to work around the problem, or information about a release where + the issue is fixed. * If there are no existing issues for your problem, [file a new issue with WSL](https://github.com/Microsoft/WSL/issues/new) and make sure that you include as much information as possible. diff --git a/docs-ref-conceptual/install-azure-cli-windows.md b/docs-ref-conceptual/install-azure-cli-windows.md index 348a31ea99..1c03097675 100644 --- a/docs-ref-conceptual/install-azure-cli-windows.md +++ b/docs-ref-conceptual/install-azure-cli-windows.md @@ -36,11 +36,14 @@ The MSI distributable is used for installing or updating the Azure CLI on Window Download and install the latest release of the Azure CLI. When the installer asks if it can make changes to your computer, click the "Yes" box. > [!div class="nextstepaction"] -> [Latest release of the Azure CLI](https://aka.ms/installazurecliwindows) +> [Latest release of the Azure CLI (32-bit)](https://aka.ms/installazurecliwindows) +> [Latest release of the Azure CLI (64-bit)](https://aka.ms/installazurecliwindowsx64) + +If you have previously installed the Azure CLI, running either the 32-bit or 64-bit MSI will overwrite an existing installation. ### Specific version -To download the MSI installer for specific version, change the version segment in URL `https://azcliprod.blob.core.windows.net/msi/azure-cli-.msi` and download it. Available versions can be found at [Azure CLI release notes](./release-notes-azure-cli.md). +[!INCLUDE [specific version](includes/specific-version.md)] # [Microsoft Installer (MSI) with Command](#tab/powershell) @@ -58,9 +61,17 @@ To install the Azure CLI using PowerShell, start PowerShell **as administrator** $ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri https://aka.ms/installazurecliwindows -OutFile .\AzureCLI.msi; Start-Process msiexec.exe -Wait -ArgumentList '/I AzureCLI.msi /quiet'; Remove-Item .\AzureCLI.msi ``` -This will download and install the latest version of the Azure CLI for Windows. If you already have a version installed, the installer will update the existing version. +This will download and install the latest 32-bit installer of the Azure CLI for Windows. If you prefer a 64-bit install, change URL to `https://aka.ms/installazurecliwindowsx64`. If the Azure CLI is already installed, the installer will overwrite the existing version. + +To install a specific version, replace the `-Uri` argument with the URL described in [Specific version](#specific-version-1). Here is an example of using the 32-bit installer of the Azure CLI version [2.51.0](/cli/azure/release-notes-azure-cli#august-01-2023) in PowerShell: + + ```PowerShell + $ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri https://azcliprod.blob.core.windows.net/msi/azure-cli-2.51.0.msi -OutFile .\AzureCLI.msi; Start-Process msiexec.exe -Wait -ArgumentList '/I AzureCLI.msi /quiet'; Remove-Item .\AzureCLI.msi + ``` -To install specific version, replace the `-Uri` argument with `https://azcliprod.blob.core.windows.net/msi/azure-cli-.msi` with version segment changed. Available versions can be found at [Azure CLI release notes](./release-notes-azure-cli.md). +### Specific version + +[!INCLUDE [specific version](includes/specific-version.md)] ### Azure CLI Command (for update only) @@ -145,6 +156,18 @@ In order to get the MSI, your proxy needs to allow HTTPS connections to the foll * `https://aka.ms/` * `https://azcliprod.blob.core.windows.net/` +### Migrate to 64-bit Azure CLI + +Starting from 2.51.0, Azure CLI also provides 64-bit MSI which is recommended for better performance. + +Follow these steps to migrate to Azure CLI 64-bit: +1. Check your current CLI version and installed extensions by running `az --version`. +1. Extensions will need to be reinstalled. It is recommended to perform a backup of the current extension folder `%userprofile%\.azure\cliextensions` by renaming it in case you choose to revert back to 32-bit. This folder is created automatically when you reinstall an extension. +1. Download and install latest 64-bit installer as described in [Install or update](#install-or-update). The 32-bit MSI will be automatically uninstalled. +1. Install extensions by running `az extension add --name --version `. If you don't want to reinstall extensions manually, the Azure CLI will prompt you to install an extension on first use. For more information on installing extensions, see [How to install extensions](/cli/azure/azure-cli-extensions-overview#how-to-install-extensions). + +If you have issues after migration, you can uninstall the 64-bit and reinstall the 32-bit MSI. If you have made a backup of your 32-bit extension folder, restore (rename) your extension folder after the change. + ## Uninstall [!INCLUDE [uninstall-boilerplate.md](includes/uninstall-boilerplate.md)] diff --git a/docs-ref-conceptual/msal-based-azure-cli.md b/docs-ref-conceptual/msal-based-azure-cli.md index df772796aa..b3087cd6ab 100644 --- a/docs-ref-conceptual/msal-based-azure-cli.md +++ b/docs-ref-conceptual/msal-based-azure-cli.md @@ -4,7 +4,7 @@ description: Learn about the MSAL-based Azure CLI. author: jiasli ms.author: jiasli manager: yonzhan -ms.date: 06/19/2023 +ms.date: 08/1/2023 ms.topic: conceptual ms.service: azure-cli ms.tool: azure-cli @@ -14,23 +14,23 @@ keywords: msal, msal-based azure cli # MSAL-based Azure CLI -Starting in version 2.30.0, Azure CLI uses [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-python) as the underlying authentication library. MSAL uses AAD v2.0 authentication flow to provide more functionality and increases security for token cache. +Starting in version 2.30.0, Azure CLI uses Microsoft Authentication Library [(MSAL)](https://github.com/AzureAD/microsoft-authentication-library-for-python) as the underlying authentication library. MSAL uses Azure Active Directory v2.0 authentication flow to provide more functionality and increases security for token cache. > [!WARNING] > BREAKING CHANGES are introduced in Azure CLI 2.30.0. Carefully read document prior to installation. ## `accessTokens.json` deprecation -Previous versions of Azure CLI save ADAL tokens and service principal entries to `~/.azure/accessToken.json`. Latest versions of Azure CLI use MSAL and no longer generate `accessTokens.json`. Any existing workflow depending on `accessTokens.json` no longer works. +Previous versions of Azure CLI saved Azure AD Authentication Library (ADAL) tokens and service principal entries to `~/.azure/accessToken.json`. The latest versions of the Azure CLI use MSAL and no longer generate `accessTokens.json`. Any existing workflow depending on `accessTokens.json` no longer works. -The MSAL token cache and service principal entries are saved as encrypted files on Windows, and plaintext files on Linux and MacOS. +The MSAL token cache and service principal entries are saved as encrypted files on Windows, and plaintext files on Linux and macOS. > [!IMPORTANT] -> When using Azure CLI in a pipeline like Azure DevOps, ensure all tasks and stages are using versions of Azure CLI above v2.30.0 for MSAL-based Azure CLI. Azure CLI 2.30.0 is not backwards compatible with prior versions and throws an error when working with versions below 2.30.0. +> When using Azure CLI in a pipeline like Azure DevOps, ensure all tasks and stages are using versions of Azure CLI above v2.30.0 for MSAL-based Azure CLI. Azure CLI 2.30.0 is not backwards compatible with prior versions and throws an error when working with versions prior to 2.30.0. ## Alternatives to consider -Below are a couple alternatives you may consider for stability: +Alternatives you may consider for stability: ### Calling `az account get-access-token` diff --git a/latest/docs-ref-autogen/acr.yml b/latest/docs-ref-autogen/acr.yml index 774b20bad4..12133e8db7 100644 --- a/latest/docs-ref-autogen/acr.yml +++ b/latest/docs-ref-autogen/acr.yml @@ -395,7 +395,7 @@ directCommands: summary: The name of the container registry that the query is run against. description: '' optionalParameters: - - name: --password + - name: --password -p summary: Registry password. description: '' - name: --repository @@ -404,7 +404,7 @@ directCommands: - name: --skip-token summary: Skip token to get the next page of the query if applicable. description: '' - - name: --username + - name: --username -u summary: Registry username. description: '' - uid: az_acr_run diff --git a/latest/docs-ref-autogen/acr/connected-registry.yml b/latest/docs-ref-autogen/acr/connected-registry.yml index 822cffd2b0..bcb8da37ab 100644 --- a/latest/docs-ref-autogen/acr/connected-registry.yml +++ b/latest/docs-ref-autogen/acr/connected-registry.yml @@ -281,10 +281,10 @@ directCommands: description: '' 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', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + 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/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - 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', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + 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/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. diff --git a/latest/docs-ref-autogen/acr/connected-registry/permissions.yml b/latest/docs-ref-autogen/acr/connected-registry/permissions.yml index 0b54d4c9f8..709c653afa 100644 --- a/latest/docs-ref-autogen/acr/connected-registry/permissions.yml +++ b/latest/docs-ref-autogen/acr/connected-registry/permissions.yml @@ -57,10 +57,10 @@ directCommands: description: '' 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', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + 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/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - 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', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + 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/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. diff --git a/latest/docs-ref-autogen/acr/scope-map.yml b/latest/docs-ref-autogen/acr/scope-map.yml index 8aa9709274..c956e11a1d 100644 --- a/latest/docs-ref-autogen/acr/scope-map.yml +++ b/latest/docs-ref-autogen/acr/scope-map.yml @@ -37,10 +37,10 @@ directCommands: summary: Description for the scope map. Maximum 256 characters are allowed. description: '' - name: --gateway - summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'config/write', 'message/write', 'message/read'}. + summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'message/write', 'config/read'}. description: '' - name: --repository - summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -147,19 +147,19 @@ directCommands: description: '' optionalParameters: - name: --add-gateway - summary: Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'config/write', 'message/write', 'message/read'}. + summary: Gateway permissions to be added. Use the format "--add-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'message/write', 'config/read'}. description: '' - name: --add-repository - summary: Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + summary: Repository permissions to be added. Use the format "--add-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --description summary: Description for the scope map. Maximum 256 characters are allowed. description: '' - name: --remove-gateway - summary: Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'config/write', 'message/write', 'message/read'}. + summary: Gateway permissions to be removed. Use the format "--remove-gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'message/write', 'config/read'}. description: '' - name: --remove-repository - summary: Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + summary: Repository permissions to be removed. Use the format "--remove-repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. diff --git a/latest/docs-ref-autogen/acr/token.yml b/latest/docs-ref-autogen/acr/token.yml index 5c7a92247c..e0037296f3 100644 --- a/latest/docs-ref-autogen/acr/token.yml +++ b/latest/docs-ref-autogen/acr/token.yml @@ -47,14 +47,14 @@ directCommands: summary: 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". description: '' - name: --gateway - summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/read', 'config/write', 'message/write', 'message/read'}. + summary: Gateway permissions. Use the format "--gateway GATEWAY [ACTION1 ACTION2 ...]" per flag. Valid actions are {'config/write', 'message/read', 'message/write', 'config/read'}. description: '' - 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. description: '' - name: --repository - summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/write', 'content/read', 'content/delete', 'metadata/read', 'metadata/write'}. + summary: Repository permissions. Use the format "--repository REPO [ACTION1 ACTION2 ...]" per flag. Valid actions are {'content/delete', 'content/write', 'metadata/read', 'metadata/write', 'content/read'}. description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. diff --git a/latest/docs-ref-autogen/ad/ds.yml b/latest/docs-ref-autogen/ad/ds.yml index 15ed62586d..551b1b7a0d 100644 --- a/latest/docs-ref-autogen/ad/ds.yml +++ b/latest/docs-ref-autogen/ad/ds.yml @@ -167,7 +167,6 @@ directCommands: [--name] [--no-wait] [--resource-group] - [--subscription] [--yes] examples: - summary: Delete Domain Service @@ -186,9 +185,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -215,7 +211,6 @@ directCommands: az ad ds show [--ids] [--name] [--resource-group] - [--subscription] examples: - summary: Get Domain Service syntax: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup" @@ -229,9 +224,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - uid: az_ad_ds_update name: az ad ds update summary: Update the existing deployment properties for domain service. @@ -255,7 +247,6 @@ directCommands: [--resource-group] [--settings] [--sku {Enterprise, Premium, Standard}] - [--subscription] [--sync-kerberos-pwd {Disabled, Enabled}] [--sync-ntlm-pwd {Disabled, Enabled}] [--sync-on-prem-pwd {Disabled, Enabled}] @@ -356,9 +347,6 @@ directCommands: parameterValueGroup: "Enterprise, Premium, Standard" summary: Sku Type. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --sync-kerberos-pwd parameterValueGroup: "Disabled, Enabled" summary: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. @@ -391,7 +379,6 @@ directCommands: [--interval] [--name] [--resource-group] - [--subscription] [--timeout] [--updated] examples: @@ -430,9 +417,6 @@ directCommands: - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - name: --subscription - summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. - description: '' - name: --timeout defaultValue: "3600" summary: Maximum wait in seconds. diff --git a/latest/docs-ref-autogen/ams/asset.yml b/latest/docs-ref-autogen/ams/asset.yml index 8f0e1fac9d..fd78e4d545 100644 --- a/latest/docs-ref-autogen/ams/asset.yml +++ b/latest/docs-ref-autogen/ams/asset.yml @@ -114,7 +114,7 @@ directCommands: summary: The name of the Azure Media Services account. description: '' - name: --expiry - defaultValue: "2023-08-04 11:12:58.175665" + defaultValue: "2023-08-09 11:12:01.765371" 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. description: '' - name: --ids diff --git a/latest/docs-ref-autogen/databox/job.yml b/latest/docs-ref-autogen/databox/job.yml index 132986a36d..f2b2248809 100644 --- a/latest/docs-ref-autogen/databox/job.yml +++ b/latest/docs-ref-autogen/databox/job.yml @@ -78,6 +78,8 @@ directCommands: [--street-address2] [--street-address3] [--tags] + [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}] + [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}] [--transfer-configuration-type {TransferAll, TransferUsingFilter}] [--transfer-filter-details] examples: @@ -181,6 +183,16 @@ directCommands: - name: --tags summary: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. description: '' + - name: --transfer-all-blobs + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure blobs have to be transferred. + description: '' + - name: --transfer-all-files + defaultValue: "False" + parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes" + summary: To indicate if all Azure files have to be transferred. + description: '' - name: --transfer-configuration-type parameterValueGroup: "TransferAll, TransferUsingFilter" summary: Type of the configuration for transfer. diff --git a/latest/docs-ref-autogen/devcenter/admin/devbox-definition.yml b/latest/docs-ref-autogen/devcenter/admin/devbox-definition.yml index 083c1c27bf..30bea04755 100644 --- a/latest/docs-ref-autogen/devcenter/admin/devbox-definition.yml +++ b/latest/docs-ref-autogen/devcenter/admin/devbox-definition.yml @@ -13,8 +13,8 @@ directCommands: summary: Create a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition create --dev-box-definition-name - --dev-center + az devcenter admin devbox-definition create --dev-center + --devbox-definition-name --image-reference --os-storage-type --resource-group @@ -27,14 +27,14 @@ directCommands: - summary: Create syntax: az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" requiredParameters: - - isRequired: true - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - isRequired: true name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - isRequired: true + name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - isRequired: true name: --image-reference summary: Image reference information. Support shorthand-syntax, json-file and yaml-file. Try `??` to show more. @@ -71,8 +71,8 @@ directCommands: summary: Delete a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition delete [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition delete [--dev-center] + [--devbox-definition-name] [--ids] [--no-wait {0, 1, f, false, n, no, t, true, y, yes}] [--resource-group] @@ -82,12 +82,12 @@ directCommands: - summary: Delete syntax: az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. description: '' @@ -135,8 +135,8 @@ directCommands: summary: Get a dev box definition. description: '' syntax: >- - az devcenter admin devbox-definition show [--dev-box-definition-name] - [--dev-center] + az devcenter admin devbox-definition show [--dev-center] + [--devbox-definition-name] [--ids] [--project] [--resource-group] @@ -147,12 +147,12 @@ directCommands: - summary: Get project dev box definition syntax: az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1" optionalParameters: - - name: --dev-box-definition-name --name -n - summary: The name of the Dev Box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the Dev Box definition. + description: '' - 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. description: '' @@ -171,8 +171,8 @@ directCommands: description: '' syntax: >- az devcenter admin devbox-definition update [--add] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--hibernate-support {Disabled, Enabled}] [--ids] @@ -192,12 +192,12 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - 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. @@ -245,8 +245,8 @@ directCommands: az devcenter admin devbox-definition wait [--created] [--custom] [--deleted] - [--dev-box-definition-name] [--dev-center] + [--devbox-definition-name] [--exists] [--ids] [--interval] @@ -266,12 +266,12 @@ directCommands: defaultValue: "False" summary: Wait until deleted. description: '' - - name: --dev-box-definition-name --name -n - summary: The name of the dev box definition. - description: '' - name: --dev-center --dev-center-name -d summary: The name of the dev center. Use `az configure -d dev-center=` to configure a default. description: '' + - name: --devbox-definition-name --name -n + summary: The name of the dev box definition. + description: '' - name: --exists defaultValue: "False" summary: Wait until the resource exists. diff --git a/latest/docs-ref-autogen/devcenter/admin/pool.yml b/latest/docs-ref-autogen/devcenter/admin/pool.yml index 1e5cfe0aed..729ba8be09 100644 --- a/latest/docs-ref-autogen/devcenter/admin/pool.yml +++ b/latest/docs-ref-autogen/devcenter/admin/pool.yml @@ -13,7 +13,7 @@ directCommands: summary: Create a pool. description: '' syntax: >- - az devcenter admin pool create --dev-box-definition-name + az devcenter admin pool create --devbox-definition-name --local-administrator {Disabled, Enabled} --name --network-connection-name @@ -27,7 +27,7 @@ directCommands: syntax: az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" requiredParameters: - isRequired: true - name: --dev-box-definition-name -d + name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - isRequired: true @@ -155,7 +155,7 @@ directCommands: description: '' syntax: >- az devcenter admin pool update [--add] - [--dev-box-definition-name] + [--devbox-definition-name] [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--local-administrator {Disabled, Enabled}] @@ -175,7 +175,7 @@ directCommands: - name: --add summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' description: '' - - name: --dev-box-definition-name -d + - name: --devbox-definition-name -d summary: Name of a dev box definition in parent project of this pool. description: '' - name: --force-string diff --git a/latest/docs-ref-autogen/iot/hub/certificate/root-authority.yml b/latest/docs-ref-autogen/iot/hub/certificate/root-authority.yml index ca76da049b..7177bda441 100644 --- a/latest/docs-ref-autogen/iot/hub/certificate/root-authority.yml +++ b/latest/docs-ref-autogen/iot/hub/certificate/root-authority.yml @@ -29,7 +29,7 @@ directCommands: summary: Certificate Root Authority version. The v1 represents Baltimore CA and v2 represents Digicert CA. description: '' - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: @@ -53,7 +53,7 @@ directCommands: syntax: az iot hub certificate root-authority show --hub-name {iothub_name} requiredParameters: - isRequired: true - name: --hub-name -n + name: --hub-name summary: IoT Hub name. Required if --login is not provided. description: '' optionalParameters: diff --git a/latest/docs-ref-autogen/mariadb/server.yml b/latest/docs-ref-autogen/mariadb/server.yml index c9e4764582..c068974f25 100644 --- a/latest/docs-ref-autogen/mariadb/server.yml +++ b/latest/docs-ref-autogen/mariadb/server.yml @@ -42,7 +42,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.' description: '' - name: --admin-user -u - defaultValue: "proudshads1" + defaultValue: "freeeland7" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --assign-identity diff --git a/latest/docs-ref-autogen/mysql.yml b/latest/docs-ref-autogen/mysql.yml index 12159829ab..e018b994c1 100644 --- a/latest/docs-ref-autogen/mysql.yml +++ b/latest/docs-ref-autogen/mysql.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az mysql down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az mysql show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_mysql_up name: az mysql up summary: Set up an Azure Database for MySQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/latest/docs-ref-autogen/mysql/flexible-server.yml b/latest/docs-ref-autogen/mysql/flexible-server.yml index ee4b3087fa..6a0f62f4a0 100644 --- a/latest/docs-ref-autogen/mysql/flexible-server.yml +++ b/latest/docs-ref-autogen/mysql/flexible-server.yml @@ -228,7 +228,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.' description: '' - name: --admin-user -u - defaultValue: "earthyparrot0" + defaultValue: "puzzledpaella2" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --auto-scale-iops @@ -649,7 +649,7 @@ directCommands: summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - name: --restore-time - defaultValue: "2023-08-03T12:12:54+00:00" + defaultValue: "2023-08-08T12:12:08+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. description: '' - name: --sku-name diff --git a/latest/docs-ref-autogen/mysql/flexible-server/import.yml b/latest/docs-ref-autogen/mysql/flexible-server/import.yml index b6a10df018..e167ca0f11 100644 --- a/latest/docs-ref-autogen/mysql/flexible-server/import.yml +++ b/latest/docs-ref-autogen/mysql/flexible-server/import.yml @@ -82,7 +82,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.' description: '' - name: --admin-user -u - defaultValue: "measlyelk3" + defaultValue: "exoticopossum3" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --auto-scale-iops diff --git a/latest/docs-ref-autogen/mysql/server.yml b/latest/docs-ref-autogen/mysql/server.yml index e274ccfeb9..82ac231725 100644 --- a/latest/docs-ref-autogen/mysql/server.yml +++ b/latest/docs-ref-autogen/mysql/server.yml @@ -42,7 +42,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.' description: '' - name: --admin-user -u - defaultValue: "bossybagels7" + defaultValue: "muddledeggs4" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --assign-identity diff --git a/latest/docs-ref-autogen/postgres.yml b/latest/docs-ref-autogen/postgres.yml index 36a98d4ee5..8b4266a324 100644 --- a/latest/docs-ref-autogen/postgres.yml +++ b/latest/docs-ref-autogen/postgres.yml @@ -10,9 +10,11 @@ directCommands: description: '' syntax: >- az postgres down [--delete-group] + [--ids] [--no-wait] [--resource-group] [--server-name] + [--subscription] [--yes] examples: - summary: Delete the server and the cached data, aside from the resource group. @@ -23,6 +25,9 @@ directCommands: - name: --delete-group summary: Delete the resource group. description: '' + - 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. + description: '' - name: --no-wait defaultValue: "False" summary: Do not wait for the long-running operation to finish. @@ -33,6 +38,9 @@ directCommands: - name: --server-name -s summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --yes -y defaultValue: "False" summary: Do not prompt for confirmation. @@ -45,7 +53,9 @@ directCommands: az postgres show-connection-string [--admin-password] [--admin-user] [--database-name] + [--ids] [--server-name] + [--subscription] optionalParameters: - name: --admin-password -p defaultValue: "{password}" @@ -59,10 +69,16 @@ directCommands: defaultValue: "{database}" summary: The name of a database. description: '' + - 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. + description: '' - name: --server-name -s defaultValue: "{server}" summary: Name of the server. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - uid: az_postgres_up name: az postgres up summary: Set up an Azure Database for PostgreSQL server and configurations. @@ -74,12 +90,14 @@ directCommands: [--database-name] [--generate-password] [--geo-redundant-backup {Disabled, Enabled}] + [--ids] [--location] [--resource-group] [--server-name] [--sku-name] [--ssl-enforcement {Disabled, Enabled}] [--storage-size] + [--subscription] [--tags] [--version] examples: @@ -108,6 +126,9 @@ directCommands: parameterValueGroup: "Disabled, Enabled" summary: Enable Geo-redundant or not for server backup. description: '' + - 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. + description: '' - name: --location -l summary: 'Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=`.' description: '' @@ -129,6 +150,9 @@ directCommands: - name: --storage-size summary: The max storage size of the server. Unit is megabytes. description: '' + - name: --subscription + summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. + description: '' - name: --tags summary: 'Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.' description: '' diff --git a/latest/docs-ref-autogen/postgres/flexible-server.yml b/latest/docs-ref-autogen/postgres/flexible-server.yml index 2d0c61f953..ecf5013c51 100644 --- a/latest/docs-ref-autogen/postgres/flexible-server.yml +++ b/latest/docs-ref-autogen/postgres/flexible-server.yml @@ -243,7 +243,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.' description: '' - name: --admin-user -u - defaultValue: "enragedpepper0" + defaultValue: "curiousibis4" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --backup-identity @@ -628,7 +628,7 @@ directCommands: summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - name: --restore-time - defaultValue: "2023-08-03T12:12:59+00:00" + defaultValue: "2023-08-08T12:12:02+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. description: '' - name: --subnet diff --git a/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml b/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml index 97329dee25..b83a2d182e 100644 --- a/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml +++ b/latest/docs-ref-autogen/postgres/server-arc/endpoint.yml @@ -13,19 +13,21 @@ directCommands: summary: List Azure Arc enabled PostgreSQL server endpoints. description: '' syntax: >- - az postgres server-arc endpoint list [--k8s-namespace] - [--name] + az postgres server-arc endpoint list --name + [--k8s-namespace] [--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. + description: '' 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. description: '' - - name: --name -n - summary: Name of the Azure Arc enabled PostgreSQL server. - description: '' - name: --use-k8s summary: Use local Kubernetes APIs to perform this action. description: '' diff --git a/latest/docs-ref-autogen/postgres/server.yml b/latest/docs-ref-autogen/postgres/server.yml index 3efed1ba3c..9221bb16b1 100644 --- a/latest/docs-ref-autogen/postgres/server.yml +++ b/latest/docs-ref-autogen/postgres/server.yml @@ -42,7 +42,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.' description: '' - name: --admin-user -u - defaultValue: "freeauk1" + defaultValue: "entiredingo1" summary: Administrator username for the server. Once set, it cannot be changed. description: '' - name: --assign-identity diff --git a/latest/docs-ref-autogen/sql/instance-failover-group-arc.yml b/latest/docs-ref-autogen/sql/instance-failover-group-arc.yml index 099cfa981b..b359c7f9e3 100644 --- a/latest/docs-ref-autogen/sql/instance-failover-group-arc.yml +++ b/latest/docs-ref-autogen/sql/instance-failover-group-arc.yml @@ -22,6 +22,7 @@ directCommands: [--partner-mirroring-url] [--partner-resource-group] [--partner-sync-mode {async, sync}] + [--primary-mirroring-url] [--resource-group] [--role {primary, secondary}] [--shared-name] @@ -30,7 +31,9 @@ directCommands: - summary: Use the Kubernetes API to create a failover group resource between primary SQL managed instance sqlmi1 and partner SQL managed instance sqlmi2.The partner mirroring endpoint and cert file are required. syntax: az sql instance-failover-group-arc create --name fogcr --shared-name sharedname1 --mi sqlmi1 --role primary --partner-mi sqlmi2 --partner-mirroring-url 10.20.5.20:970 --partner-mirroring-cert-file ./sqlmi2.cer --use-k8s - summary: Use Azure Resource Manager (ARM) to create a failover group resource. - syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --role primary + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async + - summary: Use ARM to create a failover group with custom mirroring URLs. + syntax: az sql instance-failover-group-arc create --name fogcr --mi sqlmi1 --resource-group primary-rg-name --partner-mi sqlmi2 --partner-resource-group partner-rg-name --partner-sync-mode async --primary-mirroring-url 21.10.6.30:6603 --partner-mirroring-url 10.20.5.20:970 requiredParameters: - isRequired: true name: --mi @@ -65,6 +68,9 @@ directCommands: parameterValueGroup: "async, sync" summary: The partner synchronization mode of the Arc-enabled SQL managed instance. description: '' + - name: --primary-mirroring-url + summary: The mirroring endpoint URL of the primary SQL managed instance. + description: '' - name: --resource-group -g summary: The Azure resource group of the primary Arc-enabled SQL managed instance. description: '' diff --git a/latest/docs-ref-autogen/storage-mover.yml b/latest/docs-ref-autogen/storage-mover.yml index 45d3a5d4bf..fc5910f2a0 100644 --- a/latest/docs-ref-autogen/storage-mover.yml +++ b/latest/docs-ref-autogen/storage-mover.yml @@ -4,7 +4,7 @@ name: az storage-mover extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage top-level Storage Mover resource. description: '' directCommands: @@ -79,11 +79,20 @@ directCommands: name: az storage-mover list summary: Lists all Storage Movers in a subscription. description: '' - syntax: az storage-mover list [--resource-group] + syntax: >- + az storage-mover list [--max-items] + [--next-token] + [--resource-group] examples: - summary: storage-mover list syntax: az storage-mover list -g {rg} 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' @@ -114,31 +123,48 @@ directCommands: description: '' - uid: az_storage-mover_update name: az storage-mover update - summary: Update properties for a Storage Mover resource. Properties not specified in the request body will be unchanged. + summary: Update a top-level Storage Mover resource. description: '' syntax: >- - az storage-mover update [--description] + az storage-mover update [--add] + [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--name] + [--remove] [--resource-group] + [--set] [--subscription] [--tags] examples: - summary: storage-mover update syntax: az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --description summary: A description for the Storage Mover. description: '' + - 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. + description: '' - 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. description: '' - name: --name --storage-mover-name -n summary: The name of the Storage Mover resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --subscription summary: Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`. description: '' @@ -212,12 +238,16 @@ commands: - az_storage-mover_delete - az_storage-mover_endpoint - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait - az_storage-mover_job-definition - az_storage-mover_job-definition_create diff --git a/latest/docs-ref-autogen/storage-mover/agent.yml b/latest/docs-ref-autogen/storage-mover/agent.yml index 008b2ef905..c4e14d37f3 100644 --- a/latest/docs-ref-autogen/storage-mover/agent.yml +++ b/latest/docs-ref-autogen/storage-mover/agent.yml @@ -4,7 +4,7 @@ name: az storage-mover agent extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover agent** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Agent resource, which references a hybrid compute machine that can run jobs. description: '' directCommands: @@ -15,6 +15,8 @@ directCommands: syntax: >- az storage-mover agent list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: agent list syntax: az storage-mover agent list -g {rg} --storage-mover-name {mover_name} @@ -27,6 +29,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_agent_show name: az storage-mover agent show summary: Gets an Agent resource. @@ -97,7 +106,7 @@ directCommands: description: '' - uid: az_storage-mover_agent_update name: az storage-mover agent update - summary: Updates an Agent resource, which references a hybrid compute machine that can run jobs. + summary: Update an Agent resource, which references a hybrid compute machine that can run jobs. description: '' syntax: >- az storage-mover agent update [--add] diff --git a/latest/docs-ref-autogen/storage-mover/endpoint.yml b/latest/docs-ref-autogen/storage-mover/endpoint.yml index 3abfbc5e5e..138ad149cd 100644 --- a/latest/docs-ref-autogen/storage-mover/endpoint.yml +++ b/latest/docs-ref-autogen/storage-mover/endpoint.yml @@ -4,7 +4,7 @@ name: az storage-mover endpoint extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover endpoint** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Endpoint resource, which represents a data transfer source or destination. description: '' directCommands: @@ -13,21 +13,17 @@ directCommands: summary: Creates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint create-for-nfs --description - --endpoint-name + az storage-mover endpoint create-for-nfs --endpoint-name --export --host --resource-group --storage-mover-name + [--description] [--nfs-version {NFSauto, NFSv3, NFSv4}] examples: - summary: endpoint create-for-nfs - syntax: az storage-mover endpoint create-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDesc --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip" requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -49,37 +45,122 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - name: --nfs-version parameterValueGroup: "NFSauto, NFSv3, NFSv4" summary: The NFS protocol version. description: '' +- uid: az_storage-mover_endpoint_create-for-smb + name: az storage-mover endpoint create-for-smb + summary: Creates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint create-for-smb --endpoint-name + --host + --resource-group + --share-name + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint create-for-smb + syntax: az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip" + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --host + summary: The host name or IP address of the server exporting the file system. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --share-name + summary: The name of the SMB share being exported from the server. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. + description: '' - uid: az_storage-mover_endpoint_create-for-storage-container name: az storage-mover endpoint create-for-storage-container summary: Creates an Endpoint resource for storage blob container. description: '' syntax: >- az storage-mover endpoint create-for-storage-container --container-name - --description --endpoint-name --resource-group --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint create-for-storage-container - syntax: az storage-mover endpoint create-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --container-name {container_name} --storage-account-id {account_id} --description endpointDesc + syntax: az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc requiredParameters: - isRequired: true name: --container-name summary: The name of the Storage blob container that is the target destination. description: '' - isRequired: true - name: --description + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. + description: '' + - isRequired: true + name: --storage-account-id + summary: The Azure Resource ID of the storage account that is the target destination. + description: '' + - isRequired: true + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_create-for-storage-smb-file-share + name: az storage-mover endpoint create-for-storage-smb-file-share + summary: Creates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name + --file-share-name + --resource-group + --storage-account-id + --storage-mover-name + [--description] + examples: + - summary: endpoint create-for-storage-smb-file-share + syntax: az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' + - isRequired: true + name: --file-share-name + summary: The name of the Azure Storage file share. + description: '' - isRequired: true name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. @@ -92,6 +173,10 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_delete name: az storage-mover endpoint delete summary: Deletes an Endpoint resource. @@ -138,6 +223,8 @@ directCommands: syntax: >- az storage-mover endpoint list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: endpoint list syntax: az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name} @@ -150,6 +237,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_endpoint_show name: az storage-mover endpoint show summary: Gets an Endpoint resource. @@ -184,32 +278,48 @@ directCommands: summary: Updates an Endpoint resource for nfs. description: '' syntax: >- - az storage-mover endpoint update-for-nfs --description - --endpoint-name - --export - --host + az storage-mover endpoint update-for-nfs --endpoint-name --resource-group --storage-mover-name - [--nfs-version {NFSauto, NFSv3, NFSv4}] + [--description] examples: - summary: endpoint update-for-nfs - syntax: az storage-mover endpoint update-for-nfs -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs} --description endpointDescUpdate --export exportfolder --nfs-version NFSv4 --host {vm_ip} + syntax: az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate requiredParameters: - - isRequired: true - name: --description - summary: A description for the Endpoint. - description: '' - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. description: '' - isRequired: true - name: --export - summary: The directory being exported from the server. + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --host - summary: The host name or IP address of the server exporting the file system. + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' +- uid: az_storage-mover_endpoint_update-for-smb + name: az storage-mover endpoint update-for-smb + summary: Updates an Endpoint resource for smb mount. + description: '' + syntax: >- + az storage-mover endpoint update-for-smb --endpoint-name + --resource-group + --storage-mover-name + [--description] + [--password-uri] + [--username-uri] + examples: + - summary: endpoint update-for-smb + syntax: az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate + requiredParameters: + - isRequired: true + name: --endpoint-name --name -n + summary: The name of the endpoint resource. description: '' - isRequired: true name: --resource-group -g @@ -220,33 +330,57 @@ directCommands: summary: The name of the Storage Mover resource. description: '' optionalParameters: - - name: --nfs-version - parameterValueGroup: "NFSauto, NFSv3, NFSv4" - summary: The NFS protocol version. + - name: --description + summary: A description for the Endpoint. + description: '' + - name: --password-uri + summary: The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. + description: '' + - name: --username-uri + summary: The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. description: '' - uid: az_storage-mover_endpoint_update-for-storage-container name: az storage-mover endpoint update-for-storage-container summary: Updates an Endpoint resource for storage blob container. description: '' syntax: >- - az storage-mover endpoint update-for-storage-container --container-name - --description - --endpoint-name + az storage-mover endpoint update-for-storage-container --endpoint-name --resource-group - --storage-account-id --storage-mover-name + [--description] examples: - summary: endpoint update-for-storage-container - syntax: az storage-mover endpoint update-for-storage-container -g {rg} --storage-mover-name {mover_name} -n {endpoint_container} --description endpointDescUpdate --container-name {container_name} --storage-account-id {account_id} + syntax: az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate requiredParameters: - isRequired: true - name: --container-name - summary: The name of the Storage blob container that is the target destination. + name: --endpoint-name --name -n + summary: The name of the endpoint resource. + description: '' + - isRequired: true + name: --resource-group -g + summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - isRequired: true - name: --description + name: --storage-mover-name + summary: The name of the Storage Mover resource. + description: '' + optionalParameters: + - name: --description summary: A description for the Endpoint. description: '' +- uid: az_storage-mover_endpoint_update-for-storage-smb-file-share + name: az storage-mover endpoint update-for-storage-smb-file-share + summary: Updates an Endpoint resource for storage smb file share. + description: '' + syntax: >- + az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name + --resource-group + --storage-mover-name + [--description] + examples: + - summary: endpoint update-for-storage-smb-file-share + syntax: az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate + requiredParameters: - isRequired: true name: --endpoint-name --name -n summary: The name of the endpoint resource. @@ -255,14 +389,14 @@ directCommands: name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' - - isRequired: true - name: --storage-account-id - summary: The Azure Resource ID of the storage account that is the target destination. - description: '' - isRequired: true name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + optionalParameters: + - name: --description + summary: A description for the Endpoint. + description: '' - uid: az_storage-mover_endpoint_wait name: az storage-mover endpoint wait summary: Place the CLI in a waiting state until a condition is met. @@ -325,12 +459,16 @@ directCommands: description: '' commands: - az_storage-mover_endpoint_create-for-nfs +- az_storage-mover_endpoint_create-for-smb - az_storage-mover_endpoint_create-for-storage-container +- az_storage-mover_endpoint_create-for-storage-smb-file-share - az_storage-mover_endpoint_delete - az_storage-mover_endpoint_list - az_storage-mover_endpoint_show - az_storage-mover_endpoint_update-for-nfs +- az_storage-mover_endpoint_update-for-smb - az_storage-mover_endpoint_update-for-storage-container +- az_storage-mover_endpoint_update-for-storage-smb-file-share - az_storage-mover_endpoint_wait globalParameters: - name: --debug diff --git a/latest/docs-ref-autogen/storage-mover/job-definition.yml b/latest/docs-ref-autogen/storage-mover/job-definition.yml index 7c97b6880b..e26619bab6 100644 --- a/latest/docs-ref-autogen/storage-mover/job-definition.yml +++ b/latest/docs-ref-autogen/storage-mover/job-definition.yml @@ -4,7 +4,7 @@ name: az storage-mover job-definition extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-definition** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' directCommands: @@ -121,6 +121,8 @@ directCommands: az storage-mover job-definition list --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-definition list syntax: az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name} @@ -137,6 +139,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-definition_show name: az storage-mover job-definition show summary: Gets a Job Definition resource. @@ -238,22 +247,29 @@ directCommands: description: '' - uid: az_storage-mover_job-definition_update name: az storage-mover job-definition update - summary: Updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + summary: Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. description: '' syntax: >- - az storage-mover job-definition update [--agent-name] + az storage-mover job-definition update [--add] + [--agent-name] [--copy-mode {Additive, Mirror}] [--description] + [--force-string {0, 1, f, false, n, no, t, true, y, yes}] [--ids] [--job-definition-name] [--project-name] + [--remove] [--resource-group] + [--set] [--storage-mover-name] [--subscription] examples: - summary: job-definition update syntax: az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2 optionalParameters: + - name: --add + summary: 'Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .' + description: '' - name: --agent-name summary: Name of the Agent to assign for new Job Runs of this Job Definition. description: '' @@ -264,6 +280,10 @@ directCommands: - name: --description summary: A description for the Job Definition. description: '' + - 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. + description: '' - 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. description: '' @@ -273,9 +293,15 @@ directCommands: - name: --project-name summary: The name of the Project resource. description: '' + - name: --remove + summary: 'Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.' + description: '' - name: --resource-group -g summary: Name of resource group. You can configure the default group using `az configure --defaults group=`. description: '' + - name: --set + summary: 'Update an object by specifying a property path and value to set. Example: --set property1.property2=.' + description: '' - name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' diff --git a/latest/docs-ref-autogen/storage-mover/job-run.yml b/latest/docs-ref-autogen/storage-mover/job-run.yml index e8e0a9e0ab..d2dc368b1e 100644 --- a/latest/docs-ref-autogen/storage-mover/job-run.yml +++ b/latest/docs-ref-autogen/storage-mover/job-run.yml @@ -4,7 +4,7 @@ name: az storage-mover job-run extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover job-run** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Job Run resource. description: '' directCommands: @@ -17,6 +17,8 @@ directCommands: --project-name --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: job-run list syntax: az storage-mover job-run list -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name} @@ -37,6 +39,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_job-run_show name: az storage-mover job-run show summary: Gets a Job Run resource. diff --git a/latest/docs-ref-autogen/storage-mover/project.yml b/latest/docs-ref-autogen/storage-mover/project.yml index ed11bef4d5..8e427a1285 100644 --- a/latest/docs-ref-autogen/storage-mover/project.yml +++ b/latest/docs-ref-autogen/storage-mover/project.yml @@ -4,7 +4,7 @@ name: az storage-mover project extensionInformation: >- > [!Note] - > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. + > This reference is part of the **storage-mover** extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an **az storage-mover project** command. [Learn more](https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) about extensions. summary: Manage Project resource, which is a logical grouping of related jobs. description: '' directCommands: @@ -83,6 +83,8 @@ directCommands: syntax: >- az storage-mover project list --resource-group --storage-mover-name + [--max-items] + [--next-token] examples: - summary: project list syntax: az storage-mover project list -g {rg} --storage-mover-name {mover_name} @@ -95,6 +97,13 @@ directCommands: name: --storage-mover-name summary: The name of the Storage Mover resource. description: '' + 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. + description: '' + - name: --next-token + summary: Token to specify where to start paginating. This is the token value from a previously truncated response. + description: '' - uid: az_storage-mover_project_show name: az storage-mover project show summary: Gets a Project resource. @@ -126,7 +135,7 @@ directCommands: description: '' - uid: az_storage-mover_project_update name: az storage-mover project update - summary: Updates a Project resource, which is a logical grouping of related jobs. + summary: Update a Project resource, which is a logical grouping of related jobs. description: '' syntax: >- az storage-mover project update [--add] diff --git a/latest/docs-ref-autogen/storage/blob/directory.yml b/latest/docs-ref-autogen/storage/blob/directory.yml index f77569f393..f28b72f7fa 100644 --- a/latest/docs-ref-autogen/storage/blob/directory.yml +++ b/latest/docs-ref-autogen/storage/blob/directory.yml @@ -496,7 +496,7 @@ directCommands: description: '' - 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. + summary: The destination path that will be prepended to the blob name. description: '' - isRequired: true name: --source -s