Share via

az sql mi-arc

  • Preview

Note

This reference is part of the arcdata extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az sql mi-arc command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage SQL managed instances for Arc.

Commands

Name Description Type Status
az sql mi-arc config

Configuration commands.

 Extension Preview
az sql mi-arc config add

Add a value for a json path in a config file.

 Extension Preview
az sql mi-arc config init

Initializes the CRD and specification files for a SQL managed instance.

 Extension Preview
az sql mi-arc config patch

Patches a config file based on a json patch file.

 Extension Preview
az sql mi-arc config remove

Remove a value for a json path in a config file.

 Extension Preview
az sql mi-arc config replace

Replace a value for a json path in a config file.

 Extension Preview
az sql mi-arc create

Create a SQL managed instance.

 Extension Preview
az sql mi-arc delete

Delete a SQL managed instance.

 Extension Preview
az sql mi-arc edit

Edit the configuration of a SQL managed instance.

 Extension Preview
az sql mi-arc endpoint

View and manage SQL endpoints.

 Extension Preview
az sql mi-arc endpoint list

List the SQL endpoints.

 Extension Preview
az sql mi-arc list

List SQL managed instances.

 Extension Preview
az sql mi-arc show

Show the details of a SQL managed instance.

 Extension Preview

az sql mi-arc create

Preview

Command group 'sql mi-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a SQL managed instance.

To set the password of the SQL managed instance, please set the environment variable AZDATA_PASSWORD.

az sql mi-arc create --name
                     [--cores-limit]
                     [--cores-request]
                     [--memory-limit]
                     [--memory-request]
                     [--namespace]
                     [--no-external-endpoint]
                     [--no-wait]
                     [--path]
                     [--replicas]
                     [--storage-class-backups]
                     [--storage-class-data]
                     [--storage-class-datalogs]
                     [--storage-class-logs]
                     [--volume-size-backups]
                     [--volume-size-data]
                     [--volume-size-datalogs]
                     [--volume-size-logs]

Examples

Create a SQL managed instance.

az sql mi-arc create -n sqlmi1

Create a SQL managed instance with 3 replicas in HA scenario.

az sql mi-arc create -n sqlmi2 --replicas 3

Required Parameters

--name -n

The name of the SQL managed instance.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cores-limit

The cores limit of the managed instance as an integer.

--cores-request

The request for cores of the managed instance as an integer.

--memory-limit

The limit of the capacity of the managed instance as an integer.

--memory-request

The request for the capcity of the managed instance as an integer amount of memory in GBs.

--namespace -s

Namespace where the SQL managed instance is to be deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used.

--no-external-endpoint

If specified, no external service will be created. Otherwise, an external service will be created using the same service type as the data controller.

--no-wait

If given, the command will not wait for the instance to be in a ready state before returning.

Property Value
Default value: False
--path

The path to the azext_arcdata file for the SQL managed instance json file.

--replicas

This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purpose. Allowed values are '3' or '1' with default of '1'.

--storage-class-backups

The storage class to be used for backups (/var/opt/mssql/backups). If no value is specified, then no storage class will be specified, which will result in Kubernetes using the default storage class.

--storage-class-data

The storage class to be used for data (.mdf). If no value is specified, then no storage class will be specified, which will result in Kubernetes using the default storage class.

--storage-class-datalogs

The storage class to be used for database logs (.ldf). If no value is specified, then no storage class will be specified, which will result in Kubernetes using the default storage class.

--storage-class-logs

The storage class to be used for logs (/var/log). If no value is specified, then no storage class will be specified, which will result in Kubernetes using the default storage class.

--volume-size-backups

The size of the storage volume to be used for backups as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).

--volume-size-data

The size of the storage volume to be used for data as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).

--volume-size-datalogs

The size of the storage volume to be used for data logs as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).

--volume-size-logs

The size of the storage volume to be used for logs as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql mi-arc delete

Preview

Command group 'sql mi-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a SQL managed instance.

az sql mi-arc delete --name
                     [--namespace]

Examples

Delete a SQL managed instance.

az sql mi-arc delete -n sqlmi1

Required Parameters

--name -n

The name of the SQL managed instance to be deleted.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--namespace -s

Namespace where the SQL managed instance is to be deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql mi-arc edit

Preview

Command group 'sql mi-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Edit the configuration of a SQL managed instance.

az sql mi-arc edit --name
                   [--cores-limit]
                   [--cores-request]
                   [--memory-limit]
                   [--memory-request]
                   [--namespace]
                   [--no-wait]
                   [--path]

Examples

Edit the configuration of a SQL managed instance.

az sql mi-arc edit --path ./spec.json -n sqlmi1

Required Parameters

--name -n

The name of the SQL managed instance that is being edited. The name under which your instance is deployed cannot be changed.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cores-limit

The cores limit of the managed instance as an integer.

--cores-request

The request for cores of the managed instance as an integer.

--memory-limit

The limit of the capacity of the managed instance as an integer.

--memory-request

The request for the capcity of the managed instance as an integer amount of memory in GBs.

--namespace -s

Namespace where the SQL managed instance is to be deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used.

--no-wait

If given, the command will not wait for the instance to be in a ready state before returning.

Property Value
Default value: False
--path

The path to the azext_arcdata file for the SQL managed instance json file.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql mi-arc list

Preview

Command group 'sql mi-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List SQL managed instances.

az sql mi-arc list [--namespace]

Examples

List SQL managed instances.

az sql mi-arc list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--namespace -s

Namespace where the SQL managed instance is to be deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sql mi-arc show

Preview

Command group 'sql mi-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the details of a SQL managed instance.

az sql mi-arc show --name
                   [--namespace]
                   [--path]

Examples

Show the details of a SQL managed instance.

az sql mi-arc show -n sqlmi1

Required Parameters

--name -n

The name of the SQL managed instance to be shown.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--namespace -s

Namespace where the SQL managed instance is to be deployed. If no namespace is specified, then the namespace defined in the kubeconfig will be used.

--path -p

A path where the full specification for the SQL managed instance should be written. If omitted, the specification will be written to standard output.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False