1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getClusterManager
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.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.networkcloud.getClusterManager

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.44.1 published on Thursday, Jun 6, 2024 by Pulumi

    Get the properties of the provided cluster manager. Azure REST API version: 2023-10-01-preview.

    Other available API versions: 2023-07-01.

    Using getClusterManager

    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 getClusterManager(args: GetClusterManagerArgs, opts?: InvokeOptions): Promise<GetClusterManagerResult>
    function getClusterManagerOutput(args: GetClusterManagerOutputArgs, opts?: InvokeOptions): Output<GetClusterManagerResult>
    def get_cluster_manager(cluster_manager_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetClusterManagerResult
    def get_cluster_manager_output(cluster_manager_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetClusterManagerResult]
    func LookupClusterManager(ctx *Context, args *LookupClusterManagerArgs, opts ...InvokeOption) (*LookupClusterManagerResult, error)
    func LookupClusterManagerOutput(ctx *Context, args *LookupClusterManagerOutputArgs, opts ...InvokeOption) LookupClusterManagerResultOutput

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

    public static class GetClusterManager 
    {
        public static Task<GetClusterManagerResult> InvokeAsync(GetClusterManagerArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterManagerResult> Invoke(GetClusterManagerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterManagerResult> getClusterManager(GetClusterManagerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:networkcloud:getClusterManager
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterManagerName string
    The name of the cluster manager.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterManagerName string
    The name of the cluster manager.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterManagerName String
    The name of the cluster manager.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterManagerName string
    The name of the cluster manager.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_manager_name str
    The name of the cluster manager.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterManagerName String
    The name of the cluster manager.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getClusterManager Result

    The following output properties are available:

    ClusterVersions List<Pulumi.AzureNative.NetworkCloud.Outputs.ClusterAvailableVersionResponse>
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    DetailedStatus string
    The detailed status that provides additional information about the cluster manager.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    FabricControllerId string
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    ManagerExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the cluster manager.
    SystemData Pulumi.AzureNative.NetworkCloud.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"
    AnalyticsWorkspaceId string
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    AvailabilityZones List<string>
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    ManagedResourceGroupConfiguration Pulumi.AzureNative.NetworkCloud.Outputs.ManagedResourceGroupConfigurationResponse
    The configuration of the managed resource group associated with the resource.
    Tags Dictionary<string, string>
    Resource tags.
    VmSize string
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.
    ClusterVersions []ClusterAvailableVersionResponse
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    DetailedStatus string
    The detailed status that provides additional information about the cluster manager.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    FabricControllerId string
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    ManagerExtendedLocation ExtendedLocationResponse
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the cluster manager.
    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"
    AnalyticsWorkspaceId string
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    AvailabilityZones []string
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    ManagedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    The configuration of the managed resource group associated with the resource.
    Tags map[string]string
    Resource tags.
    VmSize string
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.
    clusterVersions List<ClusterAvailableVersionResponse>
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    detailedStatus String
    The detailed status that provides additional information about the cluster manager.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    fabricControllerId String
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    managerExtendedLocation ExtendedLocationResponse
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the cluster manager.
    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"
    analyticsWorkspaceId String
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    availabilityZones List<String>
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    The configuration of the managed resource group associated with the resource.
    tags Map<String,String>
    Resource tags.
    vmSize String
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.
    clusterVersions ClusterAvailableVersionResponse[]
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    detailedStatus string
    The detailed status that provides additional information about the cluster manager.
    detailedStatusMessage string
    The descriptive message about the current detailed status.
    fabricControllerId string
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    managerExtendedLocation ExtendedLocationResponse
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the cluster manager.
    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"
    analyticsWorkspaceId string
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    availabilityZones string[]
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse
    The configuration of the managed resource group associated with the resource.
    tags {[key: string]: string}
    Resource tags.
    vmSize string
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.
    cluster_versions Sequence[ClusterAvailableVersionResponse]
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    detailed_status str
    The detailed status that provides additional information about the cluster manager.
    detailed_status_message str
    The descriptive message about the current detailed status.
    fabric_controller_id str
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    manager_extended_location ExtendedLocationResponse
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the cluster manager.
    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"
    analytics_workspace_id str
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    availability_zones Sequence[str]
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    managed_resource_group_configuration ManagedResourceGroupConfigurationResponse
    The configuration of the managed resource group associated with the resource.
    tags Mapping[str, str]
    Resource tags.
    vm_size str
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.
    clusterVersions List<Property Map>
    The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
    detailedStatus String
    The detailed status that provides additional information about the cluster manager.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    fabricControllerId String
    The resource ID of the fabric controller that has one to one mapping with the cluster manager.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    managerExtendedLocation Property Map
    The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the cluster manager.
    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"
    analyticsWorkspaceId String
    The resource ID of the Log Analytics workspace that is used for the logs collection.
    availabilityZones List<String>
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource.
    managedResourceGroupConfiguration Property Map
    The configuration of the managed resource group associated with the resource.
    tags Map<String>
    Resource tags.
    vmSize String
    Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource.

    Supporting Types

    ClusterAvailableVersionResponse

    SupportExpiryDate string
    The last date the version of the platform is supported.
    TargetClusterVersion string
    The version of the cluster to be deployed.
    SupportExpiryDate string
    The last date the version of the platform is supported.
    TargetClusterVersion string
    The version of the cluster to be deployed.
    supportExpiryDate String
    The last date the version of the platform is supported.
    targetClusterVersion String
    The version of the cluster to be deployed.
    supportExpiryDate string
    The last date the version of the platform is supported.
    targetClusterVersion string
    The version of the cluster to be deployed.
    support_expiry_date str
    The last date the version of the platform is supported.
    target_cluster_version str
    The version of the cluster to be deployed.
    supportExpiryDate String
    The last date the version of the platform is supported.
    targetClusterVersion String
    The version of the cluster to be deployed.

    ExtendedLocationResponse

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.

    ManagedResourceGroupConfigurationResponse

    Location string
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    Name string
    The name for the managed resource group. If not specified, the unique name is automatically generated.
    Location string
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    Name string
    The name for the managed resource group. If not specified, the unique name is automatically generated.
    location String
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    name String
    The name for the managed resource group. If not specified, the unique name is automatically generated.
    location string
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    name string
    The name for the managed resource group. If not specified, the unique name is automatically generated.
    location str
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    name str
    The name for the managed resource group. If not specified, the unique name is automatically generated.
    location String
    The location of the managed resource group. If not specified, the location of the parent resource is chosen.
    name String
    The name for the managed resource group. If not specified, the unique name is automatically generated.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi