Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet
Uses Azure REST API version 2025-10-15.
Other available API versions: 2025-05-01-preview, 2025-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.
Using getFleetspace
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 getFleetspace(args: GetFleetspaceArgs, opts?: InvokeOptions): Promise<GetFleetspaceResult>
function getFleetspaceOutput(args: GetFleetspaceOutputArgs, opts?: InvokeOptions): Output<GetFleetspaceResult>def get_fleetspace(fleet_name: Optional[str] = None,
fleetspace_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFleetspaceResult
def get_fleetspace_output(fleet_name: Optional[pulumi.Input[str]] = None,
fleetspace_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFleetspaceResult]func LookupFleetspace(ctx *Context, args *LookupFleetspaceArgs, opts ...InvokeOption) (*LookupFleetspaceResult, error)
func LookupFleetspaceOutput(ctx *Context, args *LookupFleetspaceOutputArgs, opts ...InvokeOption) LookupFleetspaceResultOutput> Note: This function is named LookupFleetspace in the Go SDK.
public static class GetFleetspace
{
public static Task<GetFleetspaceResult> InvokeAsync(GetFleetspaceArgs args, InvokeOptions? opts = null)
public static Output<GetFleetspaceResult> Invoke(GetFleetspaceInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetFleetspaceResult> getFleetspace(GetFleetspaceArgs args, InvokeOptions options)
public static Output<GetFleetspaceResult> getFleetspace(GetFleetspaceArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cosmosdb:getFleetspace
arguments:
# arguments dictionaryThe following arguments are supported:
- Fleet
Name string - Cosmos DB fleet name. Needs to be unique under a subscription.
- Fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- 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.
- Fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- 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.
- fleetspace
Name String - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- 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.
- fleetspace
Name string - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- resource
Group stringName - 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.
- fleetspace_
name str - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- resource_
group_ strname - 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.
- fleetspace
Name String - Cosmos DB fleetspace name. Needs to be unique under a fleet.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getFleetspace Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- Data
Regions List<string> - List of data regions assigned to the fleetspace. Eg [westus2]
- Fleetspace
Api stringKind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- Throughput
Pool Pulumi.Configuration Azure Native. Cosmos DB. Outputs. Fleetspace Properties Response Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- Data
Regions []string - List of data regions assigned to the fleetspace. Eg [westus2]
- Fleetspace
Api stringKind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- Throughput
Pool FleetspaceConfiguration Properties Response Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- fleetspace
Api StringKind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- throughput
Pool FleetspaceConfiguration Properties Response Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- data
Regions string[] - List of data regions assigned to the fleetspace. Eg [westus2]
- fleetspace
Api stringKind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- throughput
Pool FleetspaceConfiguration Properties Response Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- data_
regions Sequence[str] - List of data regions assigned to the fleetspace. Eg [westus2]
- fleetspace_
api_ strkind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- throughput_
pool_ Fleetspaceconfiguration Properties Response Throughput Pool Configuration - Configuration for throughput pool in the fleetspace.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- 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"
- data
Regions List<String> - List of data regions assigned to the fleetspace. Eg [westus2]
- fleetspace
Api StringKind - The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
- 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.
- throughput
Pool Property MapConfiguration - Configuration for throughput pool in the fleetspace.
Supporting Types
FleetspacePropertiesResponseThroughputPoolConfiguration
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- Max
Throughput int - Maximum throughput for the pool.
- Min
Throughput int - Minimum throughput for the pool.
- max
Throughput Integer - Maximum throughput for the pool.
- min
Throughput Integer - Minimum throughput for the pool.
- max
Throughput number - Maximum throughput for the pool.
- min
Throughput number - Minimum throughput for the pool.
- max_
throughput int - Maximum throughput for the pool.
- min_
throughput int - Minimum throughput for the pool.
- max
Throughput Number - Maximum throughput for the pool.
- min
Throughput Number - Minimum throughput for the pool.
SystemDataResponse
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
