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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	Provisioning state of server configuration option. Known values are: "Created", "InProgress", "Succeeded", "Failed", and "Canceled". (Created, InProgress, Succeeded, Failed, Canceled)
serverConfigurationOptionValue	integer	Value of the server configuration option. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_managed_instance

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	Provisioning state of server configuration option. Known values are: "Created", "InProgress", "Succeeded", "Failed", and "Canceled". (Created, InProgress, Succeeded, Failed, Canceled)
serverConfigurationOptionValue	integer	Value of the server configuration option. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, managed_instance_name, server_configuration_option_name, subscription_id		Gets managed instance server configuration option.
list_by_managed_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a list of managed instance server configuration options.
create_or_update	insert	resource_group_name, managed_instance_name, server_configuration_option_name, subscription_id		Updates managed instance server configuration option.
create_or_update	replace	resource_group_name, managed_instance_name, server_configuration_option_name, subscription_id		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
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_configuration_option_name	string	The name of the server configuration option. "allowPolybaseExport" Required.
subscription_id	string

SELECT examples

get

Gets managed instance server configuration option.

SELECT
id,
name,
provisioningState,
serverConfigurationOptionValue,
systemData,
type
FROM azure.sql.server_configuration_options
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND server_configuration_option_name = '{{ server_configuration_option_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_instance

Gets a list of managed instance server configuration options.

SELECT
id,
name,
provisioningState,
serverConfigurationOptionValue,
systemData,
type
FROM azure.sql.server_configuration_options
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates managed instance server configuration option.

INSERT INTO azure.sql.server_configuration_options (
properties,
resource_group_name,
managed_instance_name,
server_configuration_option_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ server_configuration_option_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_configuration_options
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_configuration_options resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the server_configuration_options resource.
  - name: server_configuration_option_name
    value: "{{ server_configuration_option_name }}"
    description: Required parameter for the server_configuration_options resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_configuration_options resource.
  - name: properties
    description: |
      Resource properties.
    value:
      serverConfigurationOptionValue: {{ serverConfigurationOptionValue }}
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Updates managed instance server configuration option.

REPLACE azure.sql.server_configuration_options
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND server_configuration_option_name = '{{ server_configuration_option_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;