@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Network security rule.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class SecurityRule extends pulumi.CustomResource {
/**
* Get an existing SecurityRule 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): SecurityRule;
/**
* Returns true if the given object is an instance of SecurityRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is SecurityRule;
/**
* The network traffic is allowed or denied.
*/
readonly access: pulumi.Output<string>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* A description for this rule. Restricted to 140 chars.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
*/
readonly destinationAddressPrefix: pulumi.Output<string | undefined>;
/**
* The destination address prefixes. CIDR or destination IP ranges.
*/
readonly destinationAddressPrefixes: pulumi.Output<string[] | undefined>;
/**
* The application security group specified as destination.
*/
readonly destinationApplicationSecurityGroups: pulumi.Output<outputs.network.ApplicationSecurityGroupResponse[] | undefined>;
/**
* The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
*/
readonly destinationPortRange: pulumi.Output<string | undefined>;
/**
* The destination port ranges.
*/
readonly destinationPortRanges: pulumi.Output<string[] | undefined>;
/**
* The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
*/
readonly direction: pulumi.Output<string>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
*/
readonly priority: pulumi.Output<number>;
/**
* Network protocol this rule applies to.
*/
readonly protocol: pulumi.Output<string>;
/**
* The provisioning state of the security rule resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
*/
readonly sourceAddressPrefix: pulumi.Output<string | undefined>;
/**
* The CIDR or source IP ranges.
*/
readonly sourceAddressPrefixes: pulumi.Output<string[] | undefined>;
/**
* The application security group specified as source.
*/
readonly sourceApplicationSecurityGroups: pulumi.Output<outputs.network.ApplicationSecurityGroupResponse[] | undefined>;
/**
* The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
*/
readonly sourcePortRange: pulumi.Output<string | undefined>;
/**
* The source port ranges.
*/
readonly sourcePortRanges: pulumi.Output<string[] | undefined>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a SecurityRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SecurityRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a SecurityRule resource.
*/
export interface SecurityRuleArgs {
/**
* The network traffic is allowed or denied.
*/
access: pulumi.Input<string | enums.network.SecurityRuleAccess>;
/**
* A description for this rule. Restricted to 140 chars.
*/
description?: pulumi.Input<string>;
/**
* The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.
*/
destinationAddressPrefix?: pulumi.Input<string>;
/**
* The destination address prefixes. CIDR or destination IP ranges.
*/
destinationAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The application security group specified as destination.
*/
destinationApplicationSecurityGroups?: pulumi.Input<pulumi.Input<inputs.network.ApplicationSecurityGroupArgs>[]>;
/**
* The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
*/
destinationPortRange?: pulumi.Input<string>;
/**
* The destination port ranges.
*/
destinationPortRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
*/
direction: pulumi.Input<string | enums.network.SecurityRuleDirection>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
name?: pulumi.Input<string>;
/**
* The name of the network security group.
*/
networkSecurityGroupName: pulumi.Input<string>;
/**
* The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
*/
priority: pulumi.Input<number>;
/**
* Network protocol this rule applies to.
*/
protocol: pulumi.Input<string | enums.network.SecurityRuleProtocol>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the security rule.
*/
securityRuleName?: pulumi.Input<string>;
/**
* The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.
*/
sourceAddressPrefix?: pulumi.Input<string>;
/**
* The CIDR or source IP ranges.
*/
sourceAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The application security group specified as source.
*/
sourceApplicationSecurityGroups?: pulumi.Input<pulumi.Input<inputs.network.ApplicationSecurityGroupArgs>[]>;
/**
* The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
*/
sourcePortRange?: pulumi.Input<string>;
/**
* The source port ranges.
*/
sourcePortRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the resource.
*/
type?: pulumi.Input<string>;
}