Yandex v0.13.0, Feb 22 22

yandex.getMdbSqlserverCluster

Get information about a Yandex Managed SQLServer cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbSqlserverCluster.InvokeAsync(new Yandex.GetMdbSqlserverClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.GetMdbSqlserverCluster(ctx, &GetMdbSqlserverClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_sqlserver_cluster(name="test")
pulumi.export("networkId", foo.network_id)

import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = pulumi.output(yandex.getMdbSqlserverCluster({
    name: "test",
}));

export const networkId = foo.networkId;

Coming soon!

Using getMdbSqlserverCluster

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 getMdbSqlserverCluster(args: GetMdbSqlserverClusterArgs, opts?: InvokeOptions): Promise<GetMdbSqlserverClusterResult>
function getMdbSqlserverClusterOutput(args: GetMdbSqlserverClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbSqlserverClusterResult>

def get_mdb_sqlserver_cluster(cluster_id: Optional[str] = None,
                              deletion_protection: Optional[bool] = None,
                              folder_id: Optional[str] = None,
                              name: Optional[str] = None,
                              sqlserver_config: Optional[Mapping[str, str]] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMdbSqlserverClusterResult
def get_mdb_sqlserver_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                              deletion_protection: Optional[pulumi.Input[bool]] = None,
                              folder_id: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              sqlserver_config: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetMdbSqlserverClusterResult]

func GetMdbSqlserverCluster(ctx *Context, args *GetMdbSqlserverClusterArgs, opts ...InvokeOption) (*GetMdbSqlserverClusterResult, error)
func GetMdbSqlserverClusterOutput(ctx *Context, args *GetMdbSqlserverClusterOutputArgs, opts ...InvokeOption) GetMdbSqlserverClusterResultOutput

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

public static class GetMdbSqlserverCluster 
{
    public static Task<GetMdbSqlserverClusterResult> InvokeAsync(GetMdbSqlserverClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbSqlserverClusterResult> Invoke(GetMdbSqlserverClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMdbSqlserverClusterResult> getMdbSqlserverCluster(GetMdbSqlserverClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: yandex:index/getMdbSqlserverCluster:getMdbSqlserverCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: The ID of the SQLServer cluster.
DeletionProtection bool
FolderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string: The name of the SQLServer cluster.
SqlserverConfig Dictionary<string, string>: SQLServer cluster config.

ClusterId string: The ID of the SQLServer cluster.
DeletionProtection bool
FolderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string: The name of the SQLServer cluster.
SqlserverConfig map[string]string: SQLServer cluster config.

clusterId String: The ID of the SQLServer cluster.
deletionProtection Boolean
folderId String: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name String: The name of the SQLServer cluster.
sqlserverConfig Map<String,String>: SQLServer cluster config.

clusterId string: The ID of the SQLServer cluster.
deletionProtection boolean
folderId string: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name string: The name of the SQLServer cluster.
sqlserverConfig {[key: string]: string}: SQLServer cluster config.

cluster_id str: The ID of the SQLServer cluster.
deletion_protection bool
folder_id str: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name str: The name of the SQLServer cluster.
sqlserver_config Mapping[str, str]: SQLServer cluster config.

clusterId String: The ID of the SQLServer cluster.
deletionProtection Boolean
folderId String: The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name String: The name of the SQLServer cluster.
sqlserverConfig Map<String>: SQLServer cluster config.

getMdbSqlserverCluster Result

The following output properties are available:

BackupWindowStarts List<GetMdbSqlserverClusterBackupWindowStart>
ClusterId string
CreatedAt string: Creation timestamp of the key.
Databases List<GetMdbSqlserverClusterDatabase>: A database of the SQLServer cluster. The structure is documented below.
DeletionProtection bool
Description string: Description of the SQLServer cluster.
Environment string: Deployment environment of the SQLServer cluster.
FolderId string
Health string: Aggregated health of the cluster.
HostGroupIds List<string>: A list of IDs of the host groups hosting VMs of the cluster.
Hosts List<GetMdbSqlserverClusterHost>: A host of the SQLServer cluster. The structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>: A set of key/value label pairs to assign to the SQLServer cluster.
Name string: The name of the database.
NetworkId string: ID of the network, to which the SQLServer cluster belongs.
Resources List<GetMdbSqlserverClusterResource>: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
SecurityGroupIds List<string>: A set of ids of security groups assigned to hosts of the cluster.
SqlserverConfig Dictionary<string, string>: SQLServer cluster config.
Status string: Status of the cluster.
Users List<GetMdbSqlserverClusterUser>: A user of the SQLServer cluster. The structure is documented below.
Version string: Version of the SQLServer cluster.

BackupWindowStarts []GetMdbSqlserverClusterBackupWindowStart
ClusterId string
CreatedAt string: Creation timestamp of the key.
Databases []GetMdbSqlserverClusterDatabase: A database of the SQLServer cluster. The structure is documented below.
DeletionProtection bool
Description string: Description of the SQLServer cluster.
Environment string: Deployment environment of the SQLServer cluster.
FolderId string
Health string: Aggregated health of the cluster.
HostGroupIds []string: A list of IDs of the host groups hosting VMs of the cluster.
Hosts []GetMdbSqlserverClusterHost: A host of the SQLServer cluster. The structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string: A set of key/value label pairs to assign to the SQLServer cluster.
Name string: The name of the database.
NetworkId string: ID of the network, to which the SQLServer cluster belongs.
Resources []GetMdbSqlserverClusterResource: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
SecurityGroupIds []string: A set of ids of security groups assigned to hosts of the cluster.
SqlserverConfig map[string]string: SQLServer cluster config.
Status string: Status of the cluster.
Users []GetMdbSqlserverClusterUser: A user of the SQLServer cluster. The structure is documented below.
Version string: Version of the SQLServer cluster.

backupWindowStarts List<GetMdbSqlserverClusterBackupWindowStart>
clusterId String
createdAt String: Creation timestamp of the key.
databases List<GetMdbSqlserverClusterDatabase>: A database of the SQLServer cluster. The structure is documented below.
deletionProtection Boolean
description String: Description of the SQLServer cluster.
environment String: Deployment environment of the SQLServer cluster.
folderId String
health String: Aggregated health of the cluster.
hostGroupIds List<String>: A list of IDs of the host groups hosting VMs of the cluster.
hosts List<GetMdbSqlserverClusterHost>: A host of the SQLServer cluster. The structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>: A set of key/value label pairs to assign to the SQLServer cluster.
name String: The name of the database.
networkId String: ID of the network, to which the SQLServer cluster belongs.
resources List<GetMdbSqlserverClusterResource>: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
securityGroupIds List<String>: A set of ids of security groups assigned to hosts of the cluster.
sqlserverConfig Map<String,String>: SQLServer cluster config.
status String: Status of the cluster.
users List<GetMdbSqlserverClusterUser>: A user of the SQLServer cluster. The structure is documented below.
version String: Version of the SQLServer cluster.

backupWindowStarts GetMdbSqlserverClusterBackupWindowStart[]
clusterId string
createdAt string: Creation timestamp of the key.
databases GetMdbSqlserverClusterDatabase[]: A database of the SQLServer cluster. The structure is documented below.
deletionProtection boolean
description string: Description of the SQLServer cluster.
environment string: Deployment environment of the SQLServer cluster.
folderId string
health string: Aggregated health of the cluster.
hostGroupIds string[]: A list of IDs of the host groups hosting VMs of the cluster.
hosts GetMdbSqlserverClusterHost[]: A host of the SQLServer cluster. The structure is documented below.
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}: A set of key/value label pairs to assign to the SQLServer cluster.
name string: The name of the database.
networkId string: ID of the network, to which the SQLServer cluster belongs.
resources GetMdbSqlserverClusterResource[]: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
securityGroupIds string[]: A set of ids of security groups assigned to hosts of the cluster.
sqlserverConfig {[key: string]: string}: SQLServer cluster config.
status string: Status of the cluster.
users GetMdbSqlserverClusterUser[]: A user of the SQLServer cluster. The structure is documented below.
version string: Version of the SQLServer cluster.

backup_window_starts Sequence[GetMdbSqlserverClusterBackupWindowStart]
cluster_id str
created_at str: Creation timestamp of the key.
databases Sequence[GetMdbSqlserverClusterDatabase]: A database of the SQLServer cluster. The structure is documented below.
deletion_protection bool
description str: Description of the SQLServer cluster.
environment str: Deployment environment of the SQLServer cluster.
folder_id str
health str: Aggregated health of the cluster.
host_group_ids Sequence[str]: A list of IDs of the host groups hosting VMs of the cluster.
hosts Sequence[GetMdbSqlserverClusterHost]: A host of the SQLServer cluster. The structure is documented below.
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]: A set of key/value label pairs to assign to the SQLServer cluster.
name str: The name of the database.
network_id str: ID of the network, to which the SQLServer cluster belongs.
resources Sequence[GetMdbSqlserverClusterResource]: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
security_group_ids Sequence[str]: A set of ids of security groups assigned to hosts of the cluster.
sqlserver_config Mapping[str, str]: SQLServer cluster config.
status str: Status of the cluster.
users Sequence[GetMdbSqlserverClusterUser]: A user of the SQLServer cluster. The structure is documented below.
version str: Version of the SQLServer cluster.

backupWindowStarts List<Property Map>
clusterId String
createdAt String: Creation timestamp of the key.
databases List<Property Map>: A database of the SQLServer cluster. The structure is documented below.
deletionProtection Boolean
description String: Description of the SQLServer cluster.
environment String: Deployment environment of the SQLServer cluster.
folderId String
health String: Aggregated health of the cluster.
hostGroupIds List<String>: A list of IDs of the host groups hosting VMs of the cluster.
hosts List<Property Map>: A host of the SQLServer cluster. The structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>: A set of key/value label pairs to assign to the SQLServer cluster.
name String: The name of the database.
networkId String: ID of the network, to which the SQLServer cluster belongs.
resources List<Property Map>: Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
securityGroupIds List<String>: A set of ids of security groups assigned to hosts of the cluster.
sqlserverConfig Map<String>: SQLServer cluster config.
status String: Status of the cluster.
users List<Property Map>: A user of the SQLServer cluster. The structure is documented below.
version String: Version of the SQLServer cluster.

Supporting Types

GetMdbSqlserverClusterBackupWindowStart

Hours int: The hour at which backup will be started.
Minutes int: The minute at which backup will be started.

Hours int: The hour at which backup will be started.
Minutes int: The minute at which backup will be started.

hours Integer: The hour at which backup will be started.
minutes Integer: The minute at which backup will be started.

hours number: The hour at which backup will be started.
minutes number: The minute at which backup will be started.

hours int: The hour at which backup will be started.
minutes int: The minute at which backup will be started.

hours Number: The hour at which backup will be started.
minutes Number: The minute at which backup will be started.

GetMdbSqlserverClusterDatabase

Name string: The name of the SQLServer cluster.

Name string: The name of the SQLServer cluster.

name String: The name of the SQLServer cluster.

name string: The name of the SQLServer cluster.

name str: The name of the SQLServer cluster.

name String: The name of the SQLServer cluster.

GetMdbSqlserverClusterHost

AssignPublicIp bool: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
Fqdn string: The fully qualified domain name of the host.
SubnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
Zone string: The availability zone where the SQLServer host will be created.

AssignPublicIp bool: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
Fqdn string: The fully qualified domain name of the host.
SubnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
Zone string: The availability zone where the SQLServer host will be created.

assignPublicIp Boolean: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn String: The fully qualified domain name of the host.
subnetId String: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
zone String: The availability zone where the SQLServer host will be created.

assignPublicIp boolean: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn string: The fully qualified domain name of the host.
subnetId string: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
zone string: The availability zone where the SQLServer host will be created.

assign_public_ip bool: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn str: The fully qualified domain name of the host.
subnet_id str: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
zone str: The availability zone where the SQLServer host will be created.

assignPublicIp Boolean: Sets whether the host should get a public IP address on creation. Changing this parameter for an existing host is not supported at the moment
fqdn String: The fully qualified domain name of the host.
subnetId String: The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
zone String: The availability zone where the SQLServer host will be created.

GetMdbSqlserverClusterResource

DiskSize int: Volume of the storage available to a SQLServer host, in gigabytes.
DiskTypeId string: Type of the storage for SQLServer hosts.
ResourcePresetId string

DiskSize int: Volume of the storage available to a SQLServer host, in gigabytes.
DiskTypeId string: Type of the storage for SQLServer hosts.
ResourcePresetId string

diskSize Integer: Volume of the storage available to a SQLServer host, in gigabytes.
diskTypeId String: Type of the storage for SQLServer hosts.
resourcePresetId String

diskSize number: Volume of the storage available to a SQLServer host, in gigabytes.
diskTypeId string: Type of the storage for SQLServer hosts.
resourcePresetId string

disk_size int: Volume of the storage available to a SQLServer host, in gigabytes.
disk_type_id str: Type of the storage for SQLServer hosts.
resource_preset_id str

diskSize Number: Volume of the storage available to a SQLServer host, in gigabytes.
diskTypeId String: Type of the storage for SQLServer hosts.
resourcePresetId String

GetMdbSqlserverClusterUser

Name string: The name of the SQLServer cluster.
Password string: The password of the user.
Permissions List<GetMdbSqlserverClusterUserPermission>: Set of permissions granted to the user. The structure is documented below.

Name string: The name of the SQLServer cluster.
Password string: The password of the user.
Permissions []GetMdbSqlserverClusterUserPermission: Set of permissions granted to the user. The structure is documented below.

name String: The name of the SQLServer cluster.
password String: The password of the user.
permissions List<GetMdbSqlserverClusterUserPermission>: Set of permissions granted to the user. The structure is documented below.

name string: The name of the SQLServer cluster.
password string: The password of the user.
permissions GetMdbSqlserverClusterUserPermission[]: Set of permissions granted to the user. The structure is documented below.

name str: The name of the SQLServer cluster.
password str: The password of the user.
permissions Sequence[GetMdbSqlserverClusterUserPermission]: Set of permissions granted to the user. The structure is documented below.

name String: The name of the SQLServer cluster.
password String: The password of the user.
permissions List<Property Map>: Set of permissions granted to the user. The structure is documented below.

GetMdbSqlserverClusterUserPermission

DatabaseName string: The name of the database that the permission grants access to.
Roles List<string>: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

DatabaseName string: The name of the database that the permission grants access to.
Roles []string: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

databaseName String: The name of the database that the permission grants access to.
roles List<String>: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

databaseName string: The name of the database that the permission grants access to.
roles string[]: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

database_name str: The name of the database that the permission grants access to.
roles Sequence[str]: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

databaseName String: The name of the database that the permission grants access to.
roles List<String>: List user's roles in the database. Allowed roles: OWNER, SECURITYADMIN, ACCESSADMIN, BACKUPOPERATOR, DDLADMIN, DATAWRITER, DATAREADER, DENYDATAWRITER, DENYDATAREADER.

Package Details

Repository: Yandex pulumi/pulumi-yandex
License: Apache-2.0
Notes: This Pulumi package is based on the yandex Terraform Provider.