az sql mi-arc

  • 參考

注意

此參考是 Azure CLI 的 arcdata 延伸模組的一部分 （2.3.1 版或更高版本）。 擴充功能會在您第一次執行 az sql mi-arc 命令時自動安裝。 深入了解擴充功能。

管理已啟用 Azure Arc 的 SQL 受控實例。

命令

名稱 Description 類型 狀態
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 受控實例中重新布建複本。

 擴充 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 個複本的 SQL 受控實例。

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

透過 Azure Resource Manager 建立 SQL 受控實例（ARM）。

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 的 Active Directory 帳戶名稱SQL 受管理執行個體。 此帳戶必須在部署此實例之前建立。

--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 受管理執行個體。

--labels

SQL 受控實例的標籤逗號分隔清單。

--language

實例的任何支援語言識別項 （LCID） 的 SQL Server 地區設定。

--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

高可用性協調器複本的數目。 值必須介於 1 到 3 之間。

--path

SQL 受控實例 json 檔案azext_arcdata檔案的路徑。

--primary-dns-name

公開給使用者的主要服務 DNS 名稱，以連線到已啟用 Arc 的SQL 受管理執行個體（例如 sqlinstancename.contoso.com）。

--primary-port-number

主要服務公開給終端使用者的埠號碼（例如 31433）。

--readable-secondaries

要成為可讀取的複本數目。 僅適用于業務關鍵層。 值必須介於 0 和複本數目減 1 之間。

--replicas

此選項會指定將在 Kubernetes 叢集中部署以供高可用性之用的SQL 受管理執行個體複本數目。 預設值為一般用途的 1 個複本，業務關鍵 3 個複本。

接受的值: 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

必須同步處理才能認可的次要複本數目。 將此值設定為 -1 會將所需的同步次要複本數目設定為 '（#of replicas - 1） / 2'，四捨五入。

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

此已啟用 Arc 的透明資料加密 （TDE） 模式SQL 受管理執行個體。 允許的值：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 for short） 或 GeneralPurpose （gp for short）。 預設值為 GeneralPurpose。

--time-zone

實例的 SQL Server 時區。

--trace-flags

以逗號分隔的追蹤旗標清單。 預設不會有任何旗標。

--use-k8s

使用本機 Kubernetes API 建立 SQL 受控實例。

--volume-size-backups

要用於備份的儲存體磁片區大小為正數，後面接著 Ki （KB）、Mi （MB）或 Gi （GB）。

--volume-size-data

要作為正數的資料使用的儲存磁片區大小，後面接著 Ki （KB）、Mi （MB）或 Gi （GB）。

--volume-size-datalogs

要用於資料記錄的儲存體磁片區大小為正數，後面接著 Ki （KB）、Mi （MB）或 Gi （GB）。

--volume-size-logs

要用於記錄的儲存體磁片區大小為正數，後面接著 Ki （KB）、Mi （MB）或 Gi （GB）。

--volume-size-orchestrator-logs

要用於協調器記錄的儲存體磁片區大小為正數，後面接著 Ki （KB）、Mi （MB）或 Gi （GB）。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 Resource Manager 刪除 SQL 受控實例（ARM）。

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 的 Azure 資源群組SQL 受管理執行個體存在。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 的 Azure 資源群組SQL 受管理執行個體存在。

--retention-days

備份保留期限，以天為單位指定。 允許的值為 0 到 35。 預設值為 7。 將保留期間設定為 0 將會關閉 SQL 受控實例上所有資料庫的自動備份，而且將會刪除任何先前的備份。

--service-annotations

要套用至所有外部服務的以逗號分隔的批註清單。

--service-labels

要套用至所有外部服務的標籤逗號分隔清單。

--tag-name

SQL 受控實例的標籤名稱。

--tag-value

SQL 受控實例的標籤值。

--tier -t

實例的定價層。 允許的值：BusinessCritical （bc for short） 或 GeneralPurpose （gp for short）。 預設值為 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

Kubernetes 命名空間，其中包含已啟用 Arc 的SQL 受管理執行個體。 如果未指定任何命名空間，則會使用 kubeconfig 中定義的命名空間。

--resource-group -g

包含已啟用 Arc 的 Azure 資源群組SQL 受管理執行個體。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

必要參數

--name -n

要重新布建的 SQL 受控實例複本名稱。

選擇性參數

--k8s-namespace -k

部署 SQL 受控實例複本的命名空間。 如果未指定任何命名空間，則會使用 kubeconfig 中定義的命名空間。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--use-k8s

使用本機 Kubernetes API 重新布建 SQL 受控實例複本。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 Resource Manager （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 的 Azure 資源群組SQL 受管理執行個體存在。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 受管理執行個體。

--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

高可用性協調器複本的數目。 值必須介於 1 到 3 之間。

--path

SQL 受控實例 json 檔案azext_arcdata檔案的路徑。

--preferred-primary-replica

要更新的慣用主要複本。

--readable-secondaries

要成為可讀取的複本數目。 僅適用于業務關鍵層。 值必須介於 0 和複本數目減 1 之間。

--replicas

此選項會指定將在 Kubernetes 叢集中部署以供高可用性之用的SQL 受管理執行個體複本數目。

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

已啟用 Arc 的 Azure 資源群組SQL 受管理執行個體存在。

--retention-days

備份保留期限，以天為單位指定。 允許的值為 0 到 35。 預設值為 7。 將保留期間設定為 0 將會關閉 SQL 受控實例上所有資料庫的自動備份，而且將會刪除任何先前的備份。

--service-annotations

要套用至所有外部服務的以逗號分隔的批註清單。

--service-cert-secret

產生該主機或將裝載 SQL 服務憑證的 Kubernetes 秘密名稱。

--service-labels

要套用至所有外部服務的標籤逗號分隔清單。

--sync-secondary-to-commit

必須同步處理才能認可的次要複本數目。 將此值設定為 -1 會將所需的同步次要複本數目設定為 '（#of replicas - 1） / 2'，四捨五入。

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

此已啟用 Arc 的透明資料加密 （TDE） 模式SQL 受管理執行個體。 允許的值：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 for short） 或 GeneralPurpose （gp for short）。 預設值為 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az sql mi-arc upgrade

升級 SQL 受控實例。

將 SQL 受控實例升級至指定的所需版本。 如果未指定 desired-version，將會使用資料控制站版本。

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 的 Azure 資源群組SQL 受管理執行個體存在。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。