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

az sql mi-arc

注意

此参考是 Azure CLI(版本 2.3.1 或更高版本)的 arcdata 扩展的一部分。 该扩展将在首次运行 az sql mi-arc 命令时自动安装。 详细了解扩展。

管理已启用 Azure Arc 的 SQL 托管实例。

命令

名称 说明 类型 状态
az sql mi-arc config

配置命令。

分机 GA
az sql mi-arc config add

在配置文件中为 json 路径添加值。

扩展 GA
az sql mi-arc config init

初始化 SQL 托管实例的 CRD 和规范文件。

分机 GA
az sql mi-arc config patch

基于 json 修补程序文件来修补配置文件。

扩展 GA
az sql mi-arc config remove

在配置文件中为 json 路径删除值。

分机 GA
az sql mi-arc config replace

在配置文件中为 json 路径替换值。

扩展 GA
az sql mi-arc create

创建 SQL 托管实例。

分机 GA
az sql mi-arc delete

删除 SQL 托管实例。

扩展 GA
az sql mi-arc edit

已弃用,请通过编辑使用更新。

分机 已放弃
az sql mi-arc endpoint

查看和管理 SQL 终结点。

分机 GA
az sql mi-arc endpoint list

列出 SQL 终结点。

分机 GA
az sql mi-arc get-mirroring-cert

从 sql mi 检索可用性组镜像终结点的证书,并存储在文件中。

分机 GA
az sql mi-arc list

列出 SQL 托管实例。

扩展 GA
az sql mi-arc reprovision-replica

在 SQL 托管实例中重新预配副本 (replica)。

分机 GA
az sql mi-arc show

显示 SQL 托管实例的详细信息。

分机 GA
az sql mi-arc update

更新 SQL 托管实例的配置。

扩展 GA
az sql mi-arc upgrade

升级 SQL 托管实例。

分机 GA

az sql mi-arc create

创建 SQL 托管实例。

若要设置 SQL 托管实例的密码,请AZDATA_PASSWORD设置环境变量。

az sql mi-arc create --name
                     [--ad-account-name]
                     [--ad-connector-name]
                     [--ad-encryption-types]
                     [--admin-login-secret]
                     [--agent-enabled]
                     [--annotations]
                     [--cert-private-key-file]
                     [--cert-public-key-file]
                     [--collation]
                     [--cores-limit]
                     [--cores-request]
                     [--custom-location]
                     [--dev]
                     [--k8s-namespace]
                     [--keytab-secret]
                     [--labels]
                     [--language]
                     [--license-type]
                     [--memory-limit]
                     [--memory-request]
                     [--no-external-endpoint]
                     [--no-wait]
                     [--orchestrator-replicas]
                     [--path]
                     [--primary-dns-name]
                     [--primary-port-number]
                     [--readable-secondaries]
                     [--replicas {1, 2, 3}]
                     [--resource-group]
                     [--retention-days]
                     [--secondary-dns-name]
                     [--secondary-port-number]
                     [--service-annotations]
                     [--service-cert-secret]
                     [--service-labels]
                     [--service-type {LoadBalancer, NodePort}]
                     [--storage-annotations]
                     [--storage-class-backups]
                     [--storage-class-data]
                     [--storage-class-datalogs]
                     [--storage-class-logs]
                     [--storage-class-orchestrator-logs]
                     [--storage-labels]
                     [--sync-secondary-to-commit {-1, 0, 1, 2}]
                     [--tde-mode]
                     [--tde-protector-private-key-file]
                     [--tde-protector-public-key-file]
                     [--tde-protector-secret]
                     [--tier]
                     [--time-zone]
                     [--trace-flags]
                     [--use-k8s]
                     [--volume-size-backups]
                     [--volume-size-data]
                     [--volume-size-datalogs]
                     [--volume-size-logs]
                     [--volume-size-orchestrator-logs]

示例

通过 Kubernetes API 创建 SQL 托管实例。

az sql mi-arc create -n sqlmi1 --k8s-namespace arc --use-k8s

通过 Kubernetes API 在 HA 方案中创建包含 3 个副本 (replica)的 SQL 托管实例。

