Share via

Configuration interface

Package:
@azure/arm-postgresql-flexible

Configuration (also known as server parameter).

Extends
ProxyResource

Properties

allowedValues

Allowed values of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
dataType

Data type of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
defaultValue

Value assigned by default to the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
description

Description of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
documentationLink

Link pointing to the documentation of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
isConfigPendingRestart

Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. NOTE: This property will not be serialized. It can only be populated by the server.
isDynamicConfig

Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. NOTE: This property will not be serialized. It can only be populated by the server.
isReadOnly

Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.
source

Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
unit

Units in which the configuration (also known as server parameter) value is expressed. NOTE: This property will not be serialized. It can only be populated by the server.
value

Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowedValues

Allowed values of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

allowedValues?: string

Property Value

string

dataType

Data type of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

dataType?: string

Property Value

string

defaultValue

Value assigned by default to the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

defaultValue?: string

Property Value

string

description

Description of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

Link pointing to the documentation of the configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

documentationLink?: string

Property Value

string

isConfigPendingRestart

Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. NOTE: This property will not be serialized. It can only be populated by the server.

isConfigPendingRestart?: boolean

Property Value

boolean

isDynamicConfig

Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. NOTE: This property will not be serialized. It can only be populated by the server.

isDynamicConfig?: boolean

Property Value

boolean

isReadOnly

Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). NOTE: This property will not be serialized. It can only be populated by the server.

isReadOnly?: boolean

Property Value

boolean

source

Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

source?: string

Property Value

string

unit

Units in which the configuration (also known as server parameter) value is expressed. NOTE: This property will not be serialized. It can only be populated by the server.

unit?: string

Property Value

string

value

Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

value?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type