com.pulumi.azurenative.network.PrivateEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** 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.azurenative.network;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.network.PrivateEndpointArgs;
import com.pulumi.azurenative.network.outputs.ApplicationSecurityGroupResponse;
import com.pulumi.azurenative.network.outputs.CustomDnsConfigPropertiesFormatResponse;
import com.pulumi.azurenative.network.outputs.ExtendedLocationResponse;
import com.pulumi.azurenative.network.outputs.NetworkInterfaceResponse;
import com.pulumi.azurenative.network.outputs.PrivateEndpointIPConfigurationResponse;
import com.pulumi.azurenative.network.outputs.PrivateLinkServiceConnectionResponse;
import com.pulumi.azurenative.network.outputs.SubnetResponse;
import com.pulumi.core.Alias;
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.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Private endpoint resource.
* Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.
*
* Other available API versions: 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01.
*
* ## Example Usage
* ### Create private endpoint
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.PrivateEndpoint;
* import com.pulumi.azurenative.network.PrivateEndpointArgs;
* import com.pulumi.azurenative.network.inputs.PrivateEndpointIPConfigurationArgs;
* import com.pulumi.azurenative.network.inputs.PrivateLinkServiceConnectionArgs;
* import com.pulumi.azurenative.network.inputs.SubnetArgs;
* 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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
* .customNetworkInterfaceName("testPeNic")
* .ipConfigurations(PrivateEndpointIPConfigurationArgs.builder()
* .groupId("file")
* .memberName("file")
* .name("pestaticconfig")
* .privateIPAddress("192.168.0.6")
* .build())
* .location("eastus2euap")
* .privateEndpointName("testPe")
* .privateLinkServiceConnections(PrivateLinkServiceConnectionArgs.builder()
* .groupIds("groupIdFromResource")
* .privateLinkServiceId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls")
* .requestMessage("Please approve my connection.")
* .build())
* .resourceGroupName("rg1")
* .subnet(SubnetArgs.builder()
* .id("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet")
* .build())
* .build());
*
* }
* }
*
* }
*
* ### Create private endpoint with application security groups
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.PrivateEndpoint;
* import com.pulumi.azurenative.network.PrivateEndpointArgs;
* import com.pulumi.azurenative.network.inputs.ApplicationSecurityGroupArgs;
* import com.pulumi.azurenative.network.inputs.PrivateLinkServiceConnectionArgs;
* import com.pulumi.azurenative.network.inputs.SubnetArgs;
* 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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
* .applicationSecurityGroups(ApplicationSecurityGroupArgs.builder()
* .id("/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1")
* .build())
* .location("eastus2euap")
* .privateEndpointName("testPe")
* .privateLinkServiceConnections(PrivateLinkServiceConnectionArgs.builder()
* .groupIds("groupIdFromResource")
* .privateLinkServiceId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls")
* .requestMessage("Please approve my connection.")
* .build())
* .resourceGroupName("rg1")
* .subnet(SubnetArgs.builder()
* .id("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet")
* .build())
* .build());
*
* }
* }
*
* }
*
* ### Create private endpoint with manual approval connection
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.PrivateEndpoint;
* import com.pulumi.azurenative.network.PrivateEndpointArgs;
* import com.pulumi.azurenative.network.inputs.PrivateEndpointIPConfigurationArgs;
* import com.pulumi.azurenative.network.inputs.PrivateLinkServiceConnectionArgs;
* import com.pulumi.azurenative.network.inputs.SubnetArgs;
* 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 privateEndpoint = new PrivateEndpoint("privateEndpoint", PrivateEndpointArgs.builder()
* .customNetworkInterfaceName("testPeNic")
* .ipConfigurations(PrivateEndpointIPConfigurationArgs.builder()
* .groupId("file")
* .memberName("file")
* .name("pestaticconfig")
* .privateIPAddress("192.168.0.5")
* .build())
* .location("eastus")
* .manualPrivateLinkServiceConnections(PrivateLinkServiceConnectionArgs.builder()
* .groupIds("groupIdFromResource")
* .privateLinkServiceId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls")
* .requestMessage("Please manually approve my connection.")
* .build())
* .privateEndpointName("testPe")
* .resourceGroupName("rg1")
* .subnet(SubnetArgs.builder()
* .id("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet")
* .build())
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:network:PrivateEndpoint testPe /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}
* ```
*
*/
@ResourceType(type="azure-native:network:PrivateEndpoint")
public class PrivateEndpoint extends com.pulumi.resources.CustomResource {
/**
* Application security groups in which the private endpoint IP configuration is included.
*
*/
@Export(name="applicationSecurityGroups", refs={List.class,ApplicationSecurityGroupResponse.class}, tree="[0,1]")
private Output> applicationSecurityGroups;
/**
* @return Application security groups in which the private endpoint IP configuration is included.
*
*/
public Output>> applicationSecurityGroups() {
return Codegen.optional(this.applicationSecurityGroups);
}
/**
* An array of custom dns configurations.
*
*/
@Export(name="customDnsConfigs", refs={List.class,CustomDnsConfigPropertiesFormatResponse.class}, tree="[0,1]")
private Output> customDnsConfigs;
/**
* @return An array of custom dns configurations.
*
*/
public Output>> customDnsConfigs() {
return Codegen.optional(this.customDnsConfigs);
}
/**
* The custom name of the network interface attached to the private endpoint.
*
*/
@Export(name="customNetworkInterfaceName", refs={String.class}, tree="[0]")
private Output customNetworkInterfaceName;
/**
* @return The custom name of the network interface attached to the private endpoint.
*
*/
public Output> customNetworkInterfaceName() {
return Codegen.optional(this.customNetworkInterfaceName);
}
/**
* A unique read-only string that changes whenever the resource is updated.
*
*/
@Export(name="etag", refs={String.class}, tree="[0]")
private Output etag;
/**
* @return A unique read-only string that changes whenever the resource is updated.
*
*/
public Output etag() {
return this.etag;
}
/**
* The extended location of the load balancer.
*
*/
@Export(name="extendedLocation", refs={ExtendedLocationResponse.class}, tree="[0]")
private Output extendedLocation;
/**
* @return The extended location of the load balancer.
*
*/
public Output> extendedLocation() {
return Codegen.optional(this.extendedLocation);
}
/**
* A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
*
*/
@Export(name="ipConfigurations", refs={List.class,PrivateEndpointIPConfigurationResponse.class}, tree="[0,1]")
private Output> ipConfigurations;
/**
* @return A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
*
*/
public Output>> ipConfigurations() {
return Codegen.optional(this.ipConfigurations);
}
/**
* Resource location.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Resource location.
*
*/
public Output> location() {
return Codegen.optional(this.location);
}
/**
* A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
*
*/
@Export(name="manualPrivateLinkServiceConnections", refs={List.class,PrivateLinkServiceConnectionResponse.class}, tree="[0,1]")
private Output> manualPrivateLinkServiceConnections;
/**
* @return A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
*
*/
public Output>> manualPrivateLinkServiceConnections() {
return Codegen.optional(this.manualPrivateLinkServiceConnections);
}
/**
* Resource name.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Resource name.
*
*/
public Output name() {
return this.name;
}
/**
* An array of references to the network interfaces created for this private endpoint.
*
*/
@Export(name="networkInterfaces", refs={List.class,NetworkInterfaceResponse.class}, tree="[0,1]")
private Output> networkInterfaces;
/**
* @return An array of references to the network interfaces created for this private endpoint.
*
*/
public Output> networkInterfaces() {
return this.networkInterfaces;
}
/**
* A grouping of information about the connection to the remote resource.
*
*/
@Export(name="privateLinkServiceConnections", refs={List.class,PrivateLinkServiceConnectionResponse.class}, tree="[0,1]")
private Output> privateLinkServiceConnections;
/**
* @return A grouping of information about the connection to the remote resource.
*
*/
public Output>> privateLinkServiceConnections() {
return Codegen.optional(this.privateLinkServiceConnections);
}
/**
* The provisioning state of the private endpoint resource.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the private endpoint resource.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The ID of the subnet from which the private IP will be allocated.
*
*/
@Export(name="subnet", refs={SubnetResponse.class}, tree="[0]")
private Output subnet;
/**
* @return The ID of the subnet from which the private IP will be allocated.
*
*/
public Output> subnet() {
return Codegen.optional(this.subnet);
}
/**
* Resource tags.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Resource tags.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* Resource type.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return Resource type.
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public PrivateEndpoint(java.lang.String name) {
this(name, PrivateEndpointArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public PrivateEndpoint(java.lang.String name, PrivateEndpointArgs 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 PrivateEndpoint(java.lang.String name, PrivateEndpointArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:PrivateEndpoint", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private PrivateEndpoint(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:PrivateEndpoint", name, null, makeResourceOptions(options, id), false);
}
private static PrivateEndpointArgs makeArgs(PrivateEndpointArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? PrivateEndpointArgs.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())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:network/v20180801:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20181001:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20181101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20181201:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190201:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190401:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190601:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190701:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190801:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20190901:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20191101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20191201:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200301:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200401:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200501:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200601:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200701:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20200801:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20201101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20210201:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20210301:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20210501:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20210801:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20220101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20220501:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20220701:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20220901:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20221101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20230201:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20230401:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20230501:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20230601:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20230901:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20231101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20240101:PrivateEndpoint").build()),
Output.of(Alias.builder().type("azure-native:network/v20240301:PrivateEndpoint").build())
))
.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 options Optional settings to control the behavior of the CustomResource.
*/
public static PrivateEndpoint get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new PrivateEndpoint(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy