azure-native.cosmosdb.Fleet
Explore with Pulumi AI
An Azure Cosmos DB FleetResource.
Uses Azure REST API version 2025-05-01-preview.
Example Usage
CosmosDB Fleet Create
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var fleet = new AzureNative.CosmosDB.Fleet("fleet", new()
{
FleetName = "fleet1",
Location = "West US",
ResourceGroupName = "rg1",
Tags =
{
{ "Dept", "Finance" },
{ "Environment", "Production" },
},
});
});
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.NewFleet(ctx, "fleet", &cosmosdb.FleetArgs{
FleetName: pulumi.String("fleet1"),
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("rg1"),
Tags: pulumi.StringMap{
"Dept": pulumi.String("Finance"),
"Environment": pulumi.String("Production"),
},
})
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.Fleet;
import com.pulumi.azurenative.cosmosdb.FleetArgs;
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 fleet = new Fleet("fleet", FleetArgs.builder()
.fleetName("fleet1")
.location("West US")
.resourceGroupName("rg1")
.tags(Map.ofEntries(
Map.entry("Dept", "Finance"),
Map.entry("Environment", "Production")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fleet = new azure_native.cosmosdb.Fleet("fleet", {
fleetName: "fleet1",
location: "West US",
resourceGroupName: "rg1",
tags: {
Dept: "Finance",
Environment: "Production",
},
});
import pulumi
import pulumi_azure_native as azure_native
fleet = azure_native.cosmosdb.Fleet("fleet",
fleet_name="fleet1",
location="West US",
resource_group_name="rg1",
tags={
"Dept": "Finance",
"Environment": "Production",
})
resources:
fleet:
type: azure-native:cosmosdb:Fleet
properties:
fleetName: fleet1
location: West US
resourceGroupName: rg1
tags:
Dept: Finance
Environment: Production
Create Fleet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fleet(name: string, args: FleetArgs, opts?: CustomResourceOptions);
@overload
def Fleet(resource_name: str,
args: FleetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Fleet(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
fleet_name: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewFleet(ctx *Context, name string, args FleetArgs, opts ...ResourceOption) (*Fleet, error)
public Fleet(string name, FleetArgs args, CustomResourceOptions? opts = null)
type: azure-native:cosmosdb:Fleet
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 FleetArgs
- 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 FleetArgs
- 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 FleetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetArgs
- 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 examplefleetResourceResourceFromCosmosdb = new AzureNative.CosmosDB.Fleet("examplefleetResourceResourceFromCosmosdb", new()
{
ResourceGroupName = "string",
FleetName = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := cosmosdb.NewFleet(ctx, "examplefleetResourceResourceFromCosmosdb", &cosmosdb.FleetArgs{
ResourceGroupName: pulumi.String("string"),
FleetName: pulumi.String("string"),
Location: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var examplefleetResourceResourceFromCosmosdb = new com.pulumi.azurenative.cosmosdb.Fleet("examplefleetResourceResourceFromCosmosdb", com.pulumi.azurenative.cosmosdb.FleetArgs.builder()
.resourceGroupName("string")
.fleetName("string")
.location("string")
.tags(Map.of("string", "string"))
.build());
examplefleet_resource_resource_from_cosmosdb = azure_native.cosmosdb.Fleet("examplefleetResourceResourceFromCosmosdb",
resource_group_name="string",
fleet_name="string",
location="string",
tags={
"string": "string",
})
const examplefleetResourceResourceFromCosmosdb = new azure_native.cosmosdb.Fleet("examplefleetResourceResourceFromCosmosdb", {
resourceGroupName: "string",
fleetName: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:cosmosdb:Fleet
properties:
fleetName: string
location: string
resourceGroupName: string
tags:
string: string
Fleet 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 Fleet resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- fleet
Name String - Cosmos DB fleet name. Needs to be unique under a subscription.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- fleet_
name str - Cosmos DB fleet name. Needs to be unique under a subscription.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- fleet
Name String - Cosmos DB fleet name. Needs to be unique under a subscription.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Fleet 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 Fleet.
- 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 Fleet.
- 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 Fleet.
- 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 Fleet.
- 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 Fleet.
- 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 Fleet.
- 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
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:Fleet fleet1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0