com.pulumi.azure.extendedlocation.CustomLocation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.extendedlocation;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.extendedlocation.CustomLocationArgs;
import com.pulumi.azure.extendedlocation.inputs.CustomLocationState;
import com.pulumi.azure.extendedlocation.outputs.CustomLocationAuthentication;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Custom Location within an Extended Location.
*
* > **Note:** Installing and configuring the Azure Arc Agent on your Kubernetes Cluster to establish connectivity is outside the scope of this document. For more details refer to [Deploy agents to your cluster](https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/conceptual-agent-overview#deploy-agents-to-your-cluster) and [Connect an existing Kubernetes Cluster](https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/quickstart-connect-cluster?tabs=azure-cli#connect-an-existing-kubernetes-cluster). If you encounter issues connecting your Kubernetes Cluster to Azure Arc, we'd recommend opening a ticket with Microsoft Support.
*
* ## Import
*
* Custom Locations can be imported using the resource id, e.g.
*
* ```sh
* $ pulumi import azure:extendedlocation/customLocation:CustomLocation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ExtendedLocation/customLocations/example-custom-location
* ```
*
*/
@ResourceType(type="azure:extendedlocation/customLocation:CustomLocation")
public class CustomLocation extends com.pulumi.resources.CustomResource {
/**
* An `authentication` block as defined below.
*
*/
@Export(name="authentication", refs={CustomLocationAuthentication.class}, tree="[0]")
private Output authentication;
/**
* @return An `authentication` block as defined below.
*
*/
public Output> authentication() {
return Codegen.optional(this.authentication);
}
/**
* Specifies the list of Cluster Extension IDs.
*
*/
@Export(name="clusterExtensionIds", refs={List.class,String.class}, tree="[0,1]")
private Output> clusterExtensionIds;
/**
* @return Specifies the list of Cluster Extension IDs.
*
*/
public Output> clusterExtensionIds() {
return this.clusterExtensionIds;
}
/**
* Specifies the display name of the Custom Location.
*
*/
@Export(name="displayName", refs={String.class}, tree="[0]")
private Output displayName;
/**
* @return Specifies the display name of the Custom Location.
*
*/
public Output> displayName() {
return Codegen.optional(this.displayName);
}
/**
* Specifies the host resource ID.
*
*/
@Export(name="hostResourceId", refs={String.class}, tree="[0]")
private Output hostResourceId;
/**
* @return Specifies the host resource ID.
*
*/
public Output hostResourceId() {
return this.hostResourceId;
}
/**
* Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.
*
*/
@Export(name="hostType", refs={String.class}, tree="[0]")
private Output hostType;
/**
* @return Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.
*
*/
public Output> hostType() {
return Codegen.optional(this.hostType);
}
/**
* Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.
*
*/
public Output location() {
return this.location;
}
/**
* Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.
*
*/
public Output name() {
return this.name;
}
/**
* Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.
*
*/
@Export(name="namespace", refs={String.class}, tree="[0]")
private Output namespace;
/**
* @return Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.
*
*/
public Output namespace() {
return this.namespace;
}
/**
* Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public CustomLocation(java.lang.String name) {
this(name, CustomLocationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public CustomLocation(java.lang.String name, CustomLocationArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public CustomLocation(java.lang.String name, CustomLocationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:extendedlocation/customLocation:CustomLocation", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private CustomLocation(java.lang.String name, Output id, @Nullable CustomLocationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:extendedlocation/customLocation:CustomLocation", name, state, makeResourceOptions(options, id), false);
}
private static CustomLocationArgs makeArgs(CustomLocationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? CustomLocationArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static CustomLocation get(java.lang.String name, Output id, @Nullable CustomLocationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new CustomLocation(name, id, state, options);
}
}