@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.54 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 admin 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: 2021-02-01-preview, 2022-01-01, 2022-02-01-preview, 2022-04-01-preview, 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-01-01-preview, 2024-03-01, 2024-07-01, 2024-10-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 AdminRule extends pulumi.CustomResource {
/**
* Get an existing AdminRule 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): AdminRule;
/**
* Returns true if the given object is an instance of AdminRule. 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 AdminRule;
/**
* Indicates the access allowed for this particular rule
*/
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 port ranges.
*/
readonly destinationPortRanges: pulumi.Output<string[] | undefined>;
/**
* The destination address prefixes. CIDR or destination IP ranges.
*/
readonly destinations: pulumi.Output<outputs.network.AddressPrefixItemResponse[] | undefined>;
/**
* Indicates if the traffic matched against the rule in inbound or outbound.
*/
readonly direction: pulumi.Output<string>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* Whether the rule is custom or default.
* Expected value is 'Custom'.
*/
readonly kind: pulumi.Output<"Custom">;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The priority of the rule. The value can be between 1 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 resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Unique identifier for this resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* The source port ranges.
*/
readonly sourcePortRanges: pulumi.Output<string[] | undefined>;
/**
* The CIDR or source IP ranges.
*/
readonly sources: pulumi.Output<outputs.network.AddressPrefixItemResponse[] | undefined>;
/**
* The system metadata related to this resource.
*/
readonly systemData: pulumi.Output<outputs.network.SystemDataResponse>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a AdminRule 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: AdminRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AdminRule resource.
*/
export interface AdminRuleArgs {
/**
* Indicates the access allowed for this particular rule
*/
access: pulumi.Input<string | enums.network.SecurityConfigurationRuleAccess>;
/**
* The name of the network manager Security Configuration.
*/
configurationName: pulumi.Input<string>;
/**
* A description for this rule. Restricted to 140 chars.
*/
description?: pulumi.Input<string>;
/**
* The destination port ranges.
*/
destinationPortRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The destination address prefixes. CIDR or destination IP ranges.
*/
destinations?: pulumi.Input<pulumi.Input<inputs.network.AddressPrefixItemArgs>[]>;
/**
* Indicates if the traffic matched against the rule in inbound or outbound.
*/
direction: pulumi.Input<string | enums.network.SecurityConfigurationRuleDirection>;
/**
* Whether the rule is custom or default.
* Expected value is 'Custom'.
*/
kind: pulumi.Input<"Custom">;
/**
* The name of the network manager.
*/
networkManagerName: pulumi.Input<string>;
/**
* The priority of the rule. The value can be between 1 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.SecurityConfigurationRuleProtocol>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the network manager security Configuration rule collection.
*/
ruleCollectionName: pulumi.Input<string>;
/**
* The name of the rule.
*/
ruleName?: pulumi.Input<string>;
/**
* The source port ranges.
*/
sourcePortRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The CIDR or source IP ranges.
*/
sources?: pulumi.Input<pulumi.Input<inputs.network.AddressPrefixItemArgs>[]>;
}