az sql mi-arc create -n sqlmi2 --replicas 3 --k8s-namespace arc --use-k8s

通过 Azure 资源管理器(ARM)创建 SQL 托管实例。

az sql mi-arc create --name sqlmi3 --resource-group rg-name --custom-location arc-cl

通过 Kubernetes API 创建具有 Active Directory 身份验证的 SQL 托管实例。

az sql mi-arc create --name contososqlmi --k8s-namespace arc --ad-connector-name arcadc --ad-account-name arcuser --keytab-secret arcuser-keytab-secret --primary-dns-name contososqlmi-primary.contoso.local --primary-port-number 8143 --use-k8s

必需参数

--name -n

SQL 托管实例的名称。

可选参数

--ad-account-name

此已启用 Arc 的 SQL 托管实例的 Active Directory 帐户名称。 此帐户需要在部署此实例之前创建。

--ad-connector-name

Active Directory 连接or 的名称。 此参数指示使用 AD 支持进行部署的意向。

--ad-encryption-types

支持的 Active Directory 加密类型的逗号分隔列表。 必须是以下值的子集:RC4、AES128、AES256。

--admin-login-secret

要生成的用于托管或将托管用户管理员登录帐户凭据的 Kubernetes 机密的名称。

--agent-enabled

为实例启用 SQL Server 代理。 默认为禁用。 允许的值为“true”或“false”。

--annotations

SQL 托管实例注释的逗号分隔列表。

--cert-private-key-file

包含用于 SQL Server 的 PEM 格式证书私钥的文件路径。

--cert-public-key-file

包含用于 SQL Server 的 PEM 格式证书公钥的文件路径。

--collation

实例的 SQL Server 排序规则。

--cores-limit -c

托管实例的核心限制(整数)。

--cores-request

对托管实例核心(整数)的请求。

--custom-location

此实例的自定义位置。

--dev

如果指定了此项,则会将其视为开发实例,而不会对其进行计费。

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--keytab-secret

Kubernetes 机密的名称,其中包含此已启用 Arc 的 SQL 托管实例的 keytab 文件。

--labels

SQL 托管实例标签的逗号分隔列表。

--language

在实例中,将 SQL Server 区域设置更改为任何支持的语言标识符 (LCID)。

--license-type -l

要应用于此托管实例的许可证类型允许值为:BasePrice、LicenseIncluded、DisasterRecovery.Default 为 LicenseIncluded。 可以更改许可证类型。

--memory-limit -m

以整数表示的托管实例的容量限制,后跟 Gi (GB)。 示例:4Gi。

--memory-request

以整数表示的托管实例的容量请求,后跟 Gi (GB)。 示例:4Gi。

--no-external-endpoint

如果已指定,则不会创建外部服务。 否则,将使用与数据控制器相同的服务类型来创建外部服务。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--orchestrator-replicas

高可用性业务流程协调程序副本 (replica)数。 值必须介于 1 和 3 之间。

--path

指向 SQL 托管实例 json 文件的 azext_arcdata 文件的路径。

--primary-dns-name

向最终用户公开的主服务 DNS 名称,以连接到已启用 Arc 的SQL 托管实例(例如 sqlinstancename.contoso.com)。

--primary-port-number

主服务向最终用户公开的端口号(例如 31433)。

--readable-secondaries

要进行可读的副本 (replica)数。 仅适用于业务关键层。 值必须介于 0 和副本 (replica)减 1 的数目之间。

--replicas

此选项指定将部署在 Kubernetes 群集中以实现高可用性的SQL 托管实例 副本 (replica)数。 对于常规用途,默认值为 1 副本 (replica),业务关键 为 3 个副本 (replica)。

接受的值: 1, 2, 3
--resource-group -g

应向其添加已启用 Arc SQL 托管实例的 Azure 资源组。

--retention-days

备份保留期,以天为单位指定。 允许的值为 0 到 35。 默认值为 7。 将保留期设置为 0 将关闭 SQL 托管实例上所有数据库的自动备份,并且将删除任何以前的备份。

--secondary-dns-name

向最终用户公开的辅助服务 DNS 名称,以连接到已启用 Arc 的SQL 托管实例(例如 sqlinstancename2.contoso.com)。

--secondary-port-number

辅助服务向最终用户公开的端口号(例如 31434)。

--service-annotations

要应用于所有外部服务的注释的逗号分隔列表。

--service-cert-secret

要生成的用于托管或将托管 SQL 服务证书的 Kubernetes 机密的名称。

--service-labels

要应用于所有外部服务的标签的逗号分隔列表。

--service-type

主服务的类型。

接受的值: LoadBalancer, NodePort
--storage-annotations

要应用于所有 PVC 的注释的逗号分隔列表。

--storage-class-backups

支持 ReadWriteMany (RWX) 的存储类用于备份(/var/opt/mssql/backups)。 如果未指定任何值,将使用默认存储类。

--storage-class-data -d

要用于数据文件的存储类(.mdf、.ndf)。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。

--storage-class-datalogs

要用于数据库日志的存储类 (.ldf)。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。

--storage-class-logs

要用于日志的存储类 (/var/log)。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。

--storage-class-orchestrator-logs

要用于业务流程协调程序日志(/var/log)的存储类。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。

--storage-labels

要应用于所有 PVC 的标签的逗号分隔列表。

--sync-secondary-to-commit

