az sql mi

リファレンス

SQL マネージドインスタンスを管理します。

コマンド

名前	説明	型	Status
az sql mi ad-admin	マネージドインスタンスの Active Directory 管理者を管理します。	コア	GA
az sql mi ad-admin create	新しいマネージドインスタンスの Active Directory 管理者を作成します。	コア	GA
az sql mi ad-admin delete	既存のマネージドインスタンス Active Directory 管理istrator を削除します。	コア	GA
az sql mi ad-admin list	マネージドインスタンスの Active Directory 管理istrator の一覧を返します。	コア	GA
az sql mi ad-admin update	既存のマネージドインスタンスの Active Directory 管理者を更新します。	コア	GA
az sql mi ad-only-auth	Managed Instance の Azure Active Directory のみの設定を管理します。	コア	GA
az sql mi ad-only-auth disable	このマネージドインスタンスに対して Azure Active Directory のみの認証を無効にします。	コア	GA
az sql mi ad-only-auth enable	このマネージドインスタンスに対して Azure Active Directory のみの認証を有効にします。	コア	GA
az sql mi ad-only-auth get	特定の Azure Active Directory のみの認証プロパティを取得します。	コア	GA
az sql mi advanced-threat-protection-setting	SQL Managed Instance の高度な脅威保護設定を管理します。	コア	GA
az sql mi advanced-threat-protection-setting show	高度な脅威保護設定を取得します。	コア	GA
az sql mi advanced-threat-protection-setting update	SQL Managed Instance の Advanced Threat Protection 設定を更新します。	コア	GA
az sql mi create	マネージドインスタンスを作成します。	コア	GA
az sql mi delete	マネージドインスタンスを削除します。	コア	GA
az sql mi dtc	マネージドインスタンスの DTC 管理に関連するコマンド。	コア	GA
az sql mi dtc show	マネージドインスタンスの DTC 設定を取得します。	コア	GA
az sql mi dtc update	マネージドインスタンスの DTC 設定を更新します。	コア	GA
az sql mi dtc wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az sql mi endpoint-cert	エンドポイント証明書管理コマンド。	コア	GA
az sql mi endpoint-cert list	ターゲットインスタンス上のエンドポイントで使用される証明書を一覧表示します。	コア	GA
az sql mi endpoint-cert show	指定された ID を持つエンドポイントで使用される証明書を取得します。	コア	GA
az sql mi failover	マネージドインスタンスをフェールオーバーします。	コア	GA
az sql mi key	SQL インスタンスのキーを管理します。	コア	GA
az sql mi key create	SQL インスタンスキーを作成します。	コア	GA
az sql mi key delete	SQL インスタンスキーを削除します。	コア	GA
az sql mi key list	マネージドインスタンスキーの一覧を取得します。	コア	GA
az sql mi key show	SQL インスタンスキーを表示します。	コア	GA
az sql mi link	インスタンスリンク管理コマンド。	コア	GA
az sql mi link create	新しいインスタンスリンクを作成します。	コア	GA
az sql mi link delete	インスタンスリンクを削除します。	コア	GA
az sql mi link list	Azure SQL Managed Instance のリンク機能に関する情報を返します。	コア	GA
az sql mi link show	Azure SQL Managed Instance のリンク機能に関する情報を返します。	コア	GA
az sql mi link update	インスタンスリンクのプロパティを更新します。	コア	GA
az sql mi list	使用可能なマネージドインスタンスを一覧表示します。	コア	GA
az sql mi op	マネージドインスタンスに対する操作を管理します。	コア	GA
az sql mi op cancel	マネージドインスタンスに対する非同期操作をキャンセルします。	コア	GA
az sql mi op list	マネージドインスタンス上で実行された操作の一覧を取得します。	コア	GA
az sql mi op show	マネージドインスタンスに対する管理操作を取得します。	コア	GA
az sql mi partner-cert	サーバー信頼証明書管理コマンド。	コア	GA
az sql mi partner-cert create	ボックスから Sql Managed Instance にサーバー信頼証明書をアップロードします。	コア	GA
az sql mi partner-cert delete	ボックスから Sql Managed Instance にアップロードされたサーバー信頼証明書を削除します。	コア	GA
az sql mi partner-cert list	ボックスから特定の Sql Managed Instance にアップロードされたサーバー信頼証明書の一覧を取得します。	コア	GA
az sql mi partner-cert show	ボックスから Sql Managed Instance にアップロードされたサーバー信頼証明書を取得します。	コア	GA
az sql mi refresh-external-governance-status	外部ガバナンスの有効化状態を更新します。	コア	GA
az sql mi server-configuration-option	サーバー構成オプション管理コマンド。	コア	GA
az sql mi server-configuration-option list	マネージドインスタンスサーバー構成オプションの一覧を表示します。	コア	GA
az sql mi server-configuration-option set	マネージドインスタンスサーバー構成オプションを設定します。	コア	GA
az sql mi server-configuration-option show	マネージドインスタンスサーバー構成オプションを取得します。	コア	GA
az sql mi server-configuration-option wait	条件が満たされるまで CLI を待機状態にします。	コア	GA
az sql mi show	マネージドインスタンスの詳細を取得します。	コア	GA
az sql mi start	マネージドインスタンスを起動します。	コア	GA
az sql mi start-stop-schedule	マネージドインスタンスの開始停止スケジュールを管理します。	コア	GA
az sql mi start-stop-schedule create	マネージドインスタンスの開始/停止スケジュールを作成します。	コア	GA
az sql mi start-stop-schedule delete	マネージドインスタンスの開始/停止スケジュールを削除します。	コア	GA
az sql mi start-stop-schedule list	マネージドインスタンスの開始/停止スケジュールを一覧表示します。	コア	GA
az sql mi start-stop-schedule show	マネージドインスタンスの開始/停止スケジュールを取得します。	コア	GA
az sql mi start-stop-schedule update	マネージドインスタンスの開始/停止スケジュールを更新します。	コア	GA
az sql mi stop	マネージドインスタンスを停止します。	コア	GA
az sql mi tde-key	SQL インスタンスの暗号化保護機能を管理します。	コア	GA
az sql mi tde-key set	SQL インスタンスの暗号化保護機能を設定します。	コア	GA
az sql mi tde-key show	サーバー暗号化保護機能を表示します。	コア	GA
az sql mi update	マネージドインスタンスを更新します。	コア	GA

az sql mi create

編集

マネージドインスタンスを作成します。

az sql mi create --name
                 --resource-group
                 --subnet
                 [--admin-password]
                 [--admin-user]
                 [--assign-identity]
                 [--backup-storage-redundancy]
                 [--capacity]
                 [--collation]
                 [--database-format {AlwaysUpToDate, SQLServer2022}]
                 [--edition]
                 [--enable-ad-only-auth]
                 [--external-admin-name]
                 [--external-admin-principal-type]
                 [--external-admin-sid]
                 [--family]
                 [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                 [--instance-pool-name]
                 [--key-id]
                 [--license-type {BasePrice, LicenseIncluded}]
                 [--location]
                 [--maint-config-id]
                 [--minimal-tls-version {1.0, 1.1, 1.2, None}]
                 [--no-wait]
                 [--pid]
                 [--pricing-model {Freemium, Regular}]
                 [--proxy-override {Default, Proxy, Redirect}]
                 [--public-data-endpoint-enabled {false, true}]
                 [--service-principal-type {None, SystemAssigned}]
                 [--storage]
                 [--tags]
                 [--timezone-id]
                 [--user-assigned-identity-id]
                 [--vnet-name]
                 [--yes]
                 [--zone-redundant {false, true}]

例

最小限のパラメーターセットでマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName}

指定されたパラメーターと ID を使用してマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --license-type LicenseIncluded --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --capacity 8 --storage 32GB --edition GeneralPurpose --family Gen5

指定されたパラメーターとタグを使用してマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --license-type LicenseIncluded --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --capacity 8 --storage 32GB --edition GeneralPurpose --family Gen5 --tags tagName1=tagValue1 tagName2=tagValue2

指定されたパラメーターとバックアップストレージの冗長性を指定してマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --license-type LicenseIncluded --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --capacity 8 --storage 32GB --edition GeneralPurpose --family Gen5 --backup-storage-redundancy Local

メインテナント構成でマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} -m SQL_{Region}_{MaintenanceConfigName}

サービスプリンシパルを有効にしてマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --service-principal-type SystemAssigned

AAD 管理者と AD のみを有効にして、SQL 管理なしでマネージドインスタンスを作成する

az sql mi create --enable-ad-only-auth --external-admin-principal-type User --external-admin-name myUserName --external-admin-sid c5e964e2-6bb2-2222-1111-3b16ec0e1234 -g myResourceGroup -n miName --subnet /subscriptions/78975f9f-2222-1111-1111-29c42ac70000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-test/subnets/ManagedInstance

SQL 管理なしでマネージドインスタンスを作成します。AD 管理者、AD のみ有効、User ManagedIdenties、ID の種類は SystemAssigned、UserAssigned です。

az sql mi create --enable-ad-only-auth --external-admin-principal-type User --external-admin-name myUserName \ --external-admin-sid c5e964e2-6bb2-1111-1111-3b16ec0e1234 -g myResourceGroup -n myServer -i \ --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --identity-type SystemAssigned,UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --subnet /subscriptions/78975f9f-2222-1111-1111-29c42ac70000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-test/subnets/ManagedInstance

SQL 管理なしでマネージドインスタンスを作成します。AD 管理者、AD のみ有効、User ManagedIdenties、ID の種類は UserAssigned です。

az sql mi create --enable-ad-only-auth --external-admin-principal-type User --external-admin-name myUserName \ --external-admin-sid c5e964e2-6bb2-1111-1111-3b16ec0e1234 -g myResourceGroup -n myServer -i \ --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --identity-type UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --subnet /subscriptions/78975f9f-2222-1111-1111-29c42ac70000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-test/subnets/ManagedInstance

ゾーン冗長性が有効なマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} -z

ゾーン冗長を明示的に無効にしてマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} -z false

インスタンスプール名を使用してマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --instance-pool-name myinstancepool

データベース形式と価格モデルを使用してマネージドインスタンスを作成する

az sql mi create -g mygroup -n myinstance -l mylocation -i -u myusername -p mypassword --subnet /subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Network/virtualNetworks/{VNETName}/subnets/{SubnetName} --database-format Regular --pricing-model AlwaysUpToDate

必須のパラメーター

--name -n

マネージドインスタンス名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subnet

Azure Sql Managed Instance へのアクセスを許可するサブネットの名前または ID。サブネット名を指定する場合は、--vnet-name を指定する必要があります。

省略可能のパラメーター

--admin-password -p

管理者ログインパスワード (管理されたインスタンスの作成に必要)。

--admin-user -u

マネージドインスタンスの管理istrator ユーザー名。マネージドインスタンスが作成されるときに、Canonly を指定します (作成に必要です)。

--assign-identity -i

Azure KeyVault などのキー管理サービスで使用するために、このマネージドインスタンスの Azure Active Directory ID を生成して割り当てます。

既定値: False

--backup-storage-redundancy --bsr

バックアップの格納に使用されるバックアップストレージの冗長性。使用できる値は、Local、Zone、Geo、GeoZone です。

--capacity -c

仮想コアの整数でのマネージドインスタンスの容量。

--collation

マネージドインスタンスの照合順序。

--database-format

SQL に固有の Managed Instance データベース形式。使用できる値は、AlwaysUpToDate、SQLServer2022 です。

承認された値: AlwaysUpToDate, SQLServer2022

--edition --tier -e

SKU のエディションコンポーネント。使用できる値は、GeneralPurpose、BusinessCritical です。

--enable-ad-only-auth

このサーバーに対して Azure Active Directory のみの認証を有効にします。

既定値: False

--external-admin-name

Azure AD 管理者ユーザー、グループ、またはアプリケーションの表示名。

--external-admin-principal-type

ユーザー、グループ、またはアプリケーション。

--external-admin-sid

Azure AD 管理者の一意の ID。ユーザーまたはグループのオブジェクト ID、アプリケーションのクライアント ID。

--family -f

SKU のコンピューティング生成コンポーネント。使用できる値は、Gen4、Gen5 です。

--identity-type -t

使用する ID の種類。指定できる値は、SystemAsssigned、UserAssigned、SystemAssignedUserAssigned、None です。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--instance-pool-name

