1. Packages
  2. Azure Classic
  3. API Docs
  4. containerservice
  5. FleetMember

We recommend using Azure Native.

Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi

azure.containerservice.FleetMember

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi

    Manages a Kubernetes Fleet Member.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const example = new azure.containerservice.KubernetesCluster("example", {
        name: "example",
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        dnsPrefix: "acctestaksexample",
        defaultNodePool: {
            name: "example-value",
            nodeCount: "example-value",
            vmSize: "example-value",
            upgradeSettings: {
                maxSurge: "example-value",
            },
        },
        identity: {
            type: "example-value",
        },
    });
    const exampleKubernetesFleetManager = new azure.containerservice.KubernetesFleetManager("example", {
        name: "example",
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleFleetMember = new azure.containerservice.FleetMember("example", {
        kubernetesClusterId: example.id,
        kubernetesFleetId: exampleKubernetesFleetManager.id,
        name: "example",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example = azure.containerservice.KubernetesCluster("example",
        name="example",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        dns_prefix="acctestaksexample",
        default_node_pool={
            "name": "example-value",
            "node_count": "example-value",
            "vm_size": "example-value",
            "upgrade_settings": {
                "max_surge": "example-value",
            },
        },
        identity={
            "type": "example-value",
        })
    example_kubernetes_fleet_manager = azure.containerservice.KubernetesFleetManager("example",
        name="example",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_fleet_member = azure.containerservice.FleetMember("example",
        kubernetes_cluster_id=example.id,
        kubernetes_fleet_id=example_kubernetes_fleet_manager.id,
        name="example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/containerservice"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example, err := containerservice.NewKubernetesCluster(ctx, "example", &containerservice.KubernetesClusterArgs{
    			Name:              pulumi.String("example"),
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			DnsPrefix:         pulumi.String("acctestaksexample"),
    			DefaultNodePool: &containerservice.KubernetesClusterDefaultNodePoolArgs{
    				Name:      pulumi.String("example-value"),
    				NodeCount: pulumi.Int("example-value"),
    				VmSize:    pulumi.String("example-value"),
    				UpgradeSettings: &containerservice.KubernetesClusterDefaultNodePoolUpgradeSettingsArgs{
    					MaxSurge: pulumi.String("example-value"),
    				},
    			},
    			Identity: &containerservice.KubernetesClusterIdentityArgs{
    				Type: pulumi.String("example-value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleKubernetesFleetManager, err := containerservice.NewKubernetesFleetManager(ctx, "example", &containerservice.KubernetesFleetManagerArgs{
    			Name:              pulumi.String("example"),
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = containerservice.NewFleetMember(ctx, "example", &containerservice.FleetMemberArgs{
    			KubernetesClusterId: example.ID(),
    			KubernetesFleetId:   exampleKubernetesFleetManager.ID(),
    			Name:                pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var example = new Azure.ContainerService.KubernetesCluster("example", new()
        {
            Name = "example",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            DnsPrefix = "acctestaksexample",
            DefaultNodePool = new Azure.ContainerService.Inputs.KubernetesClusterDefaultNodePoolArgs
            {
                Name = "example-value",
                NodeCount = "example-value",
                VmSize = "example-value",
                UpgradeSettings = new Azure.ContainerService.Inputs.KubernetesClusterDefaultNodePoolUpgradeSettingsArgs
                {
                    MaxSurge = "example-value",
                },
            },
            Identity = new Azure.ContainerService.Inputs.KubernetesClusterIdentityArgs
            {
                Type = "example-value",
            },
        });
    
        var exampleKubernetesFleetManager = new Azure.ContainerService.KubernetesFleetManager("example", new()
        {
            Name = "example",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleFleetMember = new Azure.ContainerService.FleetMember("example", new()
        {
            KubernetesClusterId = example.Id,
            KubernetesFleetId = exampleKubernetesFleetManager.Id,
            Name = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.containerservice.KubernetesCluster;
    import com.pulumi.azure.containerservice.KubernetesClusterArgs;
    import com.pulumi.azure.containerservice.inputs.KubernetesClusterDefaultNodePoolArgs;
    import com.pulumi.azure.containerservice.inputs.KubernetesClusterDefaultNodePoolUpgradeSettingsArgs;
    import com.pulumi.azure.containerservice.inputs.KubernetesClusterIdentityArgs;
    import com.pulumi.azure.containerservice.KubernetesFleetManager;
    import com.pulumi.azure.containerservice.KubernetesFleetManagerArgs;
    import com.pulumi.azure.containerservice.FleetMember;
    import com.pulumi.azure.containerservice.FleetMemberArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var example = new KubernetesCluster("example", KubernetesClusterArgs.builder()
                .name("example")
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .dnsPrefix("acctestaksexample")
                .defaultNodePool(KubernetesClusterDefaultNodePoolArgs.builder()
                    .name("example-value")
                    .nodeCount("example-value")
                    .vmSize("example-value")
                    .upgradeSettings(KubernetesClusterDefaultNodePoolUpgradeSettingsArgs.builder()
                        .maxSurge("example-value")
                        .build())
                    .build())
                .identity(KubernetesClusterIdentityArgs.builder()
                    .type("example-value")
                    .build())
                .build());
    
            var exampleKubernetesFleetManager = new KubernetesFleetManager("exampleKubernetesFleetManager", KubernetesFleetManagerArgs.builder()
                .name("example")
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleFleetMember = new FleetMember("exampleFleetMember", FleetMemberArgs.builder()
                .kubernetesClusterId(example.id())
                .kubernetesFleetId(exampleKubernetesFleetManager.id())
                .name("example")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:containerservice:KubernetesCluster
        properties:
          name: example
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          dnsPrefix: acctestaksexample
          defaultNodePool:
            name: example-value
            nodeCount: example-value
            vmSize: example-value
            upgradeSettings:
              maxSurge: example-value
          identity:
            type: example-value
      exampleKubernetesFleetManager:
        type: azure:containerservice:KubernetesFleetManager
        name: example
        properties:
          name: example
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        name: example
        properties:
          name: example-resources
          location: West Europe
      exampleFleetMember:
        type: azure:containerservice:FleetMember
        name: example
        properties:
          kubernetesClusterId: ${example.id}
          kubernetesFleetId: ${exampleKubernetesFleetManager.id}
          name: example
    

    Create FleetMember Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FleetMember(name: string, args: FleetMemberArgs, opts?: CustomResourceOptions);
    @overload
    def FleetMember(resource_name: str,
                    args: FleetMemberArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def FleetMember(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    kubernetes_cluster_id: Optional[str] = None,
                    kubernetes_fleet_id: Optional[str] = None,
                    group: Optional[str] = None,
                    name: Optional[str] = None)
    func NewFleetMember(ctx *Context, name string, args FleetMemberArgs, opts ...ResourceOption) (*FleetMember, error)
    public FleetMember(string name, FleetMemberArgs args, CustomResourceOptions? opts = null)
    public FleetMember(String name, FleetMemberArgs args)
    public FleetMember(String name, FleetMemberArgs args, CustomResourceOptions options)
    
    type: azure:containerservice:FleetMember
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FleetMemberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FleetMemberArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FleetMemberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FleetMemberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FleetMemberArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fleetMemberResource = new Azure.ContainerService.FleetMember("fleetMemberResource", new()
    {
        KubernetesClusterId = "string",
        KubernetesFleetId = "string",
        Group = "string",
        Name = "string",
    });
    
    example, err := containerservice.NewFleetMember(ctx, "fleetMemberResource", &containerservice.FleetMemberArgs{
    	KubernetesClusterId: pulumi.String("string"),
    	KubernetesFleetId:   pulumi.String("string"),
    	Group:               pulumi.String("string"),
    	Name:                pulumi.String("string"),
    })
    
    var fleetMemberResource = new FleetMember("fleetMemberResource", FleetMemberArgs.builder()
        .kubernetesClusterId("string")
        .kubernetesFleetId("string")
        .group("string")
        .name("string")
        .build());
    
    fleet_member_resource = azure.containerservice.FleetMember("fleetMemberResource",
        kubernetes_cluster_id="string",
        kubernetes_fleet_id="string",
        group="string",
        name="string")
    
    const fleetMemberResource = new azure.containerservice.FleetMember("fleetMemberResource", {
        kubernetesClusterId: "string",
        kubernetesFleetId: "string",
        group: "string",
        name: "string",
    });
    
    type: azure:containerservice:FleetMember
    properties:
        group: string
        kubernetesClusterId: string
        kubernetesFleetId: string
        name: string
    

    FleetMember Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FleetMember resource accepts the following input properties:

    KubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    KubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    Group string
    The group this member belongs to for multi-cluster update management.
    Name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    KubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    KubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    Group string
    The group this member belongs to for multi-cluster update management.
    Name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesClusterId String
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId String
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    group String
    The group this member belongs to for multi-cluster update management.
    name String
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    group string
    The group this member belongs to for multi-cluster update management.
    name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetes_cluster_id str
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetes_fleet_id str
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    group str
    The group this member belongs to for multi-cluster update management.
    name str
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesClusterId String
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId String
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    group String
    The group this member belongs to for multi-cluster update management.
    name String
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FleetMember resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FleetMember Resource

    Get an existing FleetMember resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FleetMemberState, opts?: CustomResourceOptions): FleetMember
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group: Optional[str] = None,
            kubernetes_cluster_id: Optional[str] = None,
            kubernetes_fleet_id: Optional[str] = None,
            name: Optional[str] = None) -> FleetMember
    func GetFleetMember(ctx *Context, name string, id IDInput, state *FleetMemberState, opts ...ResourceOption) (*FleetMember, error)
    public static FleetMember Get(string name, Input<string> id, FleetMemberState? state, CustomResourceOptions? opts = null)
    public static FleetMember get(String name, Output<String> id, FleetMemberState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Group string
    The group this member belongs to for multi-cluster update management.
    KubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    KubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    Name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    Group string
    The group this member belongs to for multi-cluster update management.
    KubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    KubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    Name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    group String
    The group this member belongs to for multi-cluster update management.
    kubernetesClusterId String
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId String
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    name String
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    group string
    The group this member belongs to for multi-cluster update management.
    kubernetesClusterId string
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId string
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    name string
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    group str
    The group this member belongs to for multi-cluster update management.
    kubernetes_cluster_id str
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetes_fleet_id str
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    name str
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.
    group String
    The group this member belongs to for multi-cluster update management.
    kubernetesClusterId String
    The ARM resource ID of the cluster that joins the Fleet. Changing this forces a new Kubernetes Fleet Member to be created.
    kubernetesFleetId String
    Specifies the Kubernetes Fleet Id within which this Kubernetes Fleet Member should exist. Changing this forces a new Kubernetes Fleet Member to be created.
    name String
    Specifies the name of this Kubernetes Fleet Member. Changing this forces a new Kubernetes Fleet Member to be created.

    Import

    An existing Kubernetes Fleet Member can be imported into Pulumi using the resource id, e.g.

    $ pulumi import azure:containerservice/fleetMember:FleetMember example /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members/{memberName}
    
    • Where {subscriptionId} is the ID of the Azure Subscription where the Kubernetes Fleet Member exists. For example 12345678-1234-9876-4563-123456789012.

    • Where {resourceGroupName} is the name of Resource Group where this Kubernetes Fleet Member exists. For example example-resource-group.

    • Where {fleetName} is the name of the Fleet. For example fleetValue.

    • Where {memberName} is the name of the Member. For example memberValue.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi