Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getFleetspace
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getFleetspace

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet

    Uses Azure REST API version 2025-05-01-preview.

    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 dictionary

    The following arguments are supported:

    FleetName string
    Cosmos DB fleet name. Needs to be unique under a subscription.
    FleetspaceName string
    Cosmos DB fleetspace name. Needs to be unique under a fleet.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FleetName string
    Cosmos DB fleet name. Needs to be unique under a subscription.
    FleetspaceName string
    Cosmos DB fleetspace name. Needs to be unique under a fleet.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    fleetName String
    Cosmos DB fleet name. Needs to be unique under a subscription.
    fleetspaceName String
    Cosmos DB fleetspace name. Needs to be unique under a fleet.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    fleetName string
    Cosmos DB fleet name. Needs to be unique under a subscription.
    fleetspaceName string
    Cosmos DB fleetspace name. Needs to be unique under a fleet.
    resourceGroupName string
    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_name str
    The name of the resource group. The name is case insensitive.
    fleetName String
    Cosmos DB fleet name. Needs to be unique under a subscription.
    fleetspaceName String
    Cosmos DB fleetspace name. Needs to be unique under a fleet.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getFleetspace Result

    The following output properties are available:

    AzureApiVersion string
    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
    ProvisioningState string
    A provisioning state of the Fleetspace.
    SystemData Pulumi.AzureNative.CosmosDB.Outputs.SystemDataResponse
    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"
    FleetspaceApiKind string
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    ThroughputPoolConfiguration Pulumi.AzureNative.CosmosDB.Outputs.FleetspacePropertiesResponseThroughputPoolConfiguration
    Configuration for throughput pool in the fleetspace.
    AzureApiVersion string
    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
    ProvisioningState string
    A provisioning state of the Fleetspace.
    SystemData SystemDataResponse
    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"
    FleetspaceApiKind string
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    ThroughputPoolConfiguration FleetspacePropertiesResponseThroughputPoolConfiguration
    Configuration for throughput pool in the fleetspace.
    azureApiVersion String
    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
    provisioningState String
    A provisioning state of the Fleetspace.
    systemData SystemDataResponse
    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"
    fleetspaceApiKind String
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    throughputPoolConfiguration FleetspacePropertiesResponseThroughputPoolConfiguration
    Configuration for throughput pool in the fleetspace.
    azureApiVersion string
    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
    provisioningState string
    A provisioning state of the Fleetspace.
    systemData SystemDataResponse
    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"
    fleetspaceApiKind string
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    throughputPoolConfiguration FleetspacePropertiesResponseThroughputPoolConfiguration
    Configuration for throughput pool in the fleetspace.
    azure_api_version str
    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 SystemDataResponse
    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"
    fleetspace_api_kind str
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    throughput_pool_configuration FleetspacePropertiesResponseThroughputPoolConfiguration
    Configuration for throughput pool in the fleetspace.
    azureApiVersion String
    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
    provisioningState String
    A provisioning state of the Fleetspace.
    systemData 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"
    fleetspaceApiKind String
    The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'
    throughputPoolConfiguration Property Map
    Configuration for throughput pool in the fleetspace.

    Supporting Types

    FleetspacePropertiesResponseThroughputPoolConfiguration

    DataRegions List<string>
    List of data regions assigned to the fleetspace. Eg [westus2]
    MaxThroughput int
    Maximum throughput for the pool.
    MinThroughput int
    Minimum throughput for the pool.
    ServiceTier 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.
    DataRegions []string
    List of data regions assigned to the fleetspace. Eg [westus2]
    MaxThroughput int
    Maximum throughput for the pool.
    MinThroughput int
    Minimum throughput for the pool.
    ServiceTier 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.
    dataRegions List<String>
    List of data regions assigned to the fleetspace. Eg [westus2]
    maxThroughput Integer
    Maximum throughput for the pool.
    minThroughput Integer
    Minimum throughput for the pool.
    serviceTier 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.
    dataRegions string[]
    List of data regions assigned to the fleetspace. Eg [westus2]
    maxThroughput number
    Maximum throughput for the pool.
    minThroughput number
    Minimum throughput for the pool.
    serviceTier 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.
    dataRegions List<String>
    List of data regions assigned to the fleetspace. Eg [westus2]
    maxThroughput Number
    Maximum throughput for the pool.
    minThroughput Number
    Minimum throughput for the pool.
    serviceTier 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.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native