server_configuration_options

Creates, updates, deletes, gets or lists a server_configuration_options resource.

Overview

Name	server_configuration_options
Type	Resource
Id	azure.sql.server_configuration_options

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified managed instance server configuration option.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, serverConfigurationOptionName, subscriptionId		Gets managed instance server configuration option.
create_or_update	insert	resourceGroupName, managedInstanceName, serverConfigurationOptionName, subscriptionId		Updates managed instance server configuration option.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
managedInstanceName	string	The name of the managed instance.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverConfigurationOptionName	string	The name of the server configuration option.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets managed instance server configuration option.

SELECT
properties
FROM azure.sql.server_configuration_options
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND serverConfigurationOptionName = '{{ serverConfigurationOptionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Updates managed instance server configuration option.

INSERT INTO azure.sql.server_configuration_options (
data__properties,
resourceGroupName,
managedInstanceName,
serverConfigurationOptionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ serverConfigurationOptionName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_configuration_options
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_configuration_options resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the server_configuration_options resource.
    - name: serverConfigurationOptionName
      value: string
      description: Required parameter for the server_configuration_options resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the server_configuration_options resource.
    - name: properties
      value: object
      description: |
        Resource properties.