azure-native.networkcloud.getClusterManager
Explore with Pulumi AI
Get the properties of the provided cluster manager.
Uses Azure REST API version 2025-02-01.
Other available API versions: 2023-10-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native networkcloud [ApiVersion]
. See the version guide for details.
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)
public static Output<GetClusterManagerResult> getClusterManager(GetClusterManagerArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:networkcloud:getClusterManager
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Manager stringName - The name of the cluster manager.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Cluster
Manager stringName - The name of the cluster manager.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster
Manager StringName - The name of the cluster manager.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- cluster
Manager stringName - The name of the cluster manager.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster_
manager_ strname - The name of the cluster manager.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- cluster
Manager StringName - The name of the cluster manager.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getClusterManager Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Cluster
Versions List<Pulumi.Azure Native. Network Cloud. Outputs. Cluster Available Version Response> - The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
- Detailed
Status string - The detailed status that provides additional information about the cluster manager.
- Detailed
Status stringMessage - The descriptive message about the current detailed status.
- Etag string
- Resource ETag.
- Fabric
Controller stringId - 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
- Manager
Extended Pulumi.Location Azure Native. Network Cloud. Outputs. Extended Location Response - 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
- Provisioning
State string - The provisioning state of the cluster manager.
- System
Data Pulumi.Azure Native. Network Cloud. 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"
- Analytics
Workspace stringId - The resource ID of the Log Analytics workspace that is used for the logs collection.
- Availability
Zones 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.
- Identity
Pulumi.
Azure Native. Network Cloud. Outputs. Managed Service Identity Response - The identity of the cluster manager.
- Managed
Resource Pulumi.Group Configuration Azure Native. Network Cloud. Outputs. Managed Resource Group Configuration Response - The configuration of the managed resource group associated with the resource.
- Dictionary<string, string>
- Resource tags.
- Vm
Size 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.
- Azure
Api stringVersion - The Azure API version of the resource.
- Cluster
Versions []ClusterAvailable Version Response - The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
- Detailed
Status string - The detailed status that provides additional information about the cluster manager.
- Detailed
Status stringMessage - The descriptive message about the current detailed status.
- Etag string
- Resource ETag.
- Fabric
Controller stringId - 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
- Manager
Extended ExtendedLocation Location Response - 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
- Provisioning
State string - The provisioning state of the cluster manager.
- 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"
- Analytics
Workspace stringId - The resource ID of the Log Analytics workspace that is used for the logs collection.
- Availability
Zones []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.
- Identity
Managed
Service Identity Response - The identity of the cluster manager.
- Managed
Resource ManagedGroup Configuration Resource Group Configuration Response - The configuration of the managed resource group associated with the resource.
- map[string]string
- Resource tags.
- Vm
Size 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.
- azure
Api StringVersion - The Azure API version of the resource.
- cluster
Versions List<ClusterAvailable Version Response> - The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
- detailed
Status String - The detailed status that provides additional information about the cluster manager.
- detailed
Status StringMessage - The descriptive message about the current detailed status.
- etag String
- Resource ETag.
- fabric
Controller StringId - 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
- manager
Extended ExtendedLocation Location Response - 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
- provisioning
State String - The provisioning state of the cluster manager.
- 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"
- analytics
Workspace StringId - The resource ID of the Log Analytics workspace that is used for the logs collection.
- availability
Zones 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.
- identity
Managed
Service Identity Response - The identity of the cluster manager.
- managed
Resource ManagedGroup Configuration Resource Group Configuration Response - The configuration of the managed resource group associated with the resource.
- Map<String,String>
- Resource tags.
- vm
Size 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.
- azure
Api stringVersion - The Azure API version of the resource.
- cluster
Versions ClusterAvailable Version Response[] - The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
- detailed
Status string - The detailed status that provides additional information about the cluster manager.
- detailed
Status stringMessage - The descriptive message about the current detailed status.
- etag string
- Resource ETag.
- fabric
Controller stringId - 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
- manager
Extended ExtendedLocation Location Response - 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
- provisioning
State string - The provisioning state of the cluster manager.
- 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"
- analytics
Workspace stringId - The resource ID of the Log Analytics workspace that is used for the logs collection.
- availability
Zones 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.
- identity
Managed
Service Identity Response - The identity of the cluster manager.
- managed
Resource ManagedGroup Configuration Resource Group Configuration Response - The configuration of the managed resource group associated with the resource.
- {[key: string]: string}
- Resource tags.
- vm
Size 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.
- azure_
api_ strversion - The Azure API version of the resource.
- cluster_
versions Sequence[ClusterAvailable Version Response] - 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_ strmessage - The descriptive message about the current detailed status.
- etag str
- Resource ETag.
- fabric_
controller_ strid - 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_ Extendedlocation Location Response - 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 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"
- analytics_
workspace_ strid - 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.
- identity
Managed
Service Identity Response - The identity of the cluster manager.
- managed_
resource_ Managedgroup_ configuration Resource Group Configuration Response - The configuration of the managed resource group associated with the resource.
- 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.
- azure
Api StringVersion - The Azure API version of the resource.
- cluster
Versions List<Property Map> - The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
- detailed
Status String - The detailed status that provides additional information about the cluster manager.
- detailed
Status StringMessage - The descriptive message about the current detailed status.
- etag String
- Resource ETag.
- fabric
Controller StringId - 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
- manager
Extended Property MapLocation - 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
- provisioning
State String - The provisioning state of the cluster manager.
- 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"
- analytics
Workspace StringId - The resource ID of the Log Analytics workspace that is used for the logs collection.
- availability
Zones 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.
- identity Property Map
- The identity of the cluster manager.
- managed
Resource Property MapGroup Configuration - The configuration of the managed resource group associated with the resource.
- Map<String>
- Resource tags.
- vm
Size 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
- Support
Expiry stringDate - The last date the version of the platform is supported.
- Target
Cluster stringVersion - The version of the cluster to be deployed.
- Support
Expiry stringDate - The last date the version of the platform is supported.
- Target
Cluster stringVersion - The version of the cluster to be deployed.
- support
Expiry StringDate - The last date the version of the platform is supported.
- target
Cluster StringVersion - The version of the cluster to be deployed.
- support
Expiry stringDate - The last date the version of the platform is supported.
- target
Cluster stringVersion - The version of the cluster to be deployed.
- support_
expiry_ strdate - The last date the version of the platform is supported.
- target_
cluster_ strversion - The version of the cluster to be deployed.
- support
Expiry StringDate - The last date the version of the platform is supported.
- target
Cluster StringVersion - The version of the cluster to be deployed.
ExtendedLocationResponse
ManagedResourceGroupConfigurationResponse
ManagedServiceIdentityResponse
- Principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Network Cloud. Inputs. User Assigned Identity Response> - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- Principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- User
Assigned map[string]UserIdentities Assigned Identity Response - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- principal
Id String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- principal
Id string - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id string - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type string
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- principal_
id str - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant_
id str - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type str
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user_
assigned_ Mapping[str, Useridentities Assigned Identity Response] - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- principal
Id String - The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String - The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
- Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- user
Assigned Map<Property Map>Identities - The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
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.
UserAssignedIdentityResponse
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
- client
Id string - The client ID of the assigned identity.
- principal
Id string - The principal ID of the assigned identity.
- client_
id str - The client ID of the assigned identity.
- principal_
id str - The principal ID of the assigned identity.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0