com.pulumi.azurenative.network.UserRule 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.UserRuleArgs;
import com.pulumi.azurenative.network.outputs.AddressPrefixItemResponse;
import com.pulumi.azurenative.network.outputs.SystemDataResponse;
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.Optional;
import javax.annotation.Nullable;
/**
* Network security user rule.
* Azure REST API version: 2022-04-01-preview. Prior API version in Azure Native 1.x: 2021-02-01-preview.
*
* Other available API versions: 2021-05-01-preview.
*
* ## Example Usage
* ### Create a default user rule
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.UserRule;
* import com.pulumi.azurenative.network.UserRuleArgs;
* 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 userRule = new UserRule("userRule", UserRuleArgs.builder()
* .configurationName("myTestSecurityConfig")
* .networkManagerName("testNetworkManager")
* .resourceGroupName("rg1")
* .ruleCollectionName("testRuleCollection")
* .ruleName("SampleDefaultUserRule")
* .build());
*
* }
* }
*
* }
*
* ### Create a user rule
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.UserRule;
* import com.pulumi.azurenative.network.UserRuleArgs;
* import com.pulumi.azurenative.network.inputs.AddressPrefixItemArgs;
* 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 userRule = new UserRule("userRule", UserRuleArgs.builder()
* .configurationName("myTestSecurityConfig")
* .description("Sample User Rule")
* .destinationPortRanges("22")
* .destinations(AddressPrefixItemArgs.builder()
* .addressPrefix("*")
* .addressPrefixType("IPPrefix")
* .build())
* .direction("Inbound")
* .kind("Custom")
* .networkManagerName("testNetworkManager")
* .protocol("Tcp")
* .resourceGroupName("rg1")
* .ruleCollectionName("testRuleCollection")
* .ruleName("SampleUserRule")
* .sourcePortRanges("0-65535")
* .sources(AddressPrefixItemArgs.builder()
* .addressPrefix("*")
* .addressPrefixType("IPPrefix")
* .build())
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:network:UserRule SampleUserRule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
* ```
*
*/
@ResourceType(type="azure-native:network:UserRule")
public class UserRule extends com.pulumi.resources.CustomResource {
/**
* A description for this rule.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> description;
/**
* @return A description for this rule.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The destination port ranges.
*
*/
@Export(name="destinationPortRanges", refs={List.class,String.class}, tree="[0,1]")
private Output* @Nullable */ List> destinationPortRanges;
/**
* @return The destination port ranges.
*
*/
public Output>> destinationPortRanges() {
return Codegen.optional(this.destinationPortRanges);
}
/**
* The destination address prefixes. CIDR or destination IP ranges.
*
*/
@Export(name="destinations", refs={List.class,AddressPrefixItemResponse.class}, tree="[0,1]")
private Output* @Nullable */ List> destinations;
/**
* @return The destination address prefixes. CIDR or destination IP ranges.
*
*/
public Output>> destinations() {
return Codegen.optional(this.destinations);
}
/**
* Indicates if the traffic matched against the rule in inbound or outbound.
*
*/
@Export(name="direction", refs={String.class}, tree="[0]")
private Output direction;
/**
* @return Indicates if the traffic matched against the rule in inbound or outbound.
*
*/
public Output direction() {
return this.direction;
}
/**
* 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;
}
/**
* Whether the rule is custom or default.
* Expected value is 'Custom'.
*
*/
@Export(name="kind", refs={String.class}, tree="[0]")
private Output kind;
/**
* @return Whether the rule is custom or default.
* Expected value is 'Custom'.
*
*/
public Output kind() {
return this.kind;
}
/**
* Resource name.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Resource name.
*
*/
public Output name() {
return this.name;
}
/**
* Network protocol this rule applies to.
*
*/
@Export(name="protocol", refs={String.class}, tree="[0]")
private Output protocol;
/**
* @return Network protocol this rule applies to.
*
*/
public Output protocol() {
return this.protocol;
}
/**
* The provisioning state of the security configuration user rule resource.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the security configuration user rule resource.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The source port ranges.
*
*/
@Export(name="sourcePortRanges", refs={List.class,String.class}, tree="[0,1]")
private Output* @Nullable */ List> sourcePortRanges;
/**
* @return The source port ranges.
*
*/
public Output>> sourcePortRanges() {
return Codegen.optional(this.sourcePortRanges);
}
/**
* The CIDR or source IP ranges.
*
*/
@Export(name="sources", refs={List.class,AddressPrefixItemResponse.class}, tree="[0,1]")
private Output* @Nullable */ List> sources;
/**
* @return The CIDR or source IP ranges.
*
*/
public Output>> sources() {
return Codegen.optional(this.sources);
}
/**
* The system metadata related to this resource.
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return The system metadata related to this resource.
*
*/
public Output systemData() {
return this.systemData;
}
/**
* 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 UserRule(java.lang.String name) {
this(name, UserRuleArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public UserRule(java.lang.String name, UserRuleArgs 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 UserRule(java.lang.String name, UserRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:UserRule", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private UserRule(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:UserRule", name, null, makeResourceOptions(options, id), false);
}
private static UserRuleArgs makeArgs(UserRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
var builder = args == null ? UserRuleArgs.builder() : UserRuleArgs.builder(args);
return builder
.kind("Custom")
.build();
}
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/v20210201preview:UserRule").build()),
Output.of(Alias.builder().type("azure-native:network/v20210501preview:UserRule").build()),
Output.of(Alias.builder().type("azure-native:network/v20220201preview:UserRule").build()),
Output.of(Alias.builder().type("azure-native:network/v20220401preview:UserRule").build()),
Output.of(Alias.builder().type("azure-native:network/v20240301:UserRule").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 UserRule get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new UserRule(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy