az postgres server-arc

预览
参考

注释

此参考是 Azure CLI（版本 2.3.1 或更高版本）的 arcdata 扩展的一部分。该扩展将在首次运行 az postgres server-arc 命令时自动安装。了解更多关于扩展的相关信息。

此命令组处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

管理已启用 Azure Arc 的 PostgreSQL 服务器。

命令

名称	说明	类型	Status
az postgres server-arc create	创建已启用 Azure Arc 的 PostgreSQL 服务器。	扩展	预览
az postgres server-arc delete	删除已启用 Azure Arc 的 PostgreSQL 服务器。	扩展	预览
az postgres server-arc endpoint	管理已启用 Azure Arc 的 PostgreSQL 服务器终结点。	扩展	预览
az postgres server-arc endpoint list	列出已启用 Azure Arc 的 PostgreSQL 服务器终结点。	扩展	预览
az postgres server-arc list	列出已启用 Azure Arc 的 PostgreSQL 服务器。	扩展	预览
az postgres server-arc restore	从另一台服务器的备份还原已启用 Azure Arc 的 PostgreSQL 服务器。	扩展	预览
az postgres server-arc show	显示已启用 Azure Arc 的 PostgreSQL 服务器的详细信息。	扩展	预览
az postgres server-arc update	更新已启用 Azure Arc 的 PostgreSQL 服务器的配置。	扩展	预览

az postgres server-arc create

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

创建已启用 Azure Arc 的 PostgreSQL 服务器。

若要设置服务器的密码，请AZDATA_PASSWORD设置环境变量。

az postgres server-arc create --name
                              [--ad-account-name]
                              [--ad-connector-name]
                              [--admin-login-secret]
                              [--cert-private-key-file]
                              [--cert-public-key-file]
                              [--cores-limit]
                              [--cores-request]
                              [--dev]
                              [--dns-name]
                              [--extensions]
                              [--k8s-namespace]
                              [--keytab-secret]
                              [--log-level]
                              [--memory-limit]
                              [--memory-request]
                              [--no-external-endpoint]
                              [--no-wait]
                              [--path]
                              [--port]
                              [--retention-days]
                              [--service-annotations]
                              [--service-cert-secret]
                              [--service-labels]
                              [--service-type]
                              [--storage-class-backups]
                              [--storage-class-data]
                              [--storage-class-logs]
                              [--use-k8s]
                              [--volume-size-backups]
                              [--volume-size-data]
                              [--volume-size-logs]

示例

创建已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc create -n pg1 --k8s-namespace namespace --use-k8s

必需参数

--name -n

已启用 Azure Arc 的 PostgreSQL 服务器的名称。

可选参数

--ad-account-name

此已启用 Azure Arc 的 PostgreSQL 服务器的 Active Directory 帐户名称。此帐户需要在部署此实例之前创建。

--ad-connector-name

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

--admin-login-secret

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

--cert-private-key-file

包含要用于客户端 SSL 连接的 PEM 格式证书私钥的文件的路径。

--cert-public-key-file

包含要用于客户端 SSL 连接的 PEM 格式证书公钥的文件的路径。

--cores-limit

可用于已启用 Azure Arc 的 PostgreSQL 服务器的最大 CPU 核心数。

--cores-request

每个节点必须可用的最小 CPU 核心数才能计划服务。

--dev

如果指定了此项，则会将其视为开发实例，不会为其计费。

--dns-name

向最终用户公开的服务 DNS 名称，以连接到已启用 Azure Arc 的 PostgreSQL 服务器（例如 pginstancename.contoso.com）。

--extensions

要启用的扩展的逗号分隔列表。启用后，可以通过“CREATE EXTENSION”命令安装扩展。

--k8s-namespace -k

部署已启用 Azure Arc 的 PostgreSQL 服务器的 Kubernetes 命名空间。若未指定命名空间，则将使用 kubeconfig 中定义的命名空间。

--keytab-secret

包含此已启用 Azure Arc 的 PostgreSQL 服务器的 keytab 文件的 Kubernetes 机密的名称。

--log-level

设置 PostgreSQL 引擎的log_min_messages设置。有效值为：DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING、ERROR、LOG、FATAL、PANIC。

--memory-limit

已启用 Azure Arc 的 PostgreSQL 服务器的内存限制，后跟 Ki（千字节）、Mi（兆字节）或 Gi（GB）。

--memory-request

已启用 Azure Arc 的 PostgreSQL 服务器的内存请求，后跟 Ki（千字节）、Mi（兆字节）或 Gi（GB）。

--no-external-endpoint

如果指定，则不会创建外部服务。否则，将使用提供 --service-type 参数的类型或与数据控制器相同的服务类型创建外部服务。

--no-wait

不要等待部署在返回之前准备就绪。

默认值: False

--path

已启用 Azure Arc 的 PostgreSQL 服务器的源 json 文件的路径。这是可选的。

--port

主服务向最终用户公开的端口号。

--retention-days

备份保留期，以天为单位指定。允许的值为 0 到 35。默认值为 7。将保留期设置为 0 将关闭已启用 Azure Arc 的 PostgreSql 的自动备份。

--service-annotations

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

--service-cert-secret

用于生成托管 SSL 证书的 Kubernetes 机密的名称。

--service-labels

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

--service-type

主服务的类型。

--storage-class-backups

要用于备份永久性卷的存储类。

--storage-class-data

要用于数据永久性卷的存储类。

--storage-class-logs

要用于日志永久性卷的存储类。

--use-k8s

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

--volume-size-backups

要用于备份的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

--volume-size-data

要用于数据的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

--volume-size-logs

要用作日志的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

全局参数

--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 postgres server-arc delete

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

删除已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc delete --name
                              [--force]
                              [--k8s-namespace]
                              [--use-k8s]

示例

删除已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc delete -n pg1 --k8s-namespace namespace --use-k8s

必需参数

--name -n

已启用 Azure Arc 的 PostgreSQL 服务器的名称。

可选参数

--force -f

在不确认的情况下删除已启用 Azure Arc 的 PostgreSQL 服务器。

默认值: False

--k8s-namespace -k

部署已启用 Azure Arc 的 PostgreSQL 服务器的 Kubernetes 命名空间。若未指定命名空间，则将使用 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 postgres server-arc list

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

列出已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc list [--k8s-namespace]
                            [--use-k8s]

示例

列出已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc list --k8s-namespace namespace --use-k8s

可选参数

--k8s-namespace -k

部署已启用 Azure Arc 的 PostgreSQL 服务器的 Kubernetes 命名空间。若未指定命名空间，则将使用 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 postgres server-arc restore

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

从另一台服务器的备份还原已启用 Azure Arc 的 PostgreSQL 服务器。

若要设置服务器的密码，请AZDATA_PASSWORD设置环境变量。

az postgres server-arc restore --k8s-namespace
                               --name
                               --source-server
                               [--dry-run]
                               [--no-wait]
                               [--storage-class-backups]
                               [--storage-class-data]
                               [--storage-class-logs]
                               [--time]
                               [--use-k8s]
                               [--volume-size-backups]
                               [--volume-size-data]
                               [--volume-size-logs]

示例

还原已启用 Azure Arc 的 PostgreSQL 服务器。

az postgres server-arc restore -n <to-pg> --source-server <from-pg> --k8s-namespace namespace --use-k8s

必需参数

--k8s-namespace -k

包含已启用 Azure Arc 的 PostgreSql 的 Kubernetes 命名空间。若未指定命名空间，则将使用 kubeconfig 中定义的命名空间。

--name -n

要创建的已启用 Azure Arc 的 PostgreSQL 服务器的名称。

--source-server

要从中还原的已启用 Azure Arc 的 PostgreSQL 服务器的名称。

可选参数

--dry-run

如果设置，则验证源资源和目标资源和时间，而不执行还原。在还原任务的状态中返回最早和最新的可能还原时间。

默认值: False

--no-wait

不要等待部署在返回之前准备就绪。

默认值: False

--storage-class-backups

要用于备份永久性卷的存储类。

--storage-class-data

要用于数据永久性卷的存储类。

--storage-class-logs

要用于日志永久性卷的存储类。

--time -t

将还原以创建新的已启用 Azure Arc 的 PostgreSQL 服务器的源服务器的时间点。必须大于或等于源数据库的最早还原日期/时间值。时间应采用以下格式：“YYYY-MM-DDTHH：MM：SSZ”。如果未提供任何时间，将还原最新的备份。

--use-k8s

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

--volume-size-backups

要用于备份的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

--volume-size-data

要用于数据的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

--volume-size-logs

要用作日志的存储卷的大小为正数，后跟 Ki（千字节）、Mi（兆字节）或 Gi（千兆字节）。

全局参数

--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 postgres server-arc show

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

显示已启用 Azure Arc 的 PostgreSQL 服务器的详细信息。

az postgres server-arc show --name
                            [--k8s-namespace]
                            [--path]
                            [--use-k8s]

示例

显示已启用 Azure Arc 的 PostgreSQL 服务器的详细信息。

az postgres server-arc show -n pg1 --k8s-namespace namespace --use-k8s

必需参数

--name -n

已启用 Azure Arc 的 PostgreSQL 服务器的名称。

可选参数

--k8s-namespace -k

部署已启用 Azure Arc 的 PostgreSQL 服务器的 Kubernetes 命名空间。若未指定命名空间，则将使用 kubeconfig 中定义的命名空间。

--path

应写入已启用 Azure Arc 的 PostgreSQL 服务器的完整规范的路径。如果省略，规范将写入标准输出。

--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 postgres server-arc update

预览

命令组“postgres server-arc”处于预览状态，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

更新已启用 Azure Arc 的 PostgreSQL 服务器的配置。

az postgres server-arc update --name
                              [--cert-private-key-file]
                              [--cert-public-key-file]
                              [--cores-limit]
                              [--cores-request]
                              [--dev]
                              [--extensions]
                              [--k8s-namespace]
                              [--keytab-secret]
                              [--log-level]
                              [--memory-limit]
                              [--memory-request]
                              [--no-external-endpoint]
                              [--no-wait]
                              [--path]
                              [--port]
                              [--retention-days]
                              [--service-annotations]
                              [--service-cert-secret]
                              [--service-labels]
                              [--service-type]
                              [--use-k8s]

示例

更新已启用 Azure Arc 的 PostgreSQL 服务器的配置。

az postgres server-arc update --path ./spec.json -n pg1 --k8s-namespace namespace --use-k8s

为已启用 Azure Arc 的现有 PostgreSQL 服务器启用扩展。

az postgres server-arc update -n pg1 --extensions 'pgaudit,pg_partman' --k8s-namespace namespace --use-k8s

从已启用 Azure Arc 的 PostgreSQL 服务器中删除扩展。

az postgres server-arc update -n pg1 --extensions "''" --k8s-namespace namespace --use-k8s

必需参数

--name -n

正在更新的已启用 Azure Arc 的 PostgreSQL 服务器的名称。无法更改部署实例的名称。

可选参数

--cert-private-key-file

包含要用于客户端 SSL 连接的 PEM 格式证书私钥的文件的路径。

--cert-public-key-file

包含要用于客户端 SSL 连接的 PEM 格式证书公钥的文件的路径。

--cores-limit

已启用 Azure Arc 的 PostgreSQL 服务器的最大 CPU 核心数，可用于每个节点。若要删除cores_limit，请将其值指定为空字符串。

--cores-request

每个节点必须可用的最小 CPU 核心数才能计划服务。若要删除cores_request，请将其值指定为空字符串。

--dev

如果指定了此项，则会将其视为开发实例，不会为其计费。

--extensions

要启用的扩展的逗号分隔列表。添加或删除新扩展，请更新现有扩展列表。启用后，可以通过“CREATE EXTENSION”命令安装扩展。

--k8s-namespace -k

部署已启用 Azure Arc 的 PostgreSQL 服务器的 Kubernetes 命名空间。若未指定命名空间，则将使用 kubeconfig 中定义的命名空间。

--keytab-secret

包含此已启用 Azure Arc 的 PostgreSQL 服务器的 keytab 文件的 Kubernetes 机密的名称。

--log-level

设置 PostgreSQL 引擎的log_min_messages设置。有效值为：DEBUG5、DEBUG4、DEBUG3、DEBUG2、DEBUG1、INFO、NOTICE、WARNING、ERROR、LOG、FATAL、PANIC。

--memory-limit

已启用 Azure Arc 的 PostgreSQL 服务器的内存限制，后跟 Ki（千字节）、Mi（兆字节）或 Gi（GB）。若要删除memory_limit，请将其值指定为空字符串。

--memory-request

已启用 Azure Arc 的 PostgreSQL 服务器的内存请求，后跟 Ki（千字节）、Mi（兆字节）或 Gi（GB）。若要删除memory_request，请将其值指定为空字符串。

--no-external-endpoint

如果指定，则不会创建外部服务。否则，将使用提供 --service-type 参数的类型或与数据控制器相同的服务类型创建外部服务。

--no-wait

不要等待部署在返回之前准备就绪。

默认值: False

--path

已启用 Azure Arc 的 PostgreSQL 服务器的源 json 文件的路径。这是可选的。

--port

主服务向最终用户公开的端口号。

--retention-days

备份保留期，以天为单位指定。允许的值为 0 到 35。默认值为 7。将保留期设置为 0 将关闭已启用 Azure Arc 的 PostgreSql 的自动备份。

--service-annotations

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

--service-cert-secret

用于生成托管 SSL 证书的 Kubernetes 机密的名称。

--service-labels

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

--service-type

主服务的类型。

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