@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about a specific server parameter of a flexible server.
*
* Uses Azure REST API version 2024-08-01.
*
* Other available API versions: 2022-12-01, 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-11-01-preview, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native dbforpostgresql [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConfiguration(args: GetConfigurationArgs, opts?: pulumi.InvokeOptions): Promise<GetConfigurationResult>;
export interface GetConfigurationArgs {
/**
* Name of the server parameter.
*/
configurationName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the server.
*/
serverName: string;
}
/**
* Server parameter.
*/
export interface GetConfigurationResult {
/**
* Allowed values of the server parameter.
*/
readonly allowedValues: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Data type of the server parameter.
*/
readonly dataType: string;
/**
* Value assigned by default to the server parameter.
*/
readonly defaultValue: string;
/**
* Description of the server parameter.
*/
readonly description: string;
/**
* Link pointing to the documentation of the server parameter.
*/
readonly documentationLink: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.
*/
readonly isConfigPendingRestart: boolean;
/**
* Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.
*/
readonly isDynamicConfig: boolean;
/**
* Indicates if it's a read-only (true) or modifiable (false) server parameter.
*/
readonly isReadOnly: boolean;
/**
* The name of the resource
*/
readonly name: string;
/**
* Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.
*/
readonly source?: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.dbforpostgresql.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Units in which the server parameter value is expressed.
*/
readonly unit: string;
/**
* Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.
*/
readonly value?: string;
}
/**
* Gets information about a specific server parameter of a flexible server.
*
* Uses Azure REST API version 2024-08-01.
*
* Other available API versions: 2022-12-01, 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-11-01-preview, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native dbforpostgresql [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConfigurationResult>;
export interface GetConfigurationOutputArgs {
/**
* Name of the server parameter.
*/
configurationName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the server.
*/
serverName: pulumi.Input<string>;
}