1. Packages
  2. Azure Native v2
  3. API Docs
  4. dbformysql
  5. getConfiguration
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.dbformysql.getConfiguration

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets information about a configuration of server. Azure REST API version: 2022-01-01.

Other available API versions: 2017-12-01, 2020-07-01-privatepreview, 2023-06-01-preview, 2023-06-30, 2023-12-30.

Using getConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfiguration(args: GetConfigurationArgs, opts?: InvokeOptions): Promise<GetConfigurationResult>
function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConfigurationResult>
Copy
def get_configuration(configuration_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      server_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConfigurationResult
def get_configuration_output(configuration_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      server_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationResult]
Copy
func LookupConfiguration(ctx *Context, args *LookupConfigurationArgs, opts ...InvokeOption) (*LookupConfigurationResult, error)
func LookupConfigurationOutput(ctx *Context, args *LookupConfigurationOutputArgs, opts ...InvokeOption) LookupConfigurationResultOutput
Copy

> Note: This function is named LookupConfiguration in the Go SDK.

public static class GetConfiguration 
{
    public static Task<GetConfigurationResult> InvokeAsync(GetConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigurationResult> Invoke(GetConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
public static Output<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dbformysql:getConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server configuration.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server configuration.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
configurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
configuration_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server configuration.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getConfiguration Result

The following output properties are available:

AllowedValues string
Allowed values of the configuration.
DataType string
Data type of the configuration.
DefaultValue string
Default value of the configuration.
Description string
Description of the configuration.
DocumentationLink string
The link used to get the document from community or Azure site.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IsConfigPendingRestart string
If is the configuration pending restart or not.
IsDynamicConfig string
If is the configuration dynamic.
IsReadOnly string
If is the configuration read only.
Name string
The name of the resource
SystemData Pulumi.AzureNative.DBforMySQL.Outputs.SystemDataResponse
The system metadata relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CurrentValue string
Current value of the configuration.
Source string
Source of the configuration.
Value string
Value of the configuration.
AllowedValues string
Allowed values of the configuration.
DataType string
Data type of the configuration.
DefaultValue string
Default value of the configuration.
Description string
Description of the configuration.
DocumentationLink string
The link used to get the document from community or Azure site.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IsConfigPendingRestart string
If is the configuration pending restart or not.
IsDynamicConfig string
If is the configuration dynamic.
IsReadOnly string
If is the configuration read only.
Name string
The name of the resource
SystemData SystemDataResponse
The system metadata relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CurrentValue string
Current value of the configuration.
Source string
Source of the configuration.
Value string
Value of the configuration.
allowedValues String
Allowed values of the configuration.
dataType String
Data type of the configuration.
defaultValue String
Default value of the configuration.
description String
Description of the configuration.
documentationLink String
The link used to get the document from community or Azure site.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isConfigPendingRestart String
If is the configuration pending restart or not.
isDynamicConfig String
If is the configuration dynamic.
isReadOnly String
If is the configuration read only.
name String
The name of the resource
systemData SystemDataResponse
The system metadata relating to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currentValue String
Current value of the configuration.
source String
Source of the configuration.
value String
Value of the configuration.
allowedValues string
Allowed values of the configuration.
dataType string
Data type of the configuration.
defaultValue string
Default value of the configuration.
description string
Description of the configuration.
documentationLink string
The link used to get the document from community or Azure site.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isConfigPendingRestart string
If is the configuration pending restart or not.
isDynamicConfig string
If is the configuration dynamic.
isReadOnly string
If is the configuration read only.
name string
The name of the resource
systemData SystemDataResponse
The system metadata relating to this resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currentValue string
Current value of the configuration.
source string
Source of the configuration.
value string
Value of the configuration.
allowed_values str
Allowed values of the configuration.
data_type str
Data type of the configuration.
default_value str
Default value of the configuration.
description str
Description of the configuration.
documentation_link str
The link used to get the document from community or Azure site.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
is_config_pending_restart str
If is the configuration pending restart or not.
is_dynamic_config str
If is the configuration dynamic.
is_read_only str
If is the configuration read only.
name str
The name of the resource
system_data SystemDataResponse
The system metadata relating to this resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
current_value str
Current value of the configuration.
source str
Source of the configuration.
value str
Value of the configuration.
allowedValues String
Allowed values of the configuration.
dataType String
Data type of the configuration.
defaultValue String
Default value of the configuration.
description String
Description of the configuration.
documentationLink String
The link used to get the document from community or Azure site.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isConfigPendingRestart String
If is the configuration pending restart or not.
isDynamicConfig String
If is the configuration dynamic.
isReadOnly String
If is the configuration read only.
name String
The name of the resource
systemData Property Map
The system metadata relating to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currentValue String
Current value of the configuration.
source String
Source of the configuration.
value String
Value of the configuration.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi