azure-native.cosmosdb.Fleetspace
Explore with Pulumi AI
An Azure Cosmos DB Fleetspace.
Uses Azure REST API version 2025-05-01-preview.
Example Usage
CosmosDB Fleetspace Create
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var fleetspace = new AzureNative.CosmosDB.Fleetspace("fleetspace", new()
{
FleetName = "fleet1",
FleetspaceApiKind = AzureNative.CosmosDB.FleetspaceApiKind.NoSQL,
FleetspaceName = "fleetspace1",
ResourceGroupName = "rg1",
ThroughputPoolConfiguration = new AzureNative.CosmosDB.Inputs.FleetspacePropertiesThroughputPoolConfigurationArgs
{
DataRegions = new[]
{
"westus2",
},
MaxThroughput = 500000,
MinThroughput = 100000,
ServiceTier = AzureNative.CosmosDB.ServiceTier.GeneralPurpose,
},
});
});
package main
import (
cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cosmosdb.NewFleetspace(ctx, "fleetspace", &cosmosdb.FleetspaceArgs{
FleetName: pulumi.String("fleet1"),
FleetspaceApiKind: pulumi.String(cosmosdb.FleetspaceApiKindNoSQL),
FleetspaceName: pulumi.String("fleetspace1"),
ResourceGroupName: pulumi.String("rg1"),
ThroughputPoolConfiguration: &cosmosdb.FleetspacePropertiesThroughputPoolConfigurationArgs{
DataRegions: pulumi.StringArray{
pulumi.String("westus2"),
},
MaxThroughput: pulumi.Int(500000),
MinThroughput: pulumi.Int(100000),
ServiceTier: pulumi.String(cosmosdb.ServiceTierGeneralPurpose),
},
})
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.cosmosdb.Fleetspace;
import com.pulumi.azurenative.cosmosdb.FleetspaceArgs;
import com.pulumi.azurenative.cosmosdb.inputs.FleetspacePropertiesThroughputPoolConfigurationArgs;
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 fleetspace = new Fleetspace("fleetspace", FleetspaceArgs.builder()
.fleetName("fleet1")
.fleetspaceApiKind("NoSQL")
.fleetspaceName("fleetspace1")
.resourceGroupName("rg1")
.throughputPoolConfiguration(FleetspacePropertiesThroughputPoolConfigurationArgs.builder()
.dataRegions("westus2")
.maxThroughput(500000)
.minThroughput(100000)
.serviceTier("GeneralPurpose")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fleetspace = new azure_native.cosmosdb.Fleetspace("fleetspace", {
fleetName: "fleet1",
fleetspaceApiKind: azure_native.cosmosdb.FleetspaceApiKind.NoSQL,
fleetspaceName: "fleetspace1",
resourceGroupName: "rg1",
throughputPoolConfiguration: {
dataRegions: ["westus2"],
maxThroughput: 500000,
minThroughput: 100000,
serviceTier: azure_native.cosmosdb.ServiceTier.GeneralPurpose,
},
});
import pulumi
import pulumi_azure_native as azure_native
fleetspace = azure_native.cosmosdb.Fleetspace("fleetspace",
fleet_name="fleet1",
fleetspace_api_kind=azure_native.cosmosdb.FleetspaceApiKind.NO_SQL,
fleetspace_name="fleetspace1",
resource_group_name="rg1",
throughput_pool_configuration={
"data_regions": ["westus2"],
"max_throughput": 500000,
"min_throughput": 100000,
"service_tier": azure_native.cosmosdb.ServiceTier.GENERAL_PURPOSE,
})
resources:
fleetspace:
type: azure-native:cosmosdb:Fleetspace
properties:
fleetName: fleet1
fleetspaceApiKind: NoSQL
fleetspaceName: fleetspace1
resourceGroupName: rg1
throughputPoolConfiguration:
dataRegions:
- westus2
maxThroughput: 500000
minThroughput: 100000
serviceTier: GeneralPurpose
Create Fleetspace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fleetspace(name: string, args: FleetspaceArgs, opts?: CustomResourceOptions);
@overload
def Fleetspace(resource_name: str,
args: FleetspaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Fleetspace(resource_name: str,
opts: Optional[ResourceOptions] = None,
fleet_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
fleetspace_api_kind: Optional[Union[str, FleetspaceApiKind]] = None,
fleetspace_name: Optional[str] = None,
throughput_pool_configuration: Optional[FleetspacePropertiesThroughputPoolConfigurationArgs] = None)
func NewFleetspace(ctx *Context, name string, args FleetspaceArgs, opts ...ResourceOption) (*Fleetspace, error)
public Fleetspace(string name, FleetspaceArgs args, CustomResourceOptions? opts = null)
public Fleetspace(String name, FleetspaceArgs args)
public Fleetspace(String name, FleetspaceArgs args, CustomResourceOptions options)
type: azure-native:cosmosdb:Fleetspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FleetspaceArgs
- 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 FleetspaceArgs
- 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 FleetspaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetspaceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var fleetspaceResource = new AzureNative.CosmosDB.Fleetspace("fleetspaceResource", new()
{
FleetName = "string",
ResourceGroupName = "string",
FleetspaceApiKind = "string",
FleetspaceName = "string",
ThroughputPoolConfiguration = new AzureNative.CosmosDB.Inputs.FleetspacePropertiesThroughputPoolConfigurationArgs
{
DataRegions = new[]
{
"string",
},
MaxThroughput = 0,
MinThroughput = 0,
ServiceTier = "string",
},
});
example, err := cosmosdb.NewFleetspace(ctx, "fleetspaceResource", &cosmosdb.FleetspaceArgs{
FleetName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
FleetspaceApiKind: pulumi.String("string"),
FleetspaceName: pulumi.String("string"),
ThroughputPoolConfiguration: &cosmosdb.FleetspacePropertiesThroughputPoolConfigurationArgs{
DataRegions: pulumi.StringArray{
pulumi.String("string"),
},
MaxThroughput: pulumi.Int(0),
MinThroughput: pulumi.Int(0),
ServiceTier: pulumi.String("string"),
},
})
var fleetspaceResource = new com.pulumi.azurenative.cosmosdb.Fleetspace("fleetspaceResource", com.pulumi.azurenative.cosmosdb.FleetspaceArgs.builder()
.fleetName("string")
.resourceGroupName("string")
.fleetspaceApiKind("string")
.fleetspaceName("string")
.throughputPoolConfiguration(FleetspacePropertiesThroughputPoolConfigurationArgs.builder()
.dataRegions("string")
.maxThroughput(0)
.minThroughput(0)
.serviceTier("string")
.build())
.build());
fleetspace_resource = azure_native.cosmosdb.Fleetspace("fleetspaceResource",
fleet_name="string",
resource_group_name="string",
fleetspace_api_kind="string",
fleetspace_name="string",
throughput_pool_configuration={
"data_regions": ["string"],
"max_throughput": 0,
"min_throughput": 0,
"service_tier": "string",
})
const fleetspaceResource = new azure_native.cosmosdb.Fleetspace("fleetspaceResource", {
fleetName: "string",
resourceGroupName: "string",
fleetspaceApiKind: "string",
fleetspaceName: "string",
throughputPoolConfiguration: {
dataRegions: ["string"],
maxThroughput: 0,
minThroughput: 0,
serviceTier: "string",
},
});
type: azure-native:cosmosdb:Fleetspace
properties:
fleetName: string
fleetspaceApiKind: string
fleetspaceName: string
resourceGroupName: string
throughputPoolConfiguration:
dataRegions:
- string
maxThroughput: 0
minThroughput: 0
serviceTier: string
Fleetspace Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Fleetspace resource accepts the following input properties:
- Fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Fleetspace
Api string | Pulumi.Kind Azure Native. Cosmos DB. Fleetspace Api Kind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- Fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- Throughput
Pool Pulumi.Configuration Azure Native. Cosmos DB. Inputs. Fleetspace Properties Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- Fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Fleetspace
Api string | FleetspaceKind Api Kind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- Fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- Throughput
Pool FleetspaceConfiguration Properties Throughput Pool Configuration Args - Configuration for throughput pool in the fleetspace.
- fleet
Name String - Cosmos DB fleet name. Needs to be unique under a subscription.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- fleetspace
Api String | FleetspaceKind Api Kind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- fleetspace
Name String - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- throughput
Pool FleetspaceConfiguration Properties Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- fleetspace
Api string | FleetspaceKind Api Kind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- throughput
Pool FleetspaceConfiguration Properties Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- fleet_
name str - Cosmos DB fleet name. Needs to be unique under a subscription.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- fleetspace_
api_ str | Fleetspacekind Api Kind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- fleetspace_
name str - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- throughput_
pool_ Fleetspaceconfiguration Properties Throughput Pool Configuration Args - Configuration for throughput pool in the fleetspace.
- fleet
Name String - Cosmos DB fleet name. Needs to be unique under a subscription.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- fleetspace
Api String | "NoKind SQL" - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- fleetspace
Name String - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- throughput
Pool Property MapConfiguration - Configuration for throughput pool in the fleetspace.
Outputs
All input properties are implicitly available as output properties. Additionally, the Fleetspace resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - A provisioning state of the Fleetspace.
- System
Data Pulumi.Azure Native. Cosmos DB. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - A provisioning state of the Fleetspace.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - A provisioning state of the Fleetspace.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - A provisioning state of the Fleetspace.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - A provisioning state of the Fleetspace.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - A provisioning state of the Fleetspace.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
FleetspaceApiKind, FleetspaceApiKindArgs
- No
SQL - NoSQL
- Fleetspace
Api Kind No SQL - NoSQL
- No
SQL - NoSQL
- No
SQL - NoSQL
- NO_SQL
- NoSQL
- "No
SQL" - NoSQL
FleetspacePropertiesResponseThroughputPoolConfiguration, FleetspacePropertiesResponseThroughputPoolConfigurationArgs
- Data
Regions List<string> - List of data regions assigned to the fleetspace. Eg [westus2]
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- Service
Tier string - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- Data
Regions []string - List of data regions assigned to the fleetspace. Eg [westus2]
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- Service
Tier string - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput Integer - Maximum throughput for the pool.
- min
Throughput Integer - Minimum throughput for the pool.
- service
Tier String - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions string[] - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput number - Maximum throughput for the pool.
- min
Throughput number - Minimum throughput for the pool.
- service
Tier string - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data_
regions Sequence[str] - List of data regions assigned to the fleetspace. Eg [westus2]
- max_
throughput int - Maximum throughput for the pool.
- min_
throughput int - Minimum throughput for the pool.
- service_
tier str - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput Number - Maximum throughput for the pool.
- min
Throughput Number - Minimum throughput for the pool.
- service
Tier String - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
FleetspacePropertiesThroughputPoolConfiguration, FleetspacePropertiesThroughputPoolConfigurationArgs
- Data
Regions List<string> - List of data regions assigned to the fleetspace. Eg [westus2]
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- Service
Tier string | Pulumi.Azure Native. Cosmos DB. Service Tier - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- Data
Regions []string - List of data regions assigned to the fleetspace. Eg [westus2]
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- Service
Tier string | ServiceTier - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput Integer - Maximum throughput for the pool.
- min
Throughput Integer - Minimum throughput for the pool.
- service
Tier String | ServiceTier - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions string[] - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput number - Maximum throughput for the pool.
- min
Throughput number - Minimum throughput for the pool.
- service
Tier string | ServiceTier - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data_
regions Sequence[str] - List of data regions assigned to the fleetspace. Eg [westus2]
- max_
throughput int - Maximum throughput for the pool.
- min_
throughput int - Minimum throughput for the pool.
- service_
tier str | ServiceTier - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- max
Throughput Number - Maximum throughput for the pool.
- min
Throughput Number - Minimum throughput for the pool.
- service
Tier String | "GeneralPurpose" | "Business Critical" - Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region.
ServiceTier, ServiceTierArgs
- General
Purpose - GeneralPurpose
- Business
Critical - BusinessCritical
- Service
Tier General Purpose - GeneralPurpose
- Service
Tier Business Critical - BusinessCritical
- General
Purpose - GeneralPurpose
- Business
Critical - BusinessCritical
- General
Purpose - GeneralPurpose
- Business
Critical - BusinessCritical
- GENERAL_PURPOSE
- GeneralPurpose
- BUSINESS_CRITICAL
- BusinessCritical
- "General
Purpose" - GeneralPurpose
- "Business
Critical" - BusinessCritical
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cosmosdb:Fleetspace fleetspace1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0