必须同步到提交的辅助副本 (replica)数。 将此值设置为 -1 会将所需的同步辅助数据库数设置为“(#of 副本 (replica)s - 1) / 2”,向下舍入。

接受的值: -1, 0, 1, 2
默认值: -1
--tde-mode

此已启用 Arc 的SQL 托管实例的 透明数据加密 (TDE) 模式。 允许的值:ServiceManaged、CustomerManaged 或 Disabled。 默认值为 Disabled。

--tde-protector-private-key-file

包含要用于 TDE 的 PEM 格式证书私钥的文件的路径。

--tde-protector-public-key-file

包含要用于 TDE 的 PEM 格式证书公钥的文件的路径。

--tde-protector-secret

包含此已启用 Arc 的 TDE 保护程序证书和私钥的 Kubernetes 机密的名称SQL 托管实例。 只能为 CustomerManaged TDE 模式指定。

--tier -t

新实例的定价层。 允许的值:BusinessCritical(简称为 bc)或 GeneralPurpose(简称为 gp)。 默认值为 GeneralPurpose。

--time-zone

实例的 SQL Server 时区。

--trace-flags

以逗号分隔的跟踪标志列表。 默认情况下没有标志。

--use-k8s

使用本地 Kubernetes API 创建 SQL 托管实例。

--volume-size-backups

要用于备份的存储卷的大小(正数),后跟 Ki(千字节)、Mi(兆字节)或 Gi(吉字节)。

--volume-size-data

要用于数据的存储卷的大小(正数),后跟 Ki(千字节)、Mi(兆字节)或 Gi(吉字节)。

--volume-size-datalogs

要用于数据日志的存储卷的大小(正数),后跟 Ki(千字节)、Mi(兆字节)或 Gi(吉字节)。

--volume-size-logs

要用于日志的存储卷的大小(正数),后跟 Ki(千字节)、Mi(兆字节)或 Gi(吉字节)。

--volume-size-orchestrator-logs

要用于业务流程协调程序日志的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(GB)。

全局参数
--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 sql mi-arc delete

删除 SQL 托管实例。

az sql mi-arc delete --name
                     [--k8s-namespace]
                     [--no-wait]
                     [--resource-group]
                     [--use-k8s]

示例

通过 Kubernetes API 删除 SQL 托管实例。

az sql mi-arc delete --name sqlmi1 --k8s-namespace arc --use-k8s

通过 Azure 资源管理器(ARM)删除 SQL 托管实例。

az sql mi-arc delete --name sqlmi1 --resource-group rg-name

必需参数

--name -n

要删除的 SQL 托管实例的名称。

可选参数

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

已启用 Arc SQL 托管实例的 Azure 资源组。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc edit

已放弃

此命令已弃用,将在将来的版本中删除。 请改用“update”。

已弃用,请通过编辑使用更新。

az sql mi-arc edit --name
                   [--agent-enabled]
                   [--annotations]
                   [--cores-limit]
                   [--cores-request]
                   [--custom-location]
                   [--dev]
                   [--k8s-namespace]
                   [--labels]
                   [--license-type]
                   [--location]
                   [--memory-limit]
                   [--memory-request]
                   [--no-wait]
                   [--path]
                   [--resource-group]
                   [--retention-days]
                   [--service-annotations]
                   [--service-labels]
                   [--tag-name]
                   [--tag-value]
                   [--tier]
                   [--time-zone]
                   [--trace-flags]
                   [--use-k8s]

必需参数

--name -n

正在编辑的 SQL 托管实例的名称。 不能更改部署实例时为其指定的名称。

可选参数

--agent-enabled

为实例启用 SQL Server 代理。 默认为禁用。

--annotations

SQL 托管实例注释的逗号分隔列表。

--cores-limit -c

托管实例的核心限制(整数)。

--cores-request

对托管实例核心(整数)的请求。

--custom-location

此实例的自定义位置。

--dev

如果指定了此项,则会将其视为开发实例,而不会对其进行计费。

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--labels

SQL 托管实例标签的逗号分隔列表。

--license-type

要更新此托管实例允许值的许可证类型为:BasePrice、LicenseIncluded、DisasterRecovery。 默认值为 LicenseIncluded。

--location

将存储 sqlmi 元数据的 Azure 位置(例如 eastus)。

--memory-limit -m

以整数表示的托管实例的容量限制,后跟 Gi (GB)。 示例:4Gi。

--memory-request

以整数表示的托管实例的容量请求,后跟 Gi (GB)。 示例:4Gi。

--no-wait

如果给定,该命令不会等待实例处于就绪状态再返回。

默认值: False
--path

指向 SQL 托管实例 json 文件的 azext_arcdata 文件的路径。

--resource-group -g

已启用 Arc SQL 托管实例的 Azure 资源组。

--retention-days

备份保留期,以天为单位指定。 允许的值为 0 到 35。 默认值为 7。 将保留期设置为 0 将关闭 SQL 托管实例上所有数据库的自动备份,并且将删除任何以前的备份。

--service-annotations

要应用于所有外部服务的注释的逗号分隔列表。

--service-labels

要应用于所有外部服务的标签的逗号分隔列表。

--tag-name

SQL 托管实例的标记名称。

--tag-value

SQL 托管实例的标记值。

--tier -t

新实例的定价层。 允许的值:BusinessCritical(简称为 bc)或 GeneralPurpose(简称为 gp)。 默认值为 GeneralPurpose。

--time-zone

实例的 SQL Server 时区。

--trace-flags

以逗号分隔的跟踪标志列表。 默认情况下没有标志。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc get-mirroring-cert

从 sql mi 检索可用性组镜像终结点的证书,并存储在文件中。

az sql mi-arc get-mirroring-cert --cert-file
                                 --name
                                 [--k8s-namespace]
                                 [--use-k8s]

示例

从 sqlmi1 检索可用性组镜像终结点的证书,并存储在文件 fileName1 中

az sql mi-arc get-mirroring-cert -n sqlmi1 --cert-file fileName1

必需参数

--cert-file

用于以 PEM 格式存储检索到的证书的本地文件名。

--name -n

SQL 托管实例的名称。

可选参数

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc list

列出 SQL 托管实例。

az sql mi-arc list [--custom-location]
                   [--k8s-namespace]
                   [--resource-group]
                   [--use-k8s]

示例

列出 SQL 托管实例。

az sql mi-arc list --use-k8s

可选参数

--custom-location

在其中部署已启用 Arc 的SQL 托管实例的自定义位置。 如果未指定,则会列出资源组中的所有实例。

--k8s-namespace -k

包含已启用 Arc 的 SQL 托管实例的 Kubernetes 命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--resource-group -g

包含已启用 Arc 的SQL 托管实例的 Azure 资源组。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc reprovision-replica

在 SQL 托管实例中重新预配副本 (replica)。

az sql mi-arc reprovision-replica --name
                                  [--k8s-namespace]
                                  [--no-wait]
                                  [--use-k8s]

示例

前 1 - 重新预配 SQL 托管实例 sqlmi1 副本 (replica) 1。

az sql mi-arc reprovision-replica -n sqlmi1-1 --use-k8s --k8s-namespace namespace

必需参数

--name -n

要重新预配的 SQL 托管实例的名称副本 (replica)。

可选参数

--k8s-namespace -k

部署 SQL 托管实例副本 (replica)的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--use-k8s

使用本地 Kubernetes API 副本 (replica)重新预配 SQL 托管实例。

全局参数
--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 sql mi-arc show

显示 SQL 托管实例的详细信息。

az sql mi-arc show --name
                   [--k8s-namespace]
                   [--path]
                   [--resource-group]
                   [--use-k8s]

示例

使用 Kubernetes API 显示SQL 托管实例的详细信息。

az sql mi-arc show --name sqlmi1 --k8s-namespace arc --use-k8s

通过查询 Azure 资源管理器(ARM)来显示SQL 托管实例的详细信息。

az sql mi-arc show --name sqlmi1 --resource-group rg-name

必需参数

--name -n

要显示的 SQL 托管实例的名称。

可选参数

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--path -p

应将 SQL 托管实例的完整规范写入到的路径。 如果省略,则会将规范写入标准输出。

--resource-group -g

已启用 Arc SQL 托管实例的 Azure 资源组。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc update

更新 SQL 托管实例的配置。

az sql mi-arc update --name
                     [--ad-encryption-types]
                     [--agent-enabled]
                     [--annotations]
                     [--cert-private-key-file]
                     [--cert-public-key-file]
                     [--cores-limit]
                     [--cores-request]
                     [--k8s-namespace]
                     [--keytab-secret]
                     [--labels]
                     [--license-type]
                     [--memory-limit]
                     [--memory-request]
                     [--no-wait]
                     [--orchestrator-replicas]
                     [--path]
                     [--preferred-primary-replica]
                     [--readable-secondaries]
                     [--replicas {1, 2, 3}]
                     [--resource-group]
                     [--retention-days]
                     [--service-annotations]
                     [--service-cert-secret]
                     [--service-labels]
                     [--sync-secondary-to-commit {-1, 0, 1, 2}]
                     [--tde-mode]
                     [--tde-protector-private-key-file]
                     [--tde-protector-public-key-file]
                     [--tde-protector-secret]
                     [--tier]
                     [--time-zone]
                     [--trace-flags]
                     [--use-k8s]

示例

更新 SQL 托管实例的配置。

az sql mi-arc update --path ./spec.json -n sqlmi1 --use-k8s

必需参数

--name -n

正在编辑的 SQL 托管实例的名称。 不能更改部署实例时为其指定的名称。

可选参数

--ad-encryption-types

支持的 Active Directory 加密类型的逗号分隔列表。 必须是以下值的子集:RC4、AES128、AES256。

--agent-enabled

为实例启用 SQL Server 代理。 默认为禁用。

--annotations

SQL 托管实例注释的逗号分隔列表。

--cert-private-key-file

包含用于 SQL Server 的 PEM 格式证书私钥的文件路径。

--cert-public-key-file

包含用于 SQL Server 的 PEM 格式证书公钥的文件路径。

--cores-limit -c

托管实例的核心限制(整数)。

--cores-request

对托管实例核心(整数)的请求。

--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--keytab-secret

Kubernetes 机密的名称,其中包含此已启用 Arc 的 SQL 托管实例的 keytab 文件。

--labels

SQL 托管实例标签的逗号分隔列表。

--license-type -l

要应用于此托管实例的许可证类型允许值为:BasePrice、LicenseIncluded、DisasterRecovery.Default 为 LicenseIncluded。 可以更改许可证类型。

--memory-limit -m

以整数表示的托管实例的容量限制,后跟 Gi (GB)。 示例:4Gi。

--memory-request

以整数表示的托管实例的容量请求,后跟 Gi (GB)。 示例:4Gi。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--orchestrator-replicas

高可用性业务流程协调程序副本 (replica)数。 值必须介于 1 和 3 之间。

--path

指向 SQL 托管实例 json 文件的 azext_arcdata 文件的路径。

--preferred-primary-replica

要更新的首选主副本 (replica)。

--readable-secondaries

要进行可读的副本 (replica)数。 仅适用于业务关键层。 值必须介于 0 和副本 (replica)减 1 的数目之间。

--replicas

此选项指定将部署在 Kubernetes 群集中以实现高可用性的SQL 托管实例 副本 (replica)数。

接受的值: 1, 2, 3
--resource-group -g

已启用 Arc SQL 托管实例的 Azure 资源组。

--retention-days

备份保留期,以天为单位指定。 允许的值为 0 到 35。 默认值为 7。 将保留期设置为 0 将关闭 SQL 托管实例上所有数据库的自动备份,并且将删除任何以前的备份。

--service-annotations

要应用于所有外部服务的注释的逗号分隔列表。

--service-cert-secret

要生成的用于托管或将托管 SQL 服务证书的 Kubernetes 机密的名称。

--service-labels

要应用于所有外部服务的标签的逗号分隔列表。

--sync-secondary-to-commit

必须同步到提交的辅助副本 (replica)数。 将此值设置为 -1 会将所需的同步辅助数据库数设置为“(#of 副本 (replica)s - 1) / 2”,向下舍入。

接受的值: -1, 0, 1, 2
--tde-mode

此已启用 Arc 的SQL 托管实例的 透明数据加密 (TDE) 模式。 允许的值:ServiceManaged、CustomerManaged 或 Disabled。 默认值为 Disabled。

--tde-protector-private-key-file

包含要用于 TDE 的 PEM 格式证书私钥的文件的路径。

--tde-protector-public-key-file

包含要用于 TDE 的 PEM 格式证书公钥的文件的路径。

--tde-protector-secret

包含此已启用 Arc 的 TDE 保护程序证书和私钥的 Kubernetes 机密的名称SQL 托管实例。 只能为 CustomerManaged TDE 模式指定。

--tier -t

新实例的定价层。 允许的值:BusinessCritical(简称为 bc)或 GeneralPurpose(简称为 gp)。 默认值为 GeneralPurpose。

--time-zone

实例的 SQL Server 时区。

--trace-flags

以逗号分隔的跟踪标志列表。 默认情况下没有标志。

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 sql mi-arc upgrade

升级 SQL 托管实例。

将 SQL 托管实例升级到指定的所需版本。 如果未指定所需版本,将使用数据控制器版本。

az sql mi-arc upgrade [--desired-version]
                      [--dry-run]
                      [--field-filter]
                      [--force]
                      [--k8s-namespace]
                      [--label-filter]
                      [--name]
                      [--no-wait]
                      [--resource-group]
                      [--target]
                      [--use-k8s]

示例

升级 SQL 托管实例。

az sql mi-arc upgrade -n sqlmi1 -k arc --desired-version v1.1.0 --use-k8s

可选参数

--desired-version -v

要升级到的最新有效版本。 (可选)如果未指定版本,将使用数据控制器版本。 指定“auto”以自动升级到最新的有效版本。 在以下位置了解有关自动升级的详细信息: https://aka.ms/arc-sqlmi-auto-upgrade

--dry-run -d

指示将升级哪个实例,但实际上不会升级实例。

--field-filter -f

筛选以根据资源属性选择要升级的实例。

--force

重写可能应用于实例的所有策略,并尝试升级。

默认值: False
--k8s-namespace -k

要部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。

--label-filter -l

筛选以根据标签选择要升级的实例。

--name -n

SQL 托管实例的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

已启用 Arc 的目标SQL 托管实例所在的 Azure 资源组。

--target
已放弃

选项“--target”已弃用,将在将来的版本中删除。 请改用“--desired-version”。

要升级到的最新有效版本。 (可选)如果未指定版本,将使用数据控制器版本。 指定“auto”以自动升级到最新的有效版本。 在以下位置了解有关自动升级的详细信息: https://aka.ms/arc-sqlmi-auto-upgrade

--use-k8s

使用本地 Kubernetes API 来执行此操作。

全局参数
--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 获取完整的调试日志。