Azure Native

v1.78.0 published on Wednesday, Sep 14, 2022 by Pulumi

getagentPool

The agentPool resource definition API Version: 2022-05-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 getagent_pool(agent_pool_name: Optional[str] = None,
                  provisioned_clusters_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetagentPoolResult
def getagent_pool_output(agent_pool_name: Optional[pulumi.Input[str]] = None,
                  provisioned_clusters_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetagentPoolResult]
func GetagentPool(ctx *Context, args *GetagentPoolArgs, opts ...InvokeOption) (*GetagentPoolResult, error)
func GetagentPoolOutput(ctx *Context, args *GetagentPoolOutputArgs, opts ...InvokeOption) GetagentPoolResultOutput

> Note: This function is named GetagentPool 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:

AgentPoolName string

Parameter for the name of the agent pool in the provisioned cluster

ProvisionedClustersName string

Parameter for the name of the provisioned cluster

ResourceGroupName string

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

AgentPoolName string

Parameter for the name of the agent pool in the provisioned cluster

ProvisionedClustersName string

Parameter for the name of the provisioned cluster

ResourceGroupName string

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

agentPoolName String

Parameter for the name of the agent pool in the provisioned cluster

provisionedClustersName String

Parameter for the name of the provisioned cluster

resourceGroupName String

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

agentPoolName string

Parameter for the name of the agent pool in the provisioned cluster

provisionedClustersName string

Parameter for the name of the provisioned cluster

resourceGroupName string

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

agent_pool_name str

Parameter for the name of the agent pool in the provisioned cluster

provisioned_clusters_name str

Parameter for the name of the provisioned cluster

resource_group_name str

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

agentPoolName String

Parameter for the name of the agent pool in the provisioned cluster

provisionedClustersName String

Parameter for the name of the provisioned cluster

resourceGroupName String

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

getagentPool Result

The following output properties are available:

Id string

Resource Id

Name string

Resource Name

ProvisioningState string
SystemData Pulumi.AzureNative.HybridContainerService.Outputs.SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

Resource Type

AvailabilityZones List<string>

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

CloudProviderProfile Pulumi.AzureNative.HybridContainerService.Outputs.CloudProviderProfileResponse

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.

ExtendedLocation Pulumi.AzureNative.HybridContainerService.Outputs.AgentPoolResponseExtendedLocation
Location string

The resource location

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount 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'

NodeImageVersion string

The version of node image

NodeLabels Dictionary<string, string>

NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.

NodeTaints List<string>

NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OsType 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.AzureNative.HybridContainerService.Outputs.AgentPoolProvisioningStatusResponseStatus

HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool

Tags Dictionary<string, string>

Resource tags

VmSize string

VmSize - The size of the agent pool VMs.

Id string

Resource Id

Name string

Resource Name

ProvisioningState string
SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

Resource Type

AvailabilityZones []string

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

CloudProviderProfile CloudProviderProfileResponse

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.

ExtendedLocation AgentPoolResponseExtendedLocation
Location string

The resource location

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount 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'

NodeImageVersion string

The version of node image

NodeLabels map[string]string

NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.

NodeTaints []string

NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

OsType string

OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

Status AgentPoolProvisioningStatusResponseStatus

HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool

Tags map[string]string

Resource tags

VmSize string

VmSize - The size of the agent pool VMs.

id String

Resource Id

name String

Resource Name

provisioningState String
systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

Resource Type

availabilityZones List<String>

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

cloudProviderProfile CloudProviderProfileResponse

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.

extendedLocation AgentPoolResponseExtendedLocation
location String

The resource location

maxCount Integer

The maximum number of nodes for auto-scaling

maxPods Integer

The maximum number of pods that can run on a node.

minCount 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'

nodeImageVersion String

The version of node image

nodeLabels Map<String,String>

NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.

nodeTaints List<String>

NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

osType String

OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

status AgentPoolProvisioningStatusResponseStatus

HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool

tags Map<String,String>

Resource tags

vmSize String

VmSize - The size of the agent pool VMs.

id string

Resource Id

name string

Resource Name

provisioningState string
systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

Resource Type

availabilityZones string[]

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

cloudProviderProfile CloudProviderProfileResponse

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.

extendedLocation AgentPoolResponseExtendedLocation
location string

The resource location

maxCount number

The maximum number of nodes for auto-scaling

maxPods number

The maximum number of pods that can run on a node.

minCount 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'

nodeImageVersion string

The version of node image

nodeLabels {[key: string]: string}

NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.

nodeTaints string[]

NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

osType string

OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

status AgentPoolProvisioningStatusResponseStatus

HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool

tags {[key: string]: string}

Resource tags

vmSize string

VmSize - The size of the agent pool VMs.

id str

Resource Id

name str

Resource Name

provisioning_state str
system_data SystemDataResponse

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_profile CloudProviderProfileResponse

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 AgentPoolResponseExtendedLocation
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_version str

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 AgentPoolProvisioningStatusResponseStatus

HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool

tags Mapping[str, str]

Resource tags

vm_size str

VmSize - The size of the agent pool VMs.

id String

Resource Id

name String

Resource Name

provisioningState String
systemData Property Map

Metadata pertaining to creation and last modification of the resource.

type String

Resource Type

availabilityZones List<String>

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

cloudProviderProfile Property Map

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.

extendedLocation Property Map
location String

The resource location

maxCount Number

The maximum number of nodes for auto-scaling

maxPods Number

The maximum number of pods that can run on a node.

minCount 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'

nodeImageVersion String

The version of node image

nodeLabels Map<String>

NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.

nodeTaints List<String>

NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

osType 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

tags Map<String>

Resource tags

vmSize String

VmSize - The size of the agent pool VMs.

Supporting Types

AgentPoolProvisioningStatusResponseError

Code string
Message string
Code string
Message string
code String
message String
code string
message string
code str
message str
code String
message String

AgentPoolProvisioningStatusResponseProvisioningStatus

Error Pulumi.AzureNative.HybridContainerService.Inputs.AgentPoolProvisioningStatusResponseError
OperationId string
Phase string

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

Status string
Error AgentPoolProvisioningStatusResponseError
OperationId string
Phase string

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

Status string
error AgentPoolProvisioningStatusResponseError
operationId String
phase String

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

status String
error AgentPoolProvisioningStatusResponseError
operationId string
phase string

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

status string
error AgentPoolProvisioningStatusResponseError
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
operationId String
phase String

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

status String

AgentPoolProvisioningStatusResponseStatus

ErrorMessage string

ErrorMessage - Error messages during creation of cluster

ProvisioningStatus Pulumi.AzureNative.HybridContainerService.Inputs.AgentPoolProvisioningStatusResponseProvisioningStatus

Contains Provisioning errors

ReadyReplicas int

Total number of ready machines targeted by this deployment.

Replicas int

Total number of non-terminated machines targeted by this deployment

ErrorMessage string

ErrorMessage - Error messages during creation of cluster

ProvisioningStatus AgentPoolProvisioningStatusResponseProvisioningStatus

Contains Provisioning errors

ReadyReplicas int

Total number of ready machines targeted by this deployment.

Replicas int

Total number of non-terminated machines targeted by this deployment

errorMessage String

ErrorMessage - Error messages during creation of cluster

provisioningStatus AgentPoolProvisioningStatusResponseProvisioningStatus

Contains Provisioning errors

readyReplicas Integer

Total number of ready machines targeted by this deployment.

replicas Integer

Total number of non-terminated machines targeted by this deployment

errorMessage string

ErrorMessage - Error messages during creation of cluster

provisioningStatus AgentPoolProvisioningStatusResponseProvisioningStatus

Contains Provisioning errors

readyReplicas 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 AgentPoolProvisioningStatusResponseProvisioningStatus

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

errorMessage String

ErrorMessage - Error messages during creation of cluster

provisioningStatus Property Map

Contains Provisioning errors

readyReplicas Number

Total number of ready machines targeted by this deployment.

replicas Number

Total number of non-terminated machines targeted by this deployment

AgentPoolResponseExtendedLocation

Name string

The extended location name.

Type string

The extended location type.

Name string

The extended location name.

Type string

The extended location type.

name String

The extended location name.

type String

The extended location type.

name string

The extended location name.

type string

The extended location type.

name str

The extended location name.

type str

The extended location type.

name String

The extended location name.

type String

The extended location type.

CloudProviderProfileResponse

InfraNetworkProfile Pulumi.AzureNative.HybridContainerService.Inputs.CloudProviderProfileResponseInfraNetworkProfile

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

InfraStorageProfile Pulumi.AzureNative.HybridContainerService.Inputs.CloudProviderProfileResponseInfraStorageProfile

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

InfraNetworkProfile CloudProviderProfileResponseInfraNetworkProfile

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

InfraStorageProfile CloudProviderProfileResponseInfraStorageProfile

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

infraNetworkProfile CloudProviderProfileResponseInfraNetworkProfile

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

infraStorageProfile CloudProviderProfileResponseInfraStorageProfile

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

infraNetworkProfile CloudProviderProfileResponseInfraNetworkProfile

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

infraStorageProfile CloudProviderProfileResponseInfraStorageProfile

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

infra_network_profile CloudProviderProfileResponseInfraNetworkProfile

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

infra_storage_profile CloudProviderProfileResponseInfraStorageProfile

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

infraNetworkProfile Property Map

InfraNetworkProfile - List of infra network profiles for the provisioned cluster

infraStorageProfile Property Map

InfraStorageProfile - List of infra storage profiles for the provisioned cluster

CloudProviderProfileResponseInfraNetworkProfile

VnetSubnetIds List<string>

Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

VnetSubnetIds []string

Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

vnetSubnetIds List<String>

Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

vnetSubnetIds string[]

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_ids Sequence[str]

Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

vnetSubnetIds List<String>

Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName}

CloudProviderProfileResponseInfraStorageProfile

StorageSpaceIds List<string>

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

StorageSpaceIds []string

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

storageSpaceIds List<String>

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

storageSpaceIds string[]

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

storage_space_ids Sequence[str]

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

storageSpaceIds List<String>

Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName}

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

The type of identity that last modified the resource.

created_at str

The timestamp of resource creation (UTC).

created_by str

The identity that created the resource.

created_by_type str

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0