1. Packages
  2. Azure Native
  3. API Docs
  4. eventhub
  5. getCluster
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.eventhub.getCluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Gets the resource description of the specified Event Hubs Cluster. Azure REST API version: 2022-10-01-preview.

    Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.

    Using getCluster

    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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
    function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(cluster_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetClusterResult
    def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
    func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
    {
        public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventhub:getCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Event Hubs Cluster.
    ResourceGroupName string
    Name of the resource group within the azure subscription.
    ClusterName string
    The name of the Event Hubs Cluster.
    ResourceGroupName string
    Name of the resource group within the azure subscription.
    clusterName String
    The name of the Event Hubs Cluster.
    resourceGroupName String
    Name of the resource group within the azure subscription.
    clusterName string
    The name of the Event Hubs Cluster.
    resourceGroupName string
    Name of the resource group within the azure subscription.
    cluster_name str
    The name of the Event Hubs Cluster.
    resource_group_name str
    Name of the resource group within the azure subscription.
    clusterName String
    The name of the Event Hubs Cluster.
    resourceGroupName String
    Name of the resource group within the azure subscription.

    getCluster Result

    The following output properties are available:

    CreatedAt string
    The UTC time when the Event Hubs Cluster was created.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    MetricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    Name string
    The name of the resource
    Status string
    Status of the Cluster resource
    SystemData Pulumi.AzureNative.EventHub.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UpdatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    Location string
    Resource location.
    Sku Pulumi.AzureNative.EventHub.Outputs.ClusterSkuResponse
    Properties of the cluster SKU.
    SupportsScaling bool
    A value that indicates whether Scaling is Supported.
    Tags Dictionary<string, string>
    Resource tags.
    CreatedAt string
    The UTC time when the Event Hubs Cluster was created.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    MetricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    Name string
    The name of the resource
    Status string
    Status of the Cluster resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UpdatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    Location string
    Resource location.
    Sku ClusterSkuResponse
    Properties of the cluster SKU.
    SupportsScaling bool
    A value that indicates whether Scaling is Supported.
    Tags map[string]string
    Resource tags.
    createdAt String
    The UTC time when the Event Hubs Cluster was created.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    metricId String
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name String
    The name of the resource
    status String
    Status of the Cluster resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt String
    The UTC time when the Event Hubs Cluster was last updated.
    location String
    Resource location.
    sku ClusterSkuResponse
    Properties of the cluster SKU.
    supportsScaling Boolean
    A value that indicates whether Scaling is Supported.
    tags Map<String,String>
    Resource tags.
    createdAt string
    The UTC time when the Event Hubs Cluster was created.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    metricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name string
    The name of the resource
    status string
    Status of the Cluster resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    location string
    Resource location.
    sku ClusterSkuResponse
    Properties of the cluster SKU.
    supportsScaling boolean
    A value that indicates whether Scaling is Supported.
    tags {[key: string]: string}
    Resource tags.
    created_at str
    The UTC time when the Event Hubs Cluster was created.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    metric_id str
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name str
    The name of the resource
    status str
    Status of the Cluster resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updated_at str
    The UTC time when the Event Hubs Cluster was last updated.
    location str
    Resource location.
    sku ClusterSkuResponse
    Properties of the cluster SKU.
    supports_scaling bool
    A value that indicates whether Scaling is Supported.
    tags Mapping[str, str]
    Resource tags.
    createdAt String
    The UTC time when the Event Hubs Cluster was created.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    metricId String
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name String
    The name of the resource
    status String
    Status of the Cluster resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt String
    The UTC time when the Event Hubs Cluster was last updated.
    location String
    Resource location.
    sku Property Map
    Properties of the cluster SKU.
    supportsScaling Boolean
    A value that indicates whether Scaling is Supported.
    tags Map<String>
    Resource tags.

    Supporting Types

    ClusterSkuResponse

    Name string
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    Name string
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String
    Name of this SKU.
    capacity Integer
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name string
    Name of this SKU.
    capacity number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name str
    Name of this SKU.
    capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String
    Name of this SKU.
    capacity Number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi