你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az storagesync

注意

此参考是 Azure CLI（版本 2.55.0 或更高版本）的存储同步扩展的一部分。 该扩展将在首次运行 az storagesync 命令时自动安装。 详细了解扩展。

管理Azure 文件同步。

命令

名称	说明	类型	状态
az storagesync check-name-availability	检查提供命名空间名称的可用性。	扩展	GA
az storagesync create	创建新的存储同步服务。	扩展	GA
az storagesync delete	删除给定的存储同步服务。	扩展	GA
az storagesync list	列出资源组或订阅中的所有存储同步服务。	扩展	GA
az storagesync private-endpoint-connection	管理专用终结点连接。	扩展	GA
az storagesync private-endpoint-connection list	列出 PrivateEndpoint连接ion 列表。	扩展	GA
az storagesync registered-server	管理已注册的服务器。	扩展	GA
az storagesync registered-server delete	从其存储同步服务中注销本地服务器。	扩展	GA
az storagesync registered-server list	列出给定存储同步服务的所有已注册服务器。	扩展	GA
az storagesync registered-server show	显示给定已注册服务器的属性。	扩展	GA
az storagesync registered-server wait	将 CLI 置于等待状态，直到满足已注册服务器的条件。	扩展	GA
az storagesync show	显示给定存储同步服务的属性。	扩展	GA
az storagesync sync-group	管理同步组。	扩展	GA
az storagesync sync-group cloud-endpoint	管理云终结点。	扩展	GA
az storagesync sync-group cloud-endpoint create	创建新的云终结点。	扩展	GA
az storagesync sync-group cloud-endpoint delete	删除给定的云终结点。	扩展	GA
az storagesync sync-group cloud-endpoint list	列出同步组中的所有云终结点。	扩展	GA
az storagesync sync-group cloud-endpoint show	显示给定云终结点的属性。	扩展	GA
az storagesync sync-group cloud-endpoint trigger-change-detection	触发对连接到指定Azure 文件同步云终结点的 Azure 文件共享执行的更改的检测。	扩展	GA
az storagesync sync-group cloud-endpoint wait	将 CLI 置于等待状态，直到满足云终结点的条件。	扩展	GA
az storagesync sync-group create	创建新的同步组。	扩展	GA
az storagesync sync-group delete	删除给定的同步组。	扩展	GA
az storagesync sync-group list	列出存储同步服务中的所有同步组。	扩展	GA
az storagesync sync-group server-endpoint	管理服务器终结点。	扩展	GA
az storagesync sync-group server-endpoint create	创建新的服务器终结点。	扩展	GA
az storagesync sync-group server-endpoint delete	删除给定的服务器终结点。	扩展	GA
az storagesync sync-group server-endpoint list	列出同步组中的所有服务器终结点。	扩展	GA
az storagesync sync-group server-endpoint show	显示给定服务器终结点的属性。	扩展	GA
az storagesync sync-group server-endpoint update	更新给定服务器终结点的属性。	扩展	GA
az storagesync sync-group server-endpoint wait	将 CLI 置于等待状态，直到满足服务器终结点的条件。	扩展	GA
az storagesync sync-group show	显示给定同步组的属性。	扩展	GA

az storagesync check-name-availability

检查提供命名空间名称的可用性。

az storagesync check-name-availability --name
                                       --type {Microsoft.StorageSync/storageSyncServices}
                                       [--ids]
                                       [--location-name]
                                       [--subscription]

必需参数

--name

要检查可用性的名称。

--type

资源类型。 必须设置为 Microsoft。存储Sync/storageSyncServices。

接受的值: Microsoft.StorageSync/storageSyncServices

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--location-name

名称检查所需的区域。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storagesync create

创建新的存储同步服务。

az storagesync create --name
                      --resource-group
                      [--location]
                      [--tags]

示例

在资源组“SampleResourceGroup”中创建新的存储同步服务“Sample存储SyncService”。

az storagesync create --resource-group "SampleResourceGroup" \
--name "SampleStorageSyncService" --location "WestUS" --tags key1=value1

必需参数

--name -n

存储同步服务的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

默认值: {}

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storagesync delete

删除给定的存储同步服务。

az storagesync delete [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--yes]

示例

删除资源组“SampleResourceGroup”中的存储同步服务“Sample存储SyncService”。

az storagesync delete --resource-group "SampleResourceGroup" \
--name "SampleStorageSyncService"

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

存储同步服务的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storagesync list

列出资源组或订阅中的所有存储同步服务。

az storagesync list [--resource-group]

示例

列出资源组“SampleResourceGroup”中的所有存储同步服务。

az storagesync list --resource-group "SampleResourceGroup"

列出当前订阅中的所有存储同步服务

az storagesync list

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storagesync show

显示给定存储同步服务的属性。

az storagesync show [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

示例

显示资源组“SampleResourceGroup”中存储同步服务“Sample存储SyncService”的属性。

az storagesync show --resource-group "SampleResourceGroup" --name \
"SampleStorageSyncService"

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

存储同步服务的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。