Azure Native v1.102.0, May 2 23

azure-native.documentdb.Service

Explore with Pulumi AI

Properties for the database account. API Version: 2021-04-01-preview.

Example Usage

DataTransferServiceCreate

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.DocumentDB.Service("service", new()
    {
        AccountName = "ddb1",
        InstanceCount = 1,
        InstanceSize = "Cosmos.D4s",
        ResourceGroupName = "rg1",
        ServiceName = "DataTransfer",
        ServiceType = "DataTransfer",
    });

});

package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native/sdk/go/azure/documentdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewService(ctx, "service", &documentdb.ServiceArgs{
			AccountName:       pulumi.String("ddb1"),
			InstanceCount:     pulumi.Int(1),
			InstanceSize:      pulumi.String("Cosmos.D4s"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("DataTransfer"),
			ServiceType:       pulumi.String("DataTransfer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.Service;
import com.pulumi.azurenative.documentdb.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var service = new Service("service", ServiceArgs.builder()        
            .accountName("ddb1")
            .instanceCount(1)
            .instanceSize("Cosmos.D4s")
            .resourceGroupName("rg1")
            .serviceName("DataTransfer")
            .serviceType("DataTransfer")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

service = azure_native.documentdb.Service("service",
    account_name="ddb1",
    instance_count=1,
    instance_size="Cosmos.D4s",
    resource_group_name="rg1",
    service_name="DataTransfer",
    service_type="DataTransfer")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.documentdb.Service("service", {
    accountName: "ddb1",
    instanceCount: 1,
    instanceSize: "Cosmos.D4s",
    resourceGroupName: "rg1",
    serviceName: "DataTransfer",
    serviceType: "DataTransfer",
});

resources:
  service:
    type: azure-native:documentdb:Service
    properties:
      accountName: ddb1
      instanceCount: 1
      instanceSize: Cosmos.D4s
      resourceGroupName: rg1
      serviceName: DataTransfer
      serviceType: DataTransfer

SqlDedicatedGatewayServiceCreate

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var service = new AzureNative.DocumentDB.Service("service", new()
    {
        AccountName = "ddb1",
        InstanceCount = 1,
        InstanceSize = "Cosmos.D4s",
        ResourceGroupName = "rg1",
        ServiceName = "SqlDedicatedGateway",
        ServiceType = "SqlDedicatedGateway",
    });

});

package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native/sdk/go/azure/documentdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewService(ctx, "service", &documentdb.ServiceArgs{
			AccountName:       pulumi.String("ddb1"),
			InstanceCount:     pulumi.Int(1),
			InstanceSize:      pulumi.String("Cosmos.D4s"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("SqlDedicatedGateway"),
			ServiceType:       pulumi.String("SqlDedicatedGateway"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.Service;
import com.pulumi.azurenative.documentdb.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var service = new Service("service", ServiceArgs.builder()        
            .accountName("ddb1")
            .instanceCount(1)
            .instanceSize("Cosmos.D4s")
            .resourceGroupName("rg1")
            .serviceName("SqlDedicatedGateway")
            .serviceType("SqlDedicatedGateway")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

service = azure_native.documentdb.Service("service",
    account_name="ddb1",
    instance_count=1,
    instance_size="Cosmos.D4s",
    resource_group_name="rg1",
    service_name="SqlDedicatedGateway",
    service_type="SqlDedicatedGateway")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const service = new azure_native.documentdb.Service("service", {
    accountName: "ddb1",
    instanceCount: 1,
    instanceSize: "Cosmos.D4s",
    resourceGroupName: "rg1",
    serviceName: "SqlDedicatedGateway",
    serviceType: "SqlDedicatedGateway",
});

resources:
  service:
    type: azure-native:documentdb:Service
    properties:
      accountName: ddb1
      instanceCount: 1
      instanceSize: Cosmos.D4s
      resourceGroupName: rg1
      serviceName: SqlDedicatedGateway
      serviceType: SqlDedicatedGateway

Create Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            instance_count: Optional[int] = None,
            instance_size: Optional[Union[str, ServiceSize]] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            service_type: Optional[Union[str, ServiceType]] = None)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

type: azure-native:documentdb:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Service resource accepts the following input properties:

AccountName string: Cosmos DB database account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
InstanceCount int: Instance count for the service.
InstanceSize string | Pulumi.AzureNative.DocumentDB.ServiceSize: Instance type for the service.
ServiceName string: Cosmos DB service name.
ServiceType string | Pulumi.AzureNative.DocumentDB.ServiceType: ServiceType for the service.

AccountName string: Cosmos DB database account name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
InstanceCount int: Instance count for the service.
InstanceSize string | ServiceSize: Instance type for the service.
ServiceName string: Cosmos DB service name.
ServiceType string | ServiceType: ServiceType for the service.

accountName String: Cosmos DB database account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
instanceCount Integer: Instance count for the service.
instanceSize String | ServiceSize: Instance type for the service.
serviceName String: Cosmos DB service name.
serviceType String | ServiceType: ServiceType for the service.

accountName string: Cosmos DB database account name.
resourceGroupName string: The name of the resource group. The name is case insensitive.
instanceCount number: Instance count for the service.
instanceSize string | ServiceSize: Instance type for the service.
serviceName string: Cosmos DB service name.
serviceType string | ServiceType: ServiceType for the service.

account_name str: Cosmos DB database account name.
resource_group_name str: The name of the resource group. The name is case insensitive.
instance_count int: Instance count for the service.
instance_size str | ServiceSize: Instance type for the service.
service_name str: Cosmos DB service name.
service_type str | ServiceType: ServiceType for the service.

accountName String: Cosmos DB database account name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
instanceCount Number: Instance count for the service.
instanceSize String | "Cosmos.D4s" | "Cosmos.D8s" | "Cosmos.D16s": Instance type for the service.
serviceName String: Cosmos DB service name.
serviceType String | "SqlDedicatedGateway" | "DataTransfer": ServiceType for the service.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the database account.
Properties Pulumi.AzureNative.DocumentDB.Outputs.DataTransferServiceResourcePropertiesResponse | Pulumi.AzureNative.DocumentDB.Outputs.SqlDedicatedGatewayServiceResourcePropertiesResponse: Services response resource.
Type string: The type of Azure resource.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the database account.
Properties DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: Services response resource.
Type string: The type of Azure resource.

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the database account.
properties DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: Services response resource.
type String: The type of Azure resource.

id string: The provider-assigned unique ID for this managed resource.
name string: The name of the database account.
properties DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: Services response resource.
type string: The type of Azure resource.

id str: The provider-assigned unique ID for this managed resource.
name str: The name of the database account.
properties DataTransferServiceResourcePropertiesResponse | SqlDedicatedGatewayServiceResourcePropertiesResponse: Services response resource.
type str: The type of Azure resource.

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the database account.
properties Property Map | Property Map: Services response resource.
type String: The type of Azure resource.

Supporting Types

DataTransferRegionalServiceResourceResponse

Location string: The location name.
Name string: The regional service name.
Status string: Describes the status of a service.

Location string: The location name.
Name string: The regional service name.
Status string: Describes the status of a service.

location String: The location name.
name String: The regional service name.
status String: Describes the status of a service.

location string: The location name.
name string: The regional service name.
status string: Describes the status of a service.

location str: The location name.
name str: The regional service name.
status str: Describes the status of a service.

location String: The location name.
name String: The regional service name.
status String: Describes the status of a service.

DataTransferServiceResourcePropertiesResponse

CreationTime string: Time of the last state change (ISO-8601 format).
Locations List<Pulumi.AzureNative.DocumentDB.Inputs.DataTransferRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.

CreationTime string: Time of the last state change (ISO-8601 format).
Locations []DataTransferRegionalServiceResourceResponse: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<DataTransferRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Integer: Instance count for the service.
instanceSize String: Instance type for the service.

creationTime string: Time of the last state change (ISO-8601 format).
locations DataTransferRegionalServiceResourceResponse[]: An array that contains all of the locations for the service.
status string: Describes the status of a service.
instanceCount number: Instance count for the service.
instanceSize string: Instance type for the service.

creation_time str: Time of the last state change (ISO-8601 format).
locations Sequence[DataTransferRegionalServiceResourceResponse]: An array that contains all of the locations for the service.
status str: Describes the status of a service.
instance_count int: Instance count for the service.
instance_size str: Instance type for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<Property Map>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Number: Instance count for the service.
instanceSize String: Instance type for the service.

ServiceSize

Cosmos_D4s: Cosmos.D4s
Cosmos_D8s: Cosmos.D8s
Cosmos_D16s: Cosmos.D16s

ServiceSize_Cosmos_D4s: Cosmos.D4s
ServiceSize_Cosmos_D8s: Cosmos.D8s
ServiceSize_Cosmos_D16s: Cosmos.D16s

Cosmos_D4s: Cosmos.D4s
Cosmos_D8s: Cosmos.D8s
Cosmos_D16s: Cosmos.D16s

Cosmos_D4s: Cosmos.D4s
Cosmos_D8s: Cosmos.D8s
Cosmos_D16s: Cosmos.D16s

COSMOS_D4S: Cosmos.D4s
COSMOS_D8S: Cosmos.D8s
COSMOS_D16S: Cosmos.D16s

"Cosmos.D4s": Cosmos.D4s
"Cosmos.D8s": Cosmos.D8s
"Cosmos.D16s": Cosmos.D16s

ServiceType

SqlDedicatedGateway: SqlDedicatedGateway
DataTransfer: DataTransfer

ServiceTypeSqlDedicatedGateway: SqlDedicatedGateway
ServiceTypeDataTransfer: DataTransfer

SqlDedicatedGateway: SqlDedicatedGateway
DataTransfer: DataTransfer

SqlDedicatedGateway: SqlDedicatedGateway
DataTransfer: DataTransfer

SQL_DEDICATED_GATEWAY: SqlDedicatedGateway
DATA_TRANSFER: DataTransfer

"SqlDedicatedGateway": SqlDedicatedGateway
"DataTransfer": DataTransfer

SqlDedicatedGatewayRegionalServiceResourceResponse

Location string: The location name.
Name string: The regional service name.
SqlDedicatedGatewayEndpoint string: The regional endpoint for SqlDedicatedGateway.
Status string: Describes the status of a service.

Location string: The location name.
Name string: The regional service name.
SqlDedicatedGatewayEndpoint string: The regional endpoint for SqlDedicatedGateway.
Status string: Describes the status of a service.

location String: The location name.
name String: The regional service name.
sqlDedicatedGatewayEndpoint String: The regional endpoint for SqlDedicatedGateway.
status String: Describes the status of a service.

location string: The location name.
name string: The regional service name.
sqlDedicatedGatewayEndpoint string: The regional endpoint for SqlDedicatedGateway.
status string: Describes the status of a service.

location str: The location name.
name str: The regional service name.
sql_dedicated_gateway_endpoint str: The regional endpoint for SqlDedicatedGateway.
status str: Describes the status of a service.

location String: The location name.
name String: The regional service name.
sqlDedicatedGatewayEndpoint String: The regional endpoint for SqlDedicatedGateway.
status String: Describes the status of a service.

SqlDedicatedGatewayServiceResourcePropertiesResponse

CreationTime string: Time of the last state change (ISO-8601 format).
Locations List<Pulumi.AzureNative.DocumentDB.Inputs.SqlDedicatedGatewayRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.
SqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

CreationTime string: Time of the last state change (ISO-8601 format).
Locations []SqlDedicatedGatewayRegionalServiceResourceResponse: An array that contains all of the locations for the service.
Status string: Describes the status of a service.
InstanceCount int: Instance count for the service.
InstanceSize string: Instance type for the service.
SqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<SqlDedicatedGatewayRegionalServiceResourceResponse>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Integer: Instance count for the service.
instanceSize String: Instance type for the service.
sqlDedicatedGatewayEndpoint String: SqlDedicatedGateway endpoint for the service.

creationTime string: Time of the last state change (ISO-8601 format).
locations SqlDedicatedGatewayRegionalServiceResourceResponse[]: An array that contains all of the locations for the service.
status string: Describes the status of a service.
instanceCount number: Instance count for the service.
instanceSize string: Instance type for the service.
sqlDedicatedGatewayEndpoint string: SqlDedicatedGateway endpoint for the service.

creation_time str: Time of the last state change (ISO-8601 format).
locations Sequence[SqlDedicatedGatewayRegionalServiceResourceResponse]: An array that contains all of the locations for the service.
status str: Describes the status of a service.
instance_count int: Instance count for the service.
instance_size str: Instance type for the service.
sql_dedicated_gateway_endpoint str: SqlDedicatedGateway endpoint for the service.

creationTime String: Time of the last state change (ISO-8601 format).
locations List<Property Map>: An array that contains all of the locations for the service.
status String: Describes the status of a service.
instanceCount Number: Instance count for the service.
instanceSize String: Instance type for the service.
sqlDedicatedGatewayEndpoint String: SqlDedicatedGateway endpoint for the service.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:documentdb:Service SqlDedicatedGateway /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/SqlDedicatedGateway

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0