az sql mi-arc
注释
此参考是 Azure CLI(版本 2.3.1 或更高版本)的 arcdata 扩展的一部分。 该扩展会在首次运行 az sql mi-arc 命令时自动安装。 了解更多关于扩展 的相关信息。
管理已启用 Azure Arc 的 SQL 托管实例。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
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 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 托管实例中重新预配副本。 |
扩展 | 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]
[--private-key-file]
[--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 个副本的 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
必需参数
SQL 托管实例的名称。
可选参数
此已启用 Arc 的 SQL 托管实例的 Active Directory 帐户名称。 此帐户需要在部署此实例之前创建。
Active Directory 连接器的名称。 此参数指示使用 AD 支持进行部署的意向。
支持的 Active Directory 加密类型的逗号分隔列表。 必须是以下值的子集:RC4、AES128、AES256。
用于生成该主机的 Kubernetes 机密的名称,或将托管用户管理员登录帐户凭据。
为实例启用 SQL Server 代理。 默认处于禁用状态。 允许的值为“true”或“false”。
SQL 托管实例的批注的逗号分隔列表。
包含要用于 SQL Server 的 PEM 格式证书私钥的文件的路径。
包含要用于 SQL Server 的 PEM 格式证书公钥的文件的路径。
实例的 SQL Server 排序规则。
托管实例的核心限制为整数。
作为整数的托管实例核心的请求。
此实例的自定义位置。
如果指定了此项,则会将其视为开发实例,不会为其计费。
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
包含此已启用 Arc 的 SQL 托管实例的 keytab 文件的 Kubernetes 机密的名称。
SQL 托管实例的标签的逗号分隔列表。
实例的任何受支持的语言标识符(LCID)的 SQL Server 区域设置。
要应用于此托管实例的许可证类型允许值为:BasePrice、LicenseIncluded、DisasterRecovery.Default 为 LicenseIncluded。 可以更改许可证类型。
作为整数数的托管实例容量限制,后跟 Gi(GB)。 示例:4Gi。
将托管实例的容量请求作为整数号,后跟 Gi(GB)。 示例:4Gi。
如果指定,则不会创建外部服务。 否则,将使用与数据控制器相同的服务类型创建外部服务。
不等待长时间运行的操作完成。
高可用性业务流程协调程序副本数。 值必须介于 1 和 3 之间。
SQL 托管实例 json 文件的 azext_arcdata 文件的路径。
向最终用户公开的主服务 DNS 名称,以连接到此已启用 Arc 的 SQL 托管实例(例如 sqlinstancename.contoso.com)。
主服务向最终用户公开的端口号(例如 31433)。
openSSL 生成的私钥文件用作实例 ID。
要进行可读的副本数。 仅适用于业务关键层。 值必须介于 0 和副本数减 1 之间。
此选项指定将在 Kubernetes 群集中部署以实现高可用性的 SQL 托管实例副本数。 对于常规用途,默认值为 1 个副本,业务关键副本为 3 个副本。
应向其添加已启用 Arc 的 SQL 托管实例的 Azure 资源组。
备份保留期,以天为单位指定。 允许的值为 0 到 35。 默认值为 7。 将保留期设置为 0 将关闭 SQL 托管实例上所有数据库的自动备份,并且将删除任何以前的备份。
向最终用户公开的辅助服务 DNS 名称,以连接到此已启用 Arc 的 SQL 托管实例(例如 sqlinstancename2.contoso.com)。
辅助服务向最终用户公开的端口号(例如 31434)。
要应用于所有外部服务的批注的逗号分隔列表。
用于生成该主机或将托管 SQL 服务证书的 Kubernetes 机密的名称。
要应用于所有外部服务的标签的逗号分隔列表。
主服务的类型。
要应用于所有 PVC 的批注的逗号分隔列表。
支持 ReadWriteMany (RWX) 的存储类用于备份(/var/opt/mssql/backups)。 如果未指定任何值,将使用默认存储类。
要用于数据文件的存储类(.mdf,.ndf)。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。
要用于数据库日志(.ldf)的存储类。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。
要用于日志(/var/log)的存储类。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。
要用于业务流程协调程序日志(/var/log)的存储类。 如果未指定任何值,则不会指定存储类,这将导致 Kubernetes 使用默认存储类。
要应用于所有 PVC 的标签的逗号分隔列表。
必须同步才能提交的次要副本数。 将此值设置为 -1 会将所需的同步辅助数据库数设置为“(副本数 - 1) / 2”,向下舍入。
此已启用 Arc 的 SQL 托管实例的透明数据加密 (TDE) 模式。 允许的值:ServiceManaged、CustomerManaged 或 Disabled。 默认值为 Disabled。
包含要用于 TDE 的 PEM 格式证书私钥的文件的路径。
包含要用于 TDE 的 PEM 格式证书公钥的文件的路径。
包含此已启用 Arc 的 SQL 托管实例的 TDE 保护程序证书和私钥的 Kubernetes 机密的名称。 只能为 CustomerManaged TDE 模式指定。
实例的定价层。 允许的值:BusinessCritical (bc for short)或 GeneralPurpose (gp for short)。 默认值为 GeneralPurpose。
实例的 SQL Server 时区。
跟踪标志的逗号分隔列表。 默认情况下不标记。
使用本地 Kubernetes API 创建 SQL 托管实例。
要用于备份的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(千兆字节)。
要用于数据的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(千兆字节)。
要用于数据日志的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(GB)。
要用作日志的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(千兆字节)。
要用于业务流程协调程序日志的存储卷的大小为正数,后跟 Ki(千字节)、Mi(兆字节)或 Gi(GB)。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
必需参数
要删除的 SQL 托管实例的名称。
可选参数
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
不等待长时间运行的操作完成。
已启用 Arc 的 SQL 托管实例所在的 Azure 资源组。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
必需参数
要以 PEM 格式存储检索的证书的本地文件名。
SQL 托管实例的名称。
可选参数
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
可选参数
在其中部署已启用 Arc 的 SQL 托管实例的自定义位置。 如果未指定,则会列出资源组中的所有实例。
包含已启用 Arc 的 SQL 托管实例的 Kubernetes 命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
包含已启用 Arc 的 SQL 托管实例的 Azure 资源组。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sql mi-arc reprovision-replica
在 SQL 托管实例中重新预配副本。
az sql mi-arc reprovision-replica --name
[--k8s-namespace]
[--no-wait]
[--use-k8s]
示例
前 1 - 重新预配 SQL 托管实例 sqlmi1 的副本 1。
az sql mi-arc reprovision-replica -n sqlmi1-1 --use-k8s --k8s-namespace namespace
必需参数
要重新预配的 SQL 托管实例副本的名称。
可选参数
在其中部署 SQL 托管实例副本的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
不等待长时间运行的操作完成。
使用本地 Kubernetes API 重新预配 SQL 托管实例副本。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
必需参数
要显示的 SQL 托管实例的名称。
可选参数
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
应写入 SQL 托管实例的完整规范的路径。 如果省略,规范将写入标准输出。
已启用 Arc 的 SQL 托管实例所在的 Azure 资源组。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
必需参数
正在编辑的 SQL 托管实例的名称。 无法更改部署实例的名称。
可选参数
支持的 Active Directory 加密类型的逗号分隔列表。 必须是以下值的子集:RC4、AES128、AES256。
为实例启用 SQL Server 代理。 默认处于禁用状态。
SQL 托管实例的批注的逗号分隔列表。
包含要用于 SQL Server 的 PEM 格式证书私钥的文件的路径。
包含要用于 SQL Server 的 PEM 格式证书公钥的文件的路径。
托管实例的核心限制为整数。
作为整数的托管实例核心的请求。
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
包含此已启用 Arc 的 SQL 托管实例的 keytab 文件的 Kubernetes 机密的名称。
SQL 托管实例的标签的逗号分隔列表。
要应用于此托管实例的许可证类型允许值为:BasePrice、LicenseIncluded、DisasterRecovery.Default 为 LicenseIncluded。 可以更改许可证类型。
作为整数数的托管实例容量限制,后跟 Gi(GB)。 示例:4Gi。
将托管实例的容量请求作为整数号,后跟 Gi(GB)。 示例:4Gi。
不等待长时间运行的操作完成。
高可用性业务流程协调程序副本数。 值必须介于 1 和 3 之间。
SQL 托管实例 json 文件的 azext_arcdata 文件的路径。
要更新的首选主副本。
要进行可读的副本数。 仅适用于业务关键层。 值必须介于 0 和副本数减 1 之间。
此选项指定将在 Kubernetes 群集中部署以实现高可用性的 SQL 托管实例副本数。
已启用 Arc 的 SQL 托管实例所在的 Azure 资源组。
备份保留期,以天为单位指定。 允许的值为 0 到 35。 默认值为 7。 将保留期设置为 0 将关闭 SQL 托管实例上所有数据库的自动备份,并且将删除任何以前的备份。
要应用于所有外部服务的批注的逗号分隔列表。
用于生成该主机或将托管 SQL 服务证书的 Kubernetes 机密的名称。
要应用于所有外部服务的标签的逗号分隔列表。
必须同步才能提交的次要副本数。 将此值设置为 -1 会将所需的同步辅助数据库数设置为“(副本数 - 1) / 2”,向下舍入。
此已启用 Arc 的 SQL 托管实例的透明数据加密 (TDE) 模式。 允许的值:ServiceManaged、CustomerManaged 或 Disabled。 默认值为 Disabled。
包含要用于 TDE 的 PEM 格式证书私钥的文件的路径。
包含要用于 TDE 的 PEM 格式证书公钥的文件的路径。
包含此已启用 Arc 的 SQL 托管实例的 TDE 保护程序证书和私钥的 Kubernetes 机密的名称。 只能为 CustomerManaged TDE 模式指定。
实例的定价层。 允许的值:BusinessCritical (bc for short)或 GeneralPurpose (gp for short)。 默认值为 GeneralPurpose。
实例的 SQL Server 时区。
跟踪标志的逗号分隔列表。 默认情况下不标记。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --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
可选参数
要升级到的最新有效版本。 (可选)如果未指定版本,将使用数据控制器版本。 指定“auto”以自动升级到最新的有效版本。 在以下位置了解有关自动升级的详细信息:https://aka.ms/arc-sqlmi-auto-upgrade。
指示将升级哪个实例,但实际上不会升级实例。
筛选以根据资源属性选择要升级的实例。
重写可能应用于实例的所有策略,并尝试升级。
要在其中部署 SQL 托管实例的命名空间。 若未指定命名空间,则将使用 kubeconfig 中定义的命名空间。
筛选以根据标签选择要升级的实例。
SQL 托管实例的名称。
不等待长时间运行的操作完成。
目标已启用 Arc 的 SQL 托管实例所在的 Azure 资源组。
选项“--target”已弃用,将在将来的版本中删除。 请改用“--desired-version”。
要升级到的最新有效版本。 (可选)如果未指定版本,将使用数据控制器版本。 指定“auto”以自动升级到最新的有效版本。 在以下位置了解有关自动升级的详细信息:https://aka.ms/arc-sqlmi-auto-upgrade。
使用本地 Kubernetes API 来执行此操作。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。