Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. extendedlocation
  5. getCustomLocation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.extendedlocation.getCustomLocation

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the details of the customLocation with a specified resource group and name.

    Uses Azure REST API version 2021-08-31-preview.

    Other available API versions: 2021-08-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native extendedlocation [ApiVersion]. See the version guide for details.

    Using getCustomLocation

    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 getCustomLocation(args: GetCustomLocationArgs, opts?: InvokeOptions): Promise<GetCustomLocationResult>
function getCustomLocationOutput(args: GetCustomLocationOutputArgs, opts?: InvokeOptions): Output<GetCustomLocationResult>
    def get_custom_location(resource_group_name: Optional[str] = None,
                        resource_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCustomLocationResult
def get_custom_location_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        resource_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCustomLocationResult]
    func LookupCustomLocation(ctx *Context, args *LookupCustomLocationArgs, opts ...InvokeOption) (*LookupCustomLocationResult, error)
func LookupCustomLocationOutput(ctx *Context, args *LookupCustomLocationOutputArgs, opts ...InvokeOption) LookupCustomLocationResultOutput

    > Note: This function is named LookupCustomLocation in the Go SDK.

    public static class GetCustomLocation 
{
    public static Task<GetCustomLocationResult> InvokeAsync(GetCustomLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomLocationResult> Invoke(GetCustomLocationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomLocationResult> getCustomLocation(GetCustomLocationArgs args, InvokeOptions options)
public static Output<GetCustomLocationResult> getCustomLocation(GetCustomLocationArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:extendedlocation:getCustomLocation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    Custom Locations name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    Custom Locations name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    Custom Locations name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    Custom Locations name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    Custom Locations name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    Custom Locations name.

    getCustomLocation Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    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"
    Authentication Pulumi.AzureNative.ExtendedLocation.Outputs.CustomLocationPropertiesResponseAuthentication
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    Identity Pulumi.AzureNative.ExtendedLocation.Outputs.IdentityResponse
    Identity for the resource.
    Namespace string
    Kubernetes namespace that will be created on the specified cluster.
    ProvisioningState string
    Provisioning State for the Custom Location.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    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"
    Authentication CustomLocationPropertiesResponseAuthentication
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    Identity IdentityResponse
    Identity for the resource.
    Namespace string
    Kubernetes namespace that will be created on the specified cluster.
    ProvisioningState string
    Provisioning State for the Custom Location.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    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"
    authentication CustomLocationPropertiesResponseAuthentication
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    identity IdentityResponse
    Identity for the resource.
    namespace String
    Kubernetes namespace that will be created on the specified cluster.
    provisioningState String
    Provisioning State for the Custom Location.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    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"
    authentication CustomLocationPropertiesResponseAuthentication
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    identity IdentityResponse
    Identity for the resource.
    namespace string
    Kubernetes namespace that will be created on the specified cluster.
    provisioningState string
    Provisioning State for the Custom Location.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    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"
    authentication CustomLocationPropertiesResponseAuthentication
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    identity IdentityResponse
    Identity for the resource.
    namespace str
    Kubernetes namespace that will be created on the specified cluster.
    provisioning_state str
    Provisioning State for the Custom Location.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    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"
    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
    Type of host the Custom Locations is referencing (Kubernetes, etc...).
    identity Property Map
    Identity for the resource.
    namespace String
    Kubernetes namespace that will be created on the specified cluster.
    provisioningState String
    Provisioning State for the Custom Location.
    tags Map<String>
    Resource tags.

    Supporting Types

    CustomLocationPropertiesResponseAuthentication

    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

    IdentityResponse

    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.

    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
    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native