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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.hybridcontainerservice.getAgentPool
Explore with Pulumi AI
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Gets the agent pool in the Hybrid AKS provisioned cluster Azure REST API version: 2022-09-01-preview.
Using getAgentPool
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 getAgentPool(args: GetAgentPoolArgs, opts?: InvokeOptions): Promise<GetAgentPoolResult>
function getAgentPoolOutput(args: GetAgentPoolOutputArgs, opts?: InvokeOptions): Output<GetAgentPoolResult>
def get_agent_pool(agent_pool_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
resource_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentPoolResult
def get_agent_pool_output(agent_pool_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
resource_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentPoolResult]
func LookupAgentPool(ctx *Context, args *LookupAgentPoolArgs, opts ...InvokeOption) (*LookupAgentPoolResult, error)
func LookupAgentPoolOutput(ctx *Context, args *LookupAgentPoolOutputArgs, opts ...InvokeOption) LookupAgentPoolResultOutput
> Note: This function is named LookupAgentPool
in the Go SDK.
public static class GetAgentPool
{
public static Task<GetAgentPoolResult> InvokeAsync(GetAgentPoolArgs args, InvokeOptions? opts = null)
public static Output<GetAgentPoolResult> Invoke(GetAgentPoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:hybridcontainerservice:getAgentPool
arguments:
# arguments dictionary
The following arguments are supported:
- Agent
Pool stringName - Parameter for the name of the agent pool in the provisioned cluster
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Resource
Name string - Parameter for the name of the provisioned cluster
- Agent
Pool stringName - Parameter for the name of the agent pool in the provisioned cluster
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Resource
Name string - Parameter for the name of the provisioned cluster
- agent
Pool StringName - Parameter for the name of the agent pool in the provisioned cluster
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- resource
Name String - Parameter for the name of the provisioned cluster
- agent
Pool stringName - Parameter for the name of the agent pool in the provisioned cluster
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- resource
Name string - Parameter for the name of the provisioned cluster
- agent_
pool_ strname - Parameter for the name of the agent pool in the provisioned cluster
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- resource_
name str - Parameter for the name of the provisioned cluster
- agent
Pool StringName - Parameter for the name of the agent pool in the provisioned cluster
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- resource
Name String - Parameter for the name of the provisioned cluster
getAgentPool Result
The following output properties are available:
- Id string
- Resource Id
- Name string
- Resource Name
- Provisioning
State string - System
Data Pulumi.Azure Native. Hybrid Container Service. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- Resource Type
- Availability
Zones List<string> - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- Cloud
Provider Pulumi.Profile Azure Native. Hybrid Container Service. Outputs. Cloud Provider Profile Response - The underlying cloud infra provider properties.
- Count int
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- Extended
Location Pulumi.Azure Native. Hybrid Container Service. Outputs. Agent Pool Response Extended Location - Location string
- The resource location
- Max
Count int - The maximum number of nodes for auto-scaling
- Max
Pods int - The maximum number of pods that can run on a node.
- Min
Count int - The minimum number of nodes for auto-scaling
- Mode string
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- Node
Image stringVersion - The version of node image
- Node
Labels Dictionary<string, string> - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- Node
Taints List<string> - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- Os
Type string - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- Status
Pulumi.
Azure Native. Hybrid Container Service. Outputs. Agent Pool Provisioning Status Response Status - HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- Dictionary<string, string>
- Resource tags
- Vm
Size string - VmSize - The size of the agent pool VMs.
- Id string
- Resource Id
- Name string
- Resource Name
- Provisioning
State string - System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- Resource Type
- Availability
Zones []string - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- Cloud
Provider CloudProfile Provider Profile Response - The underlying cloud infra provider properties.
- Count int
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- Extended
Location AgentPool Response Extended Location - Location string
- The resource location
- Max
Count int - The maximum number of nodes for auto-scaling
- Max
Pods int - The maximum number of pods that can run on a node.
- Min
Count int - The minimum number of nodes for auto-scaling
- Mode string
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- Node
Image stringVersion - The version of node image
- Node
Labels map[string]string - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- Node
Taints []string - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- Os
Type string - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- Status
Agent
Pool Provisioning Status Response Status - HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- map[string]string
- Resource tags
- Vm
Size string - VmSize - The size of the agent pool VMs.
- id String
- Resource Id
- name String
- Resource Name
- provisioning
State String - system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- Resource Type
- availability
Zones List<String> - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- cloud
Provider CloudProfile Provider Profile Response - The underlying cloud infra provider properties.
- count Integer
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- extended
Location AgentPool Response Extended Location - location String
- The resource location
- max
Count Integer - The maximum number of nodes for auto-scaling
- max
Pods Integer - The maximum number of pods that can run on a node.
- min
Count Integer - The minimum number of nodes for auto-scaling
- mode String
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- node
Image StringVersion - The version of node image
- node
Labels Map<String,String> - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- node
Taints List<String> - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- os
Type String - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- status
Agent
Pool Provisioning Status Response Status - HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- Map<String,String>
- Resource tags
- vm
Size String - VmSize - The size of the agent pool VMs.
- id string
- Resource Id
- name string
- Resource Name
- provisioning
State string - system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- Resource Type
- availability
Zones string[] - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- cloud
Provider CloudProfile Provider Profile Response - The underlying cloud infra provider properties.
- count number
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- extended
Location AgentPool Response Extended Location - location string
- The resource location
- max
Count number - The maximum number of nodes for auto-scaling
- max
Pods number - The maximum number of pods that can run on a node.
- min
Count number - The minimum number of nodes for auto-scaling
- mode string
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- node
Image stringVersion - The version of node image
- node
Labels {[key: string]: string} - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- node
Taints string[] - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- os
Type string - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- status
Agent
Pool Provisioning Status Response Status - HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- {[key: string]: string}
- Resource tags
- vm
Size string - VmSize - The size of the agent pool VMs.
- id str
- Resource Id
- name str
- Resource Name
- provisioning_
state str - system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- Resource Type
- availability_
zones Sequence[str] - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- cloud_
provider_ Cloudprofile Provider Profile Response - The underlying cloud infra provider properties.
- count int
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- extended_
location AgentPool Response Extended Location - location str
- The resource location
- max_
count int - The maximum number of nodes for auto-scaling
- max_
pods int - The maximum number of pods that can run on a node.
- min_
count int - The minimum number of nodes for auto-scaling
- mode str
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- node_
image_ strversion - The version of node image
- node_
labels Mapping[str, str] - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- node_
taints Sequence[str] - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- os_
type str - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- status
Agent
Pool Provisioning Status Response Status - HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- Mapping[str, str]
- Resource tags
- vm_
size str - VmSize - The size of the agent pool VMs.
- id String
- Resource Id
- name String
- Resource Name
- provisioning
State String - system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- Resource Type
- availability
Zones List<String> - AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
- cloud
Provider Property MapProfile - The underlying cloud infra provider properties.
- count Number
- Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
- extended
Location Property Map - location String
- The resource location
- max
Count Number - The maximum number of nodes for auto-scaling
- max
Pods Number - The maximum number of pods that can run on a node.
- min
Count Number - The minimum number of nodes for auto-scaling
- mode String
- Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'
- node
Image StringVersion - The version of node image
- node
Labels Map<String> - NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
- node
Taints List<String> - NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- os
Type String - OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'
- status Property Map
- HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool
- Map<String>
- Resource tags
- vm
Size String - VmSize - The size of the agent pool VMs.
Supporting Types
AgentPoolProvisioningStatusResponseError
AgentPoolProvisioningStatusResponseProvisioningStatus
- Error
Pulumi.
Azure Native. Hybrid Container Service. Inputs. Agent Pool Provisioning Status Response Error - Operation
Id string - Phase string
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- Status string
- Error
Agent
Pool Provisioning Status Response Error - Operation
Id string - Phase string
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- Status string
- error
Agent
Pool Provisioning Status Response Error - operation
Id String - phase String
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- status String
- error
Agent
Pool Provisioning Status Response Error - operation
Id string - phase string
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- status string
- error
Agent
Pool Provisioning Status Response Error - operation_
id str - phase str
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- status str
- error Property Map
- operation
Id String - phase String
- Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.
- status String
AgentPoolProvisioningStatusResponseStatus
- Error
Message string - ErrorMessage - Error messages during creation of cluster
- Provisioning
Status Pulumi.Azure Native. Hybrid Container Service. Inputs. Agent Pool Provisioning Status Response Provisioning Status - Contains Provisioning errors
- Ready
Replicas int - Total number of ready machines targeted by this deployment.
- Replicas int
- Total number of non-terminated machines targeted by this deployment
- Error
Message string - ErrorMessage - Error messages during creation of cluster
- Provisioning
Status AgentPool Provisioning Status Response Provisioning Status - Contains Provisioning errors
- Ready
Replicas int - Total number of ready machines targeted by this deployment.
- Replicas int
- Total number of non-terminated machines targeted by this deployment
- error
Message String - ErrorMessage - Error messages during creation of cluster
- provisioning
Status AgentPool Provisioning Status Response Provisioning Status - Contains Provisioning errors
- ready
Replicas Integer - Total number of ready machines targeted by this deployment.
- replicas Integer
- Total number of non-terminated machines targeted by this deployment
- error
Message string - ErrorMessage - Error messages during creation of cluster
- provisioning
Status AgentPool Provisioning Status Response Provisioning Status - Contains Provisioning errors
- ready
Replicas number - Total number of ready machines targeted by this deployment.
- replicas number
- Total number of non-terminated machines targeted by this deployment
- error_
message str - ErrorMessage - Error messages during creation of cluster
- provisioning_
status AgentPool Provisioning Status Response Provisioning Status - Contains Provisioning errors
- ready_
replicas int - Total number of ready machines targeted by this deployment.
- replicas int
- Total number of non-terminated machines targeted by this deployment
- error
Message String - ErrorMessage - Error messages during creation of cluster
- provisioning
Status Property Map - Contains Provisioning errors
- ready
Replicas Number - Total number of ready machines targeted by this deployment.
- replicas Number
- Total number of non-terminated machines targeted by this deployment
AgentPoolResponseExtendedLocation
CloudProviderProfileResponse
- Infra
Network Pulumi.Profile Azure Native. Hybrid Container Service. Inputs. Cloud Provider Profile Response Infra Network Profile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- Infra
Storage Pulumi.Profile Azure Native. Hybrid Container Service. Inputs. Cloud Provider Profile Response Infra Storage Profile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
- Infra
Network CloudProfile Provider Profile Response Infra Network Profile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- Infra
Storage CloudProfile Provider Profile Response Infra Storage Profile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
- infra
Network CloudProfile Provider Profile Response Infra Network Profile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- infra
Storage CloudProfile Provider Profile Response Infra Storage Profile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
- infra
Network CloudProfile Provider Profile Response Infra Network Profile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- infra
Storage CloudProfile Provider Profile Response Infra Storage Profile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
- infra_
network_ Cloudprofile Provider Profile Response Infra Network Profile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- infra_
storage_ Cloudprofile Provider Profile Response Infra Storage Profile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
- infra
Network Property MapProfile - InfraNetworkProfile - List of infra network profiles for the provisioned cluster
- infra
Storage Property MapProfile - InfraStorageProfile - List of infra storage profiles for the provisioned cluster
CloudProviderProfileResponseInfraNetworkProfile
- Vnet
Subnet List<string>Ids - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
- Vnet
Subnet []stringIds - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
- vnet
Subnet List<String>Ids - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
- vnet
Subnet string[]Ids - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
- vnet_
subnet_ Sequence[str]ids - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
- vnet
Subnet List<String>Ids - Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}
CloudProviderProfileResponseInfraStorageProfile
- Storage
Space List<string>Ids - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
- Storage
Space []stringIds - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
- storage
Space List<String>Ids - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
- storage
Space string[]Ids - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
- storage_
space_ Sequence[str]ids - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
- storage
Space List<String>Ids - Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}
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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi