1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

azure-native.networkcloud.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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

    Get properties of the provided cluster. Azure REST API version: 2023-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:networkcloud:getCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string

    The name of the cluster.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    ClusterName string

    The name of the cluster.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    clusterName String

    The name of the cluster.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    clusterName string

    The name of the cluster.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    cluster_name str

    The name of the cluster.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    clusterName String

    The name of the cluster.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    getCluster Result

    The following output properties are available:

    AggregatorOrSingleRackDefinition Pulumi.AzureNative.NetworkCloud.Outputs.RackDefinitionResponse

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    AvailableUpgradeVersions List<Pulumi.AzureNative.NetworkCloud.Outputs.ClusterAvailableUpgradeVersionResponse>

    The list of cluster runtime version upgrades available for this cluster.

    ClusterCapacity Pulumi.AzureNative.NetworkCloud.Outputs.ClusterCapacityResponse

    The capacity supported by this cluster.

    ClusterConnectionStatus string

    The latest heartbeat status between the cluster manager and the cluster.

    ClusterExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    ClusterManagerConnectionStatus string

    The latest connectivity status between cluster manager and the cluster.

    ClusterManagerId string

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    ClusterType string

    The type of rack configuration for the cluster.

    ClusterVersion string

    The current runtime version of the cluster.

    DetailedStatus string

    The current detailed status of the cluster.

    DetailedStatusMessage string

    The descriptive message about the detailed status.

    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse

    The extended location of the cluster manager associated with the cluster.

    HybridAksExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    ManualActionCount double

    The count of Manual Action Taken (MAT) events that have not been validated.

    Name string

    The name of the resource

    NetworkFabricId string

    The resource ID of the Network Fabric associated with the cluster.

    ProvisioningState string

    The provisioning state of the cluster.

    SupportExpiryDate string

    The support end date of the runtime version of the cluster.

    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"

    WorkloadResourceIds List<string>

    The list of workload resource IDs that are hosted within this cluster.

    AnalyticsWorkspaceId string

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    ClusterLocation string

    The customer-provided location information to identify where the cluster resides.

    ClusterServicePrincipal Pulumi.AzureNative.NetworkCloud.Outputs.ServicePrincipalInformationResponse

    The service principal to be used by the cluster during Arc Appliance installation.

    ComputeDeploymentThreshold Pulumi.AzureNative.NetworkCloud.Outputs.ValidationThresholdResponse

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    ComputeRackDefinitions List<Pulumi.AzureNative.NetworkCloud.Outputs.RackDefinitionResponse>

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    ManagedResourceGroupConfiguration Pulumi.AzureNative.NetworkCloud.Outputs.ManagedResourceGroupConfigurationResponse

    The configuration of the managed resource group associated with the resource.

    Tags Dictionary<string, string>

    Resource tags.

    AggregatorOrSingleRackDefinition RackDefinitionResponse

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    AvailableUpgradeVersions []ClusterAvailableUpgradeVersionResponse

    The list of cluster runtime version upgrades available for this cluster.

    ClusterCapacity ClusterCapacityResponse

    The capacity supported by this cluster.

    ClusterConnectionStatus string

    The latest heartbeat status between the cluster manager and the cluster.

    ClusterExtendedLocation ExtendedLocationResponse

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    ClusterManagerConnectionStatus string

    The latest connectivity status between cluster manager and the cluster.

    ClusterManagerId string

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    ClusterType string

    The type of rack configuration for the cluster.

    ClusterVersion string

    The current runtime version of the cluster.

    DetailedStatus string

    The current detailed status of the cluster.

    DetailedStatusMessage string

    The descriptive message about the detailed status.

    ExtendedLocation ExtendedLocationResponse

    The extended location of the cluster manager associated with the cluster.

    HybridAksExtendedLocation ExtendedLocationResponse

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    ManualActionCount float64

    The count of Manual Action Taken (MAT) events that have not been validated.

    Name string

    The name of the resource

    NetworkFabricId string

    The resource ID of the Network Fabric associated with the cluster.

    ProvisioningState string

    The provisioning state of the cluster.

    SupportExpiryDate string

    The support end date of the runtime version of the cluster.

    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"

    WorkloadResourceIds []string

    The list of workload resource IDs that are hosted within this cluster.

    AnalyticsWorkspaceId string

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    ClusterLocation string

    The customer-provided location information to identify where the cluster resides.

    ClusterServicePrincipal ServicePrincipalInformationResponse

    The service principal to be used by the cluster during Arc Appliance installation.

    ComputeDeploymentThreshold ValidationThresholdResponse

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    ComputeRackDefinitions []RackDefinitionResponse

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    ManagedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse

    The configuration of the managed resource group associated with the resource.

    Tags map[string]string

    Resource tags.

    aggregatorOrSingleRackDefinition RackDefinitionResponse

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    availableUpgradeVersions List<ClusterAvailableUpgradeVersionResponse>

    The list of cluster runtime version upgrades available for this cluster.

    clusterCapacity ClusterCapacityResponse

    The capacity supported by this cluster.

    clusterConnectionStatus String

    The latest heartbeat status between the cluster manager and the cluster.

    clusterExtendedLocation ExtendedLocationResponse

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    clusterManagerConnectionStatus String

    The latest connectivity status between cluster manager and the cluster.

    clusterManagerId String

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    clusterType String

    The type of rack configuration for the cluster.

    clusterVersion String

    The current runtime version of the cluster.

    detailedStatus String

    The current detailed status of the cluster.

    detailedStatusMessage String

    The descriptive message about the detailed status.

    extendedLocation ExtendedLocationResponse

    The extended location of the cluster manager associated with the cluster.

    hybridAksExtendedLocation ExtendedLocationResponse

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    manualActionCount Double

    The count of Manual Action Taken (MAT) events that have not been validated.

    name String

    The name of the resource

    networkFabricId String

    The resource ID of the Network Fabric associated with the cluster.

    provisioningState String

    The provisioning state of the cluster.

    supportExpiryDate String

    The support end date of the runtime version of the cluster.

    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"

    workloadResourceIds List<String>

    The list of workload resource IDs that are hosted within this cluster.

    analyticsWorkspaceId String

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    clusterLocation String

    The customer-provided location information to identify where the cluster resides.

    clusterServicePrincipal ServicePrincipalInformationResponse

    The service principal to be used by the cluster during Arc Appliance installation.

    computeDeploymentThreshold ValidationThresholdResponse

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    computeRackDefinitions List<RackDefinitionResponse>

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse

    The configuration of the managed resource group associated with the resource.

    tags Map<String,String>

    Resource tags.

    aggregatorOrSingleRackDefinition RackDefinitionResponse

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    availableUpgradeVersions ClusterAvailableUpgradeVersionResponse[]

    The list of cluster runtime version upgrades available for this cluster.

    clusterCapacity ClusterCapacityResponse

    The capacity supported by this cluster.

    clusterConnectionStatus string

    The latest heartbeat status between the cluster manager and the cluster.

    clusterExtendedLocation ExtendedLocationResponse

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    clusterManagerConnectionStatus string

    The latest connectivity status between cluster manager and the cluster.

    clusterManagerId string

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    clusterType string

    The type of rack configuration for the cluster.

    clusterVersion string

    The current runtime version of the cluster.

    detailedStatus string

    The current detailed status of the cluster.

    detailedStatusMessage string

    The descriptive message about the detailed status.

    extendedLocation ExtendedLocationResponse

    The extended location of the cluster manager associated with the cluster.

    hybridAksExtendedLocation ExtendedLocationResponse

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    manualActionCount number

    The count of Manual Action Taken (MAT) events that have not been validated.

    name string

    The name of the resource

    networkFabricId string

    The resource ID of the Network Fabric associated with the cluster.

    provisioningState string

    The provisioning state of the cluster.

    supportExpiryDate string

    The support end date of the runtime version of the cluster.

    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"

    workloadResourceIds string[]

    The list of workload resource IDs that are hosted within this cluster.

    analyticsWorkspaceId string

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    clusterLocation string

    The customer-provided location information to identify where the cluster resides.

    clusterServicePrincipal ServicePrincipalInformationResponse

    The service principal to be used by the cluster during Arc Appliance installation.

    computeDeploymentThreshold ValidationThresholdResponse

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    computeRackDefinitions RackDefinitionResponse[]

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    managedResourceGroupConfiguration ManagedResourceGroupConfigurationResponse

    The configuration of the managed resource group associated with the resource.

    tags {[key: string]: string}

    Resource tags.

    aggregator_or_single_rack_definition RackDefinitionResponse

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    available_upgrade_versions Sequence[ClusterAvailableUpgradeVersionResponse]

    The list of cluster runtime version upgrades available for this cluster.

    cluster_capacity ClusterCapacityResponse

    The capacity supported by this cluster.

    cluster_connection_status str

    The latest heartbeat status between the cluster manager and the cluster.

    cluster_extended_location ExtendedLocationResponse

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    cluster_manager_connection_status str

    The latest connectivity status between cluster manager and the cluster.

    cluster_manager_id str

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    cluster_type str

    The type of rack configuration for the cluster.

    cluster_version str

    The current runtime version of the cluster.

    detailed_status str

    The current detailed status of the cluster.

    detailed_status_message str

    The descriptive message about the detailed status.

    extended_location ExtendedLocationResponse

    The extended location of the cluster manager associated with the cluster.

    hybrid_aks_extended_location ExtendedLocationResponse

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    manual_action_count float

    The count of Manual Action Taken (MAT) events that have not been validated.

    name str

    The name of the resource

    network_fabric_id str

    The resource ID of the Network Fabric associated with the cluster.

    provisioning_state str

    The provisioning state of the cluster.

    support_expiry_date str

    The support end date of the runtime version of the cluster.

    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"

    workload_resource_ids Sequence[str]

    The list of workload resource IDs that are hosted within this cluster.

    analytics_workspace_id str

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    cluster_location str

    The customer-provided location information to identify where the cluster resides.

    cluster_service_principal ServicePrincipalInformationResponse

    The service principal to be used by the cluster during Arc Appliance installation.

    compute_deployment_threshold ValidationThresholdResponse

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    compute_rack_definitions Sequence[RackDefinitionResponse]

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    managed_resource_group_configuration ManagedResourceGroupConfigurationResponse

    The configuration of the managed resource group associated with the resource.

    tags Mapping[str, str]

    Resource tags.

    aggregatorOrSingleRackDefinition Property Map

    The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

    availableUpgradeVersions List<Property Map>

    The list of cluster runtime version upgrades available for this cluster.

    clusterCapacity Property Map

    The capacity supported by this cluster.

    clusterConnectionStatus String

    The latest heartbeat status between the cluster manager and the cluster.

    clusterExtendedLocation Property Map

    The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

    clusterManagerConnectionStatus String

    The latest connectivity status between cluster manager and the cluster.

    clusterManagerId String

    The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

    clusterType String

    The type of rack configuration for the cluster.

    clusterVersion String

    The current runtime version of the cluster.

    detailedStatus String

    The current detailed status of the cluster.

    detailedStatusMessage String

    The descriptive message about the detailed status.

    extendedLocation Property Map

    The extended location of the cluster manager associated with the cluster.

    hybridAksExtendedLocation Property Map

    Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

    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

    manualActionCount Number

    The count of Manual Action Taken (MAT) events that have not been validated.

    name String

    The name of the resource

    networkFabricId String

    The resource ID of the Network Fabric associated with the cluster.

    provisioningState String

    The provisioning state of the cluster.

    supportExpiryDate String

    The support end date of the runtime version of the cluster.

    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"

    workloadResourceIds List<String>

    The list of workload resource IDs that are hosted within this cluster.

    analyticsWorkspaceId String

    The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

    clusterLocation String

    The customer-provided location information to identify where the cluster resides.

    clusterServicePrincipal Property Map

    The service principal to be used by the cluster during Arc Appliance installation.

    computeDeploymentThreshold Property Map

    The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

    computeRackDefinitions List<Property Map>

    The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

    managedResourceGroupConfiguration Property Map

    The configuration of the managed resource group associated with the resource.

    tags Map<String>

    Resource tags.

    Supporting Types

    AdministrativeCredentialsResponse

    Password string

    The password of the administrator of the device used during initialization.

    Username string

    The username of the administrator of the device used during initialization.

    Password string

    The password of the administrator of the device used during initialization.

    Username string

    The username of the administrator of the device used during initialization.

    password String

    The password of the administrator of the device used during initialization.

    username String

    The username of the administrator of the device used during initialization.

    password string

    The password of the administrator of the device used during initialization.

    username string

    The username of the administrator of the device used during initialization.

    password str

    The password of the administrator of the device used during initialization.

    username str

    The username of the administrator of the device used during initialization.

    password String

    The password of the administrator of the device used during initialization.

    username String

    The username of the administrator of the device used during initialization.

    BareMetalMachineConfigurationDataResponse

    BmcConnectionString string

    The connection string for the baseboard management controller including IP address and protocol.

    BmcCredentials Pulumi.AzureNative.NetworkCloud.Inputs.AdministrativeCredentialsResponse

    The credentials of the baseboard management controller on this bare metal machine.

    BmcMacAddress string

    The MAC address of the BMC for this machine.

    BootMacAddress string

    The MAC address associated with the PXE NIC card.

    RackSlot double

    The slot the physical machine is in the rack based on the BOM configuration.

    SerialNumber string

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    MachineDetails string

    The free-form additional information about the machine, e.g. an asset tag.

    MachineName string

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    BmcConnectionString string

    The connection string for the baseboard management controller including IP address and protocol.

    BmcCredentials AdministrativeCredentialsResponse

    The credentials of the baseboard management controller on this bare metal machine.

    BmcMacAddress string

    The MAC address of the BMC for this machine.

    BootMacAddress string

    The MAC address associated with the PXE NIC card.

    RackSlot float64

    The slot the physical machine is in the rack based on the BOM configuration.

    SerialNumber string

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    MachineDetails string

    The free-form additional information about the machine, e.g. an asset tag.

    MachineName string

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    bmcConnectionString String

    The connection string for the baseboard management controller including IP address and protocol.

    bmcCredentials AdministrativeCredentialsResponse

    The credentials of the baseboard management controller on this bare metal machine.

    bmcMacAddress String

    The MAC address of the BMC for this machine.

    bootMacAddress String

    The MAC address associated with the PXE NIC card.

    rackSlot Double

    The slot the physical machine is in the rack based on the BOM configuration.

    serialNumber String

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    machineDetails String

    The free-form additional information about the machine, e.g. an asset tag.

    machineName String

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    bmcConnectionString string

    The connection string for the baseboard management controller including IP address and protocol.

    bmcCredentials AdministrativeCredentialsResponse

    The credentials of the baseboard management controller on this bare metal machine.

    bmcMacAddress string

    The MAC address of the BMC for this machine.

    bootMacAddress string

    The MAC address associated with the PXE NIC card.

    rackSlot number

    The slot the physical machine is in the rack based on the BOM configuration.

    serialNumber string

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    machineDetails string

    The free-form additional information about the machine, e.g. an asset tag.

    machineName string

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    bmc_connection_string str

    The connection string for the baseboard management controller including IP address and protocol.

    bmc_credentials AdministrativeCredentialsResponse

    The credentials of the baseboard management controller on this bare metal machine.

    bmc_mac_address str

    The MAC address of the BMC for this machine.

    boot_mac_address str

    The MAC address associated with the PXE NIC card.

    rack_slot float

    The slot the physical machine is in the rack based on the BOM configuration.

    serial_number str

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    machine_details str

    The free-form additional information about the machine, e.g. an asset tag.

    machine_name str

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    bmcConnectionString String

    The connection string for the baseboard management controller including IP address and protocol.

    bmcCredentials Property Map

    The credentials of the baseboard management controller on this bare metal machine.

    bmcMacAddress String

    The MAC address of the BMC for this machine.

    bootMacAddress String

    The MAC address associated with the PXE NIC card.

    rackSlot Number

    The slot the physical machine is in the rack based on the BOM configuration.

    serialNumber String

    The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag.

    machineDetails String

    The free-form additional information about the machine, e.g. an asset tag.

    machineName String

    The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.

    ClusterAvailableUpgradeVersionResponse

    ControlImpact string

    The indicator of whether the control plane will be impacted during the upgrade.

    ExpectedDuration string

    The expected duration needed for this upgrade.

    ImpactDescription string

    The impact description including the specific details and release notes.

    SupportExpiryDate string

    The last date the version of the platform is supported.

    TargetClusterVersion string

    The target version this cluster will be upgraded to.

    WorkloadImpact string

    The indicator of whether the workload will be impacted during the upgrade.

    ControlImpact string

    The indicator of whether the control plane will be impacted during the upgrade.

    ExpectedDuration string

    The expected duration needed for this upgrade.

    ImpactDescription string

    The impact description including the specific details and release notes.

    SupportExpiryDate string

    The last date the version of the platform is supported.

    TargetClusterVersion string

    The target version this cluster will be upgraded to.

    WorkloadImpact string

    The indicator of whether the workload will be impacted during the upgrade.

    controlImpact String

    The indicator of whether the control plane will be impacted during the upgrade.

    expectedDuration String

    The expected duration needed for this upgrade.

    impactDescription String

    The impact description including the specific details and release notes.

    supportExpiryDate String

    The last date the version of the platform is supported.

    targetClusterVersion String

    The target version this cluster will be upgraded to.

    workloadImpact String

    The indicator of whether the workload will be impacted during the upgrade.

    controlImpact string

    The indicator of whether the control plane will be impacted during the upgrade.

    expectedDuration string

    The expected duration needed for this upgrade.

    impactDescription string

    The impact description including the specific details and release notes.

    supportExpiryDate string

    The last date the version of the platform is supported.

    targetClusterVersion string

    The target version this cluster will be upgraded to.

    workloadImpact string

    The indicator of whether the workload will be impacted during the upgrade.

    control_impact str

    The indicator of whether the control plane will be impacted during the upgrade.

    expected_duration str

    The expected duration needed for this upgrade.

    impact_description str

    The impact description including the specific details and release notes.

    support_expiry_date str

    The last date the version of the platform is supported.

    target_cluster_version str

    The target version this cluster will be upgraded to.

    workload_impact str

    The indicator of whether the workload will be impacted during the upgrade.

    controlImpact String

    The indicator of whether the control plane will be impacted during the upgrade.

    expectedDuration String

    The expected duration needed for this upgrade.

    impactDescription String

    The impact description including the specific details and release notes.

    supportExpiryDate String

    The last date the version of the platform is supported.

    targetClusterVersion String

    The target version this cluster will be upgraded to.

    workloadImpact String

    The indicator of whether the workload will be impacted during the upgrade.

    ClusterCapacityResponse

    AvailableApplianceStorageGB double

    The remaining appliance-based storage in GB available for workload use.

    AvailableCoreCount double

    The remaining number of cores that are available in this cluster for workload use.

    AvailableHostStorageGB double

    The remaining machine or host-based storage in GB available for workload use.

    AvailableMemoryGB double

    The remaining memory in GB that are available in this cluster for workload use.

    TotalApplianceStorageGB double

    The total appliance-based storage in GB supported by this cluster for workload use.

    TotalCoreCount double

    The total number of cores that are supported by this cluster for workload use.

    TotalHostStorageGB double

    The total machine or host-based storage in GB supported by this cluster for workload use.

    TotalMemoryGB double

    The total memory supported by this cluster for workload use.

    AvailableApplianceStorageGB float64

    The remaining appliance-based storage in GB available for workload use.

    AvailableCoreCount float64

    The remaining number of cores that are available in this cluster for workload use.

    AvailableHostStorageGB float64

    The remaining machine or host-based storage in GB available for workload use.

    AvailableMemoryGB float64

    The remaining memory in GB that are available in this cluster for workload use.

    TotalApplianceStorageGB float64

    The total appliance-based storage in GB supported by this cluster for workload use.

    TotalCoreCount float64

    The total number of cores that are supported by this cluster for workload use.

    TotalHostStorageGB float64

    The total machine or host-based storage in GB supported by this cluster for workload use.

    TotalMemoryGB float64

    The total memory supported by this cluster for workload use.

    availableApplianceStorageGB Double

    The remaining appliance-based storage in GB available for workload use.

    availableCoreCount Double

    The remaining number of cores that are available in this cluster for workload use.

    availableHostStorageGB Double

    The remaining machine or host-based storage in GB available for workload use.

    availableMemoryGB Double

    The remaining memory in GB that are available in this cluster for workload use.

    totalApplianceStorageGB Double

    The total appliance-based storage in GB supported by this cluster for workload use.

    totalCoreCount Double

    The total number of cores that are supported by this cluster for workload use.

    totalHostStorageGB Double

    The total machine or host-based storage in GB supported by this cluster for workload use.

    totalMemoryGB Double

    The total memory supported by this cluster for workload use.

    availableApplianceStorageGB number

    The remaining appliance-based storage in GB available for workload use.

    availableCoreCount number

    The remaining number of cores that are available in this cluster for workload use.

    availableHostStorageGB number

    The remaining machine or host-based storage in GB available for workload use.

    availableMemoryGB number

    The remaining memory in GB that are available in this cluster for workload use.

    totalApplianceStorageGB number

    The total appliance-based storage in GB supported by this cluster for workload use.

    totalCoreCount number

    The total number of cores that are supported by this cluster for workload use.

    totalHostStorageGB number

    The total machine or host-based storage in GB supported by this cluster for workload use.

    totalMemoryGB number

    The total memory supported by this cluster for workload use.

    available_appliance_storage_gb float

    The remaining appliance-based storage in GB available for workload use.

    available_core_count float

    The remaining number of cores that are available in this cluster for workload use.

    available_host_storage_gb float

    The remaining machine or host-based storage in GB available for workload use.

    available_memory_gb float

    The remaining memory in GB that are available in this cluster for workload use.

    total_appliance_storage_gb float

    The total appliance-based storage in GB supported by this cluster for workload use.

    total_core_count float

    The total number of cores that are supported by this cluster for workload use.

    total_host_storage_gb float

    The total machine or host-based storage in GB supported by this cluster for workload use.

    total_memory_gb float

    The total memory supported by this cluster for workload use.

    availableApplianceStorageGB Number

    The remaining appliance-based storage in GB available for workload use.

    availableCoreCount Number

    The remaining number of cores that are available in this cluster for workload use.

    availableHostStorageGB Number

    The remaining machine or host-based storage in GB available for workload use.

    availableMemoryGB Number

    The remaining memory in GB that are available in this cluster for workload use.

    totalApplianceStorageGB Number

    The total appliance-based storage in GB supported by this cluster for workload use.

    totalCoreCount Number

    The total number of cores that are supported by this cluster for workload use.

    totalHostStorageGB Number

    The total machine or host-based storage in GB supported by this cluster for workload use.

    totalMemoryGB Number

    The total memory supported by this cluster for workload use.

    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.

    RackDefinitionResponse

    NetworkRackId string

    The resource ID of the network rack that matches this rack definition.

    RackSerialNumber string

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    RackSkuId string

    The resource ID of the sku for the rack being added.

    AvailabilityZone string

    The zone name used for this rack when created. Availability zones are used for workload placement.

    BareMetalMachineConfigurationData List<Pulumi.AzureNative.NetworkCloud.Inputs.BareMetalMachineConfigurationDataResponse>

    The unordered list of bare metal machine configuration.

    RackLocation string

    The free-form description of the rack's location.

    StorageApplianceConfigurationData List<Pulumi.AzureNative.NetworkCloud.Inputs.StorageApplianceConfigurationDataResponse>

    The list of storage appliance configuration data for this rack.

    NetworkRackId string

    The resource ID of the network rack that matches this rack definition.

    RackSerialNumber string

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    RackSkuId string

    The resource ID of the sku for the rack being added.

    AvailabilityZone string

    The zone name used for this rack when created. Availability zones are used for workload placement.

    BareMetalMachineConfigurationData []BareMetalMachineConfigurationDataResponse

    The unordered list of bare metal machine configuration.

    RackLocation string

    The free-form description of the rack's location.

    StorageApplianceConfigurationData []StorageApplianceConfigurationDataResponse

    The list of storage appliance configuration data for this rack.

    networkRackId String

    The resource ID of the network rack that matches this rack definition.

    rackSerialNumber String

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    rackSkuId String

    The resource ID of the sku for the rack being added.

    availabilityZone String

    The zone name used for this rack when created. Availability zones are used for workload placement.

    bareMetalMachineConfigurationData List<BareMetalMachineConfigurationDataResponse>

    The unordered list of bare metal machine configuration.

    rackLocation String

    The free-form description of the rack's location.

    storageApplianceConfigurationData List<StorageApplianceConfigurationDataResponse>

    The list of storage appliance configuration data for this rack.

    networkRackId string

    The resource ID of the network rack that matches this rack definition.

    rackSerialNumber string

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    rackSkuId string

    The resource ID of the sku for the rack being added.

    availabilityZone string

    The zone name used for this rack when created. Availability zones are used for workload placement.

    bareMetalMachineConfigurationData BareMetalMachineConfigurationDataResponse[]

    The unordered list of bare metal machine configuration.

    rackLocation string

    The free-form description of the rack's location.

    storageApplianceConfigurationData StorageApplianceConfigurationDataResponse[]

    The list of storage appliance configuration data for this rack.

    network_rack_id str

    The resource ID of the network rack that matches this rack definition.

    rack_serial_number str

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    rack_sku_id str

    The resource ID of the sku for the rack being added.

    availability_zone str

    The zone name used for this rack when created. Availability zones are used for workload placement.

    bare_metal_machine_configuration_data Sequence[BareMetalMachineConfigurationDataResponse]

    The unordered list of bare metal machine configuration.

    rack_location str

    The free-form description of the rack's location.

    storage_appliance_configuration_data Sequence[StorageApplianceConfigurationDataResponse]

    The list of storage appliance configuration data for this rack.

    networkRackId String

    The resource ID of the network rack that matches this rack definition.

    rackSerialNumber String

    The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.

    rackSkuId String

    The resource ID of the sku for the rack being added.

    availabilityZone String

    The zone name used for this rack when created. Availability zones are used for workload placement.

    bareMetalMachineConfigurationData List<Property Map>

    The unordered list of bare metal machine configuration.

    rackLocation String

    The free-form description of the rack's location.

    storageApplianceConfigurationData List<Property Map>

    The list of storage appliance configuration data for this rack.

    ServicePrincipalInformationResponse

    ApplicationId string

    The application ID, also known as client ID, of the service principal.

    Password string

    The password of the service principal.

    PrincipalId string

    The principal ID, also known as the object ID, of the service principal.

    TenantId string

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    ApplicationId string

    The application ID, also known as client ID, of the service principal.

    Password string

    The password of the service principal.

    PrincipalId string

    The principal ID, also known as the object ID, of the service principal.

    TenantId string

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    applicationId String

    The application ID, also known as client ID, of the service principal.

    password String

    The password of the service principal.

    principalId String

    The principal ID, also known as the object ID, of the service principal.

    tenantId String

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    applicationId string

    The application ID, also known as client ID, of the service principal.

    password string

    The password of the service principal.

    principalId string

    The principal ID, also known as the object ID, of the service principal.

    tenantId string

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    application_id str

    The application ID, also known as client ID, of the service principal.

    password str

    The password of the service principal.

    principal_id str

    The principal ID, also known as the object ID, of the service principal.

    tenant_id str

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    applicationId String

    The application ID, also known as client ID, of the service principal.

    password String

    The password of the service principal.

    principalId String

    The principal ID, also known as the object ID, of the service principal.

    tenantId String

    The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.

    StorageApplianceConfigurationDataResponse

    AdminCredentials Pulumi.AzureNative.NetworkCloud.Inputs.AdministrativeCredentialsResponse

    The credentials of the administrative interface on this storage appliance.

    RackSlot double

    The slot that storage appliance is in the rack based on the BOM configuration.

    SerialNumber string

    The serial number of the appliance.

    StorageApplianceName string

    The user-provided name for the storage appliance that will be created from this specification.

    AdminCredentials AdministrativeCredentialsResponse

    The credentials of the administrative interface on this storage appliance.

    RackSlot float64

    The slot that storage appliance is in the rack based on the BOM configuration.

    SerialNumber string

    The serial number of the appliance.

    StorageApplianceName string

    The user-provided name for the storage appliance that will be created from this specification.

    adminCredentials AdministrativeCredentialsResponse

    The credentials of the administrative interface on this storage appliance.

    rackSlot Double

    The slot that storage appliance is in the rack based on the BOM configuration.

    serialNumber String

    The serial number of the appliance.

    storageApplianceName String

    The user-provided name for the storage appliance that will be created from this specification.

    adminCredentials AdministrativeCredentialsResponse

    The credentials of the administrative interface on this storage appliance.

    rackSlot number

    The slot that storage appliance is in the rack based on the BOM configuration.

    serialNumber string

    The serial number of the appliance.

    storageApplianceName string

    The user-provided name for the storage appliance that will be created from this specification.

    admin_credentials AdministrativeCredentialsResponse

    The credentials of the administrative interface on this storage appliance.

    rack_slot float

    The slot that storage appliance is in the rack based on the BOM configuration.

    serial_number str

    The serial number of the appliance.

    storage_appliance_name str

    The user-provided name for the storage appliance that will be created from this specification.

    adminCredentials Property Map

    The credentials of the administrative interface on this storage appliance.

    rackSlot Number

    The slot that storage appliance is in the rack based on the BOM configuration.

    serialNumber String

    The serial number of the appliance.

    storageApplianceName String

    The user-provided name for the storage appliance that will be created from this specification.

    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.

    ValidationThresholdResponse

    Grouping string

    Selection of how the type evaluation is applied to the cluster calculation.

    Type string

    Selection of how the threshold should be evaluated.

    Value double

    The numeric threshold value.

    Grouping string

    Selection of how the type evaluation is applied to the cluster calculation.

    Type string

    Selection of how the threshold should be evaluated.

    Value float64

    The numeric threshold value.

    grouping String

    Selection of how the type evaluation is applied to the cluster calculation.

    type String

    Selection of how the threshold should be evaluated.

    value Double

    The numeric threshold value.

    grouping string

    Selection of how the type evaluation is applied to the cluster calculation.

    type string

    Selection of how the threshold should be evaluated.

    value number

    The numeric threshold value.

    grouping str

    Selection of how the type evaluation is applied to the cluster calculation.

    type str

    Selection of how the threshold should be evaluated.

    value float

    The numeric threshold value.

    grouping String

    Selection of how the type evaluation is applied to the cluster calculation.

    type String

    Selection of how the threshold should be evaluated.

    value Number

    The numeric threshold value.

    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.10.0 published on Wednesday, Oct 4, 2023 by Pulumi