マネージドインスタンスが配置されるインスタンスプールの名前。

--key-id -k

暗号化用のキーコンテナー URI。

--license-type

このマネージドインスタンスに適用するライセンスの種類。

承認された値: BasePrice, LicenseIncluded

--location -l

Location。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--maint-config-id -m

メインテナント構成をこのマネージドインスタンスに割り当てます。

--minimal-tls-version

プレビュー

マネージドインスタンスによって受信接続用に適用される最小 TLS バージョンです。

承認された値: 1.0, 1.1, 1.2, None

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--pid --primary-user-assigned-identity-id

プライマリユーザーマネージド ID の ID。

--pricing-model

Managed Instance の価格モデル。使用できる値は、Regular、Freemium です。

承認された値: Freemium, Regular

--proxy-override

インスタンスへの接続に使用される接続の種類。

承認された値: Default, Proxy, Redirect

--public-data-endpoint-enabled

パブリックデータエンドポイントがインスタンスに対して有効になっているかどうか。

承認された値: false, true

--service-principal-type

このマネージドインスタンスに使用するサービスプリンシパルの種類。指定できる値は、SystemAssigned と None です。

承認された値: None, SystemAssigned

--storage

マネージドインスタンスのストレージサイズ。ストレージサイズは、32 GB 単位で指定する必要があります。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--timezone-id

設定するインスタンスのタイムゾーン ID。タイムゾーン ID の一覧は、sys.time_zone_info (Transact-SQL) ビューを通じて公開されます。

--user-assigned-identity-id -a

このサーバーのユーザーマネージド ID (UMI) を生成して割り当てます。

--vnet-name

仮想ネットワーク名。

--yes -y

確認のダイアログを表示しません。

既定値: False

--zone-redundant -z

ゾーン冗長を有効にするかどうかを指定します。値が指定されていない場合、既定値は true です。

承認された値: false, true

グローバルパラメーター

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

編集

マネージドインスタンスを削除します。

az sql mi delete [--ids]
                 [--name]
                 [--no-wait]
                 [--resource-group]
                 [--subscription]
                 [--yes]

例

マネージドインスタンスを削除する

az sql mi delete -g mygroup -n myinstance --yes

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

マネージドインスタンス名。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--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 sql mi failover

編集

マネージドインスタンスをフェールオーバーします。

az sql mi failover [--ids]
                   [--name]
                   [--no-wait]
                   [--replica-type]
                   [--resource-group]
                   [--subscription]

例

マネージドインスタンスのプライマリレプリカをフェールオーバーする

az sql mi failover -g mygroup -n myinstance

マネージドインスタンスの読み取り可能な秒次レプリカをフェールオーバーする

az sql mi failover -g mygroup -n myinstance --replica-type ReadableSecondary

省略可能のパラメーター

--ids

--name -n

マネージドインスタンス名。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--replica-type

フェールオーバーするレプリカの種類。既知の値は、"Primary" と "ReadableSecondary" です。既定値は None です。

--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 を使います。

az sql mi list

編集

使用可能なマネージドインスタンスを一覧表示します。

az sql mi list [--expand-ad-admin]
               [--resource-group]

例

現在のサブスクリプション内のすべてのマネージドインスタンスを一覧表示します。

az sql mi list

リソースグループ内のすべてのマネージドインスタンスを一覧表示します。

az sql mi list -g mygroup

省略可能のパラメーター

--expand-ad-admin

サーバーの Active Directory 管理istrator を展開します。

既定値: False

--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 sql mi refresh-external-governance-status

編集

外部ガバナンスの有効化状態を更新します。

az sql mi refresh-external-governance-status [--ids]
                                             [--managed-instance-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--subscription]

例

特定の MI で外部ガバナンスの状態を更新する

az sql mi refresh-external-governance-status --managed-instance-name managedInstance -g resourceGroup1 --subscription xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

省略可能のパラメーター

--ids

--managed-instance-name --mi

マネージドインスタンスの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソースグループの名前。

--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 sql mi show

編集

マネージドインスタンスの詳細を取得します。

az sql mi show [--expand-ad-admin]
               [--ids]
               [--name]
               [--resource-group]
               [--subscription]

例

マネージドインスタンスの詳細を取得する

az sql mi show -g mygroup -n myinstance

省略可能のパラメーター

--expand-ad-admin

サーバーの Active Directory 管理istrator を展開します。

既定値: False

--ids

--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 を使います。

az sql mi start

編集

マネージドインスタンスを起動します。

az sql mi start [--ids]
                [--managed-instance]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--resource-group]
                [--subscription]

例

マネージドインスタンスを起動します。

az sql mi start --ids resourceId
az sql mi start --mi miName -g resourceGroup --subscription subscription

省略可能のパラメーター

--ids

--managed-instance --mi

マネージドインスタンスの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソースグループの名前。

--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 sql mi stop

編集

マネージドインスタンスを停止します。

az sql mi stop [--ids]
               [--managed-instance]
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
               [--resource-group]
               [--subscription]

例

マネージドインスタンスを停止します。

az sql mi stop --ids resourceId
az sql mi stop --mi miName -g resourceGroup --subscription subscription

省略可能のパラメーター

--ids

--managed-instance --mi

マネージドインスタンスの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソースグループの名前。

--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 sql mi update

編集

マネージドインスタンスを更新します。

az sql mi update [--add]
                 [--admin-password]
                 [--assign-identity]
                 [--backup-storage-redundancy]
                 [--capacity]
                 [--database-format {AlwaysUpToDate, SQLServer2022}]
                 [--edition]
                 [--family]
                 [--force-string]
                 [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                 [--ids]
                 [--instance-pool-name]
                 [--key-id]
                 [--license-type {BasePrice, LicenseIncluded}]
                 [--maint-config-id]
                 [--minimal-tls-version {1.0, 1.1, 1.2, None}]
                 [--name]
                 [--no-wait]
                 [--pid]
                 [--pricing-model {Freemium, Regular}]
                 [--proxy-override {Default, Proxy, Redirect}]
                 [--public-data-endpoint-enabled {false, true}]
                 [--remove]
                 [--resource-group]
                 [--service-principal-type {None, SystemAssigned}]
                 [--set]
                 [--storage]
                 [--subnet]
                 [--subscription]
                 [--tags]
                 [--user-assigned-identity-id]
                 [--vnet-name]
                 [--yes]
                 [--zone-redundant {false, true}]

例

指定されたパラメーターと ID を使用して mi を更新する

az sql mi update -g mygroup -n myinstance -i -p mypassword --license-type mylicensetype --capacity vcorecapacity --storage storagesize

mi エディションとハードウェアファミリを更新する

az sql mi update -g mygroup -n myinstance --tier GeneralPurpose --family Gen5

タグを追加または更新します。

az sql mi update -g mygroup -n myinstance --set tags.tagName=tagValue

タグを削除します。

az sql mi update -g mygroup -n myinstance --remove tags.tagName

マネージドインスタンスを更新します。 (自動生成)

az sql mi update --name myinstance --proxy-override Default --resource-group mygroup --subscription MySubscription

マネージドインスタンスを更新します。 (自動生成)

az sql mi update --name myinstance --public-data-endpoint-enabled true --resource-group mygroup --subscription MySubscription

メインテナント構成でマネージドインスタンスを更新する

az sql mi update -g mygroup -n myinstance -m SQL_{Region}_{MaintenanceConfigName}

マネージドインスタンスからメインテナント構成を削除する

az sql mi update -g mygroup -n myinstance -m SQL_Default

サービスプリンシパルを使用してマネージドインスタンスを更新する

az sql mi update -g mygroup -n myinstance --service-principal-type SystemAssigned

User Managed Identies でマネージドインスタンスを更新し、ID の種類が SystemAssigned、UserAssigned です。

az sql mi update -g myResourceGroup -n myServer -i \ --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --identity-type SystemAssigned,UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi

User Managed Identies でマネージドインスタンスを更新し、ID の種類が UserAssigned である

az sql mi update -g myResourceGroup -n myServer -i \ --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \ --identity-type UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi

マネージインスタンスを別のサブネットに移動する

az sql mi update -g myResourceGroup -n myServer -i \ --subnet /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet \

mi バックアップストレージの冗長性を更新する

az sql mi update -g mygroup -n myinstance --bsr Local

マネージドインスタンスでゾーン冗長を有効にする

az sql mi update -g mygroup -n myinstance -z

マネージドインスタンスをインスタンスプールに移動する

az sql mi update -g mygroup -n myinstance --instance-pool-name myinstancepool

マネージドインスタンスをインスタンスプールから移動する

az sql mi update -g mygroup -n myinstance --remove instancePoolId --capacity vcorecapacity

mi データベースの形式と価格モデルを更新する

az sql mi update -g mygroup -n myinstance --database-format Regular --pricing-model AlwaysUpToDate

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

既定値: []

--admin-password -p

管理者ログインパスワード (管理されたインスタンスの作成に必要)。

--assign-identity -i

Azure KeyVault などのキー管理サービスで使用するために、このマネージドインスタンスの Azure Active Directory ID を生成して割り当てます。 ID が既に割り当てられている場合は、何も行いません。

既定値: False

--backup-storage-redundancy --bsr

バックアップの格納に使用されるバックアップストレージの冗長性。使用できる値は、Local、Zone、Geo、GeoZone です。

--capacity -c

仮想コアの整数でのマネージドインスタンスの容量。

--database-format

SQL に固有の Managed Instance データベース形式。使用できる値は、AlwaysUpToDate、SQLServer2022 です。

承認された値: AlwaysUpToDate, SQLServer2022

--edition --tier -e

SKU のエディションコンポーネント。使用できる値は、GeneralPurpose、BusinessCritical です。

--family -f

SKU のコンピューティング生成コンポーネント。使用できる値は、Gen4、Gen5 です。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False

--identity-type -t

使用する ID の種類。指定できる値は、SystemAsssigned、UserAssigned、SystemAssignedUserAssigned、None です。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ids

--instance-pool-name

マネージドインスタンスが配置されるインスタンスプールの名前。

--key-id -k

暗号化用のキーコンテナー URI。

--license-type

このマネージドインスタンスに適用するライセンスの種類。

承認された値: BasePrice, LicenseIncluded

--maint-config-id -m

このマネージドインスタンスメインテナント構成を変更します。

--minimal-tls-version

プレビュー

マネージドインスタンスによって受信接続用に適用される最小 TLS バージョンです。

承認された値: 1.0, 1.1, 1.2, None

--name -n

マネージドインスタンス名。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--pid --primary-user-assigned-identity-id

プライマリユーザーマネージド ID の ID。

--pricing-model

Managed Instance の価格モデル。使用できる値は、Regular、Freemium です。

承認された値: Freemium, Regular

--proxy-override

インスタンスへの接続に使用される接続の種類。

承認された値: Default, Proxy, Redirect

--public-data-endpoint-enabled

パブリックデータエンドポイントがインスタンスに対して有効になっているかどうか。

承認された値: false, true

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

既定値: []

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-principal-type

このマネージドインスタンスに使用するサービスプリンシパルの種類。指定できる値は、SystemAssigned と None です。

承認された値: None, SystemAssigned

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

既定値: []

--storage

マネージドインスタンスのストレージサイズ。ストレージサイズは、32 GB 単位で指定する必要があります。

--subnet

Azure Sql Managed Instance へのアクセスを許可するサブネットの名前または ID。サブネット名を指定する場合は、--vnet-name を指定する必要があります。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--user-assigned-identity-id -a

このサーバーのユーザーマネージド ID (UMI) を生成して割り当てます。

--vnet-name

仮想ネットワーク名。

--yes -y

確認のダイアログを表示しません。

既定値: False

--zone-redundant -z

ゾーン冗長を有効にするかどうかを指定します。値が指定されていない場合、既定値は true です。

承認された値: false, true

グローバルパラメーター

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

コマンド

az sql mi create

例

必須のパラメーター

省略可能のパラメーター

az sql mi delete

例

省略可能のパラメーター

az sql mi failover

例

省略可能のパラメーター

az sql mi list

例

省略可能のパラメーター

az sql mi refresh-external-governance-status

例

省略可能のパラメーター

az sql mi show

例

省略可能のパラメーター

az sql mi start

例

省略可能のパラメーター

az sql mi stop

例

省略可能のパラメーター

az sql mi update

例

省略可能のパラメーター

フィードバック

その他のリソース