1. Packages
  2. Azure Native
  3. API Docs
  4. extendedlocation
  5. CustomLocation
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.extendedlocation.CustomLocation

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

    Custom Locations definition. Azure REST API version: 2021-08-15. Prior API version in Azure Native 1.x: 2021-03-15-preview

    Example Usage

    Create/Update Custom Location

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var customLocation = new AzureNative.ExtendedLocation.CustomLocation("customLocation", new()
        {
            Authentication = new AzureNative.ExtendedLocation.Inputs.CustomLocationPropertiesAuthenticationArgs
            {
                Type = "KubeConfig",
                Value = "<base64 KubeConfig>",
            },
            ClusterExtensionIds = new[]
            {
                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension",
            },
            DisplayName = "customLocationLocation01",
            HostResourceId = "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01",
            Identity = new AzureNative.ExtendedLocation.Inputs.IdentityArgs
            {
                Type = "SystemAssigned",
            },
            Location = "West US",
            Namespace = "namespace01",
            ResourceGroupName = "testresourcegroup",
            ResourceName = "customLocation01",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/extendedlocation/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := extendedlocation.NewCustomLocation(ctx, "customLocation", &extendedlocation.CustomLocationArgs{
    			Authentication: &extendedlocation.CustomLocationPropertiesAuthenticationArgs{
    				Type:  pulumi.String("KubeConfig"),
    				Value: pulumi.String("<base64 KubeConfig>"),
    			},
    			ClusterExtensionIds: pulumi.StringArray{
    				pulumi.String("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"),
    			},
    			DisplayName:    pulumi.String("customLocationLocation01"),
    			HostResourceId: pulumi.String("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
    			Identity: &extendedlocation.IdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    			Location:          pulumi.String("West US"),
    			Namespace:         pulumi.String("namespace01"),
    			ResourceGroupName: pulumi.String("testresourcegroup"),
    			ResourceName:      pulumi.String("customLocation01"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.extendedlocation.CustomLocation;
    import com.pulumi.azurenative.extendedlocation.CustomLocationArgs;
    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 customLocation = new CustomLocation("customLocation", CustomLocationArgs.builder()        
                .authentication(Map.ofEntries(
                    Map.entry("type", "KubeConfig"),
                    Map.entry("value", "<base64 KubeConfig>")
                ))
                .clusterExtensionIds("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")
                .displayName("customLocationLocation01")
                .hostResourceId("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01")
                .identity(Map.of("type", "SystemAssigned"))
                .location("West US")
                .namespace("namespace01")
                .resourceGroupName("testresourcegroup")
                .resourceName("customLocation01")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    custom_location = azure_native.extendedlocation.CustomLocation("customLocation",
        authentication=azure_native.extendedlocation.CustomLocationPropertiesAuthenticationArgs(
            type="KubeConfig",
            value="<base64 KubeConfig>",
        ),
        cluster_extension_ids=["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"],
        display_name="customLocationLocation01",
        host_resource_id="/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01",
        identity=azure_native.extendedlocation.IdentityArgs(
            type="SystemAssigned",
        ),
        location="West US",
        namespace="namespace01",
        resource_group_name="testresourcegroup",
        resource_name_="customLocation01")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const customLocation = new azure_native.extendedlocation.CustomLocation("customLocation", {
        authentication: {
            type: "KubeConfig",
            value: "<base64 KubeConfig>",
        },
        clusterExtensionIds: ["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"],
        displayName: "customLocationLocation01",
        hostResourceId: "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01",
        identity: {
            type: "SystemAssigned",
        },
        location: "West US",
        namespace: "namespace01",
        resourceGroupName: "testresourcegroup",
        resourceName: "customLocation01",
    });
    
    resources:
      customLocation:
        type: azure-native:extendedlocation:CustomLocation
        properties:
          authentication:
            type: KubeConfig
            value: <base64 KubeConfig>
          clusterExtensionIds:
            - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension
          displayName: customLocationLocation01
          hostResourceId: /subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01
          identity:
            type: SystemAssigned
          location: West US
          namespace: namespace01
          resourceGroupName: testresourcegroup
          resourceName: customLocation01
    

    Create CustomLocation Resource

    new CustomLocation(name: string, args: CustomLocationArgs, opts?: CustomResourceOptions);
    @overload
    def CustomLocation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       authentication: Optional[CustomLocationPropertiesAuthenticationArgs] = None,
                       cluster_extension_ids: Optional[Sequence[str]] = None,
                       display_name: Optional[str] = None,
                       host_resource_id: Optional[str] = None,
                       host_type: Optional[Union[str, HostType]] = None,
                       identity: Optional[IdentityArgs] = None,
                       location: Optional[str] = None,
                       namespace: Optional[str] = None,
                       provisioning_state: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       resource_name_: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    @overload
    def CustomLocation(resource_name: str,
                       args: CustomLocationArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewCustomLocation(ctx *Context, name string, args CustomLocationArgs, opts ...ResourceOption) (*CustomLocation, error)
    public CustomLocation(string name, CustomLocationArgs args, CustomResourceOptions? opts = null)
    public CustomLocation(String name, CustomLocationArgs args)
    public CustomLocation(String name, CustomLocationArgs args, CustomResourceOptions options)
    
    type: azure-native:extendedlocation:CustomLocation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args CustomLocationArgs
    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 CustomLocationArgs
    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 CustomLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomLocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CustomLocation Resource Properties

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

    Inputs

    The CustomLocation resource accepts the following input properties:

    ResourceGroupName string

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

    Authentication Pulumi.AzureNative.ExtendedLocation.Inputs.CustomLocationPropertiesAuthentication

    This is optional input that contains the authentication that should be used to generate the namespace.

    ClusterExtensionIds List<string>

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    DisplayName string

    Display name for the Custom Locations location.

    HostResourceId string

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    HostType string | Pulumi.AzureNative.ExtendedLocation.HostType

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    Identity Pulumi.AzureNative.ExtendedLocation.Inputs.Identity

    Identity for the resource.

    Location string

    The geo-location where the resource lives

    Namespace string

    Kubernetes namespace that will be created on the specified cluster.

    ProvisioningState string

    Provisioning State for the Custom Location.

    ResourceName string

    Custom Locations name.

    Tags Dictionary<string, string>

    Resource tags.

    ResourceGroupName string

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

    Authentication CustomLocationPropertiesAuthenticationArgs

    This is optional input that contains the authentication that should be used to generate the namespace.

    ClusterExtensionIds []string

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    DisplayName string

    Display name for the Custom Locations location.

    HostResourceId string

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    HostType string | HostType

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    Identity IdentityArgs

    Identity for the resource.

    Location string

    The geo-location where the resource lives

    Namespace string

    Kubernetes namespace that will be created on the specified cluster.

    ProvisioningState string

    Provisioning State for the Custom Location.

    ResourceName string

    Custom Locations name.

    Tags map[string]string

    Resource tags.

    resourceGroupName String

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

    authentication CustomLocationPropertiesAuthentication

    This is optional input that contains the authentication that should be used to generate the namespace.

    clusterExtensionIds List<String>

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    displayName String

    Display name for the Custom Locations location.

    hostResourceId String

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    hostType String | HostType

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    identity Identity

    Identity for the resource.

    location String

    The geo-location where the resource lives

    namespace String

    Kubernetes namespace that will be created on the specified cluster.

    provisioningState String

    Provisioning State for the Custom Location.

    resourceName String

    Custom Locations name.

    tags Map<String,String>

    Resource tags.

    resourceGroupName string

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

    authentication CustomLocationPropertiesAuthentication

    This is optional input that contains the authentication that should be used to generate the namespace.

    clusterExtensionIds string[]

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    displayName string

    Display name for the Custom Locations location.

    hostResourceId string

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    hostType string | HostType

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    identity Identity

    Identity for the resource.

    location string

    The geo-location where the resource lives

    namespace string

    Kubernetes namespace that will be created on the specified cluster.

    provisioningState string

    Provisioning State for the Custom Location.

    resourceName string

    Custom Locations name.

    tags {[key: string]: string}

    Resource tags.

    resource_group_name str

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

    authentication CustomLocationPropertiesAuthenticationArgs

    This is optional input that contains the authentication that should be used to generate the namespace.

    cluster_extension_ids Sequence[str]

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    display_name str

    Display name for the Custom Locations location.

    host_resource_id str

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    host_type str | HostType

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    identity IdentityArgs

    Identity for the resource.

    location str

    The geo-location where the resource lives

    namespace str

    Kubernetes namespace that will be created on the specified cluster.

    provisioning_state str

    Provisioning State for the Custom Location.

    resource_name str

    Custom Locations name.

    tags Mapping[str, str]

    Resource tags.

    resourceGroupName String

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

    authentication Property Map

    This is optional input that contains the authentication that should be used to generate the namespace.

    clusterExtensionIds List<String>

    Contains the reference to the add-on that contains charts to deploy CRDs and operators.

    displayName String

    Display name for the Custom Locations location.

    hostResourceId String

    Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.

    hostType String | "Kubernetes"

    Type of host the Custom Locations is referencing (Kubernetes, etc...).

    identity Property Map

    Identity for the resource.

    location String

    The geo-location where the resource lives

    namespace String

    Kubernetes namespace that will be created on the specified cluster.

    provisioningState String

    Provisioning State for the Custom Location.

    resourceName String

    Custom Locations name.

    tags Map<String>

    Resource tags.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    SystemData Pulumi.AzureNative.ExtendedLocation.Outputs.SystemDataResponse

    Metadata pertaining to creation and last modification of the resource

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    SystemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the resource

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the resource

    system_data SystemDataResponse

    Metadata pertaining to creation and last modification of the resource

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    systemData Property Map

    Metadata pertaining to creation and last modification of the resource

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    CustomLocationPropertiesAuthentication, CustomLocationPropertiesAuthenticationArgs

    Type string

    The type of the Custom Locations authentication

    Value string

    The kubeconfig value.

    Type string

    The type of the Custom Locations authentication

    Value string

    The kubeconfig value.

    type String

    The type of the Custom Locations authentication

    value String

    The kubeconfig value.

    type string

    The type of the Custom Locations authentication

    value string

    The kubeconfig value.

    type str

    The type of the Custom Locations authentication

    value str

    The kubeconfig value.

    type String

    The type of the Custom Locations authentication

    value String

    The kubeconfig value.

    CustomLocationPropertiesResponseAuthentication, CustomLocationPropertiesResponseAuthenticationArgs

    Type string

    The type of the Custom Locations authentication

    Type string

    The type of the Custom Locations authentication

    type String

    The type of the Custom Locations authentication

    type string

    The type of the Custom Locations authentication

    type str

    The type of the Custom Locations authentication

    type String

    The type of the Custom Locations authentication

    HostType, HostTypeArgs

    Kubernetes
    Kubernetes
    HostTypeKubernetes
    Kubernetes
    Kubernetes
    Kubernetes
    Kubernetes
    Kubernetes
    KUBERNETES
    Kubernetes
    "Kubernetes"
    Kubernetes

    Identity, IdentityArgs

    Type string | ResourceIdentityType

    The identity type.

    type String | ResourceIdentityType

    The identity type.

    type string | ResourceIdentityType

    The identity type.

    type str | ResourceIdentityType

    The identity type.

    type String | "SystemAssigned" | "None"

    The identity type.

    IdentityResponse, IdentityResponseArgs

    PrincipalId string

    The principal ID of resource identity.

    TenantId string

    The tenant ID of resource.

    Type string

    The identity type.

    PrincipalId string

    The principal ID of resource identity.

    TenantId string

    The tenant ID of resource.

    Type string

    The identity type.

    principalId String

    The principal ID of resource identity.

    tenantId String

    The tenant ID of resource.

    type String

    The identity type.

    principalId string

    The principal ID of resource identity.

    tenantId string

    The tenant ID of resource.

    type string

    The identity type.

    principal_id str

    The principal ID of resource identity.

    tenant_id str

    The tenant ID of resource.

    type str

    The identity type.

    principalId String

    The principal ID of resource identity.

    tenantId String

    The tenant ID of resource.

    type String

    The identity type.

    ResourceIdentityType, ResourceIdentityTypeArgs

    SystemAssigned
    SystemAssigned
    None
    None
    ResourceIdentityTypeSystemAssigned
    SystemAssigned
    ResourceIdentityTypeNone
    None
    SystemAssigned
    SystemAssigned
    None
    None
    SystemAssigned
    SystemAssigned
    None
    None
    SYSTEM_ASSIGNED
    SystemAssigned
    NONE
    None
    "SystemAssigned"
    SystemAssigned
    "None"
    None

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:extendedlocation:CustomLocation customLocation01 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName} 
    

    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