@kengachu-pulumi/azure-native-documentdb
Version:
Pulumi Azure Native package for documentdb
73 lines (72 loc) • 2.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
* Represents a mongo cluster firewall rule.
*
* Uses Azure REST API version 2024-03-01-preview.
*
* Other available API versions: 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.
*/
export declare class FirewallRule extends pulumi.CustomResource {
/**
* Get an existing FirewallRule 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): FirewallRule;
/** @internal */
static readonly __pulumiType = "azure-native:documentdb:FirewallRule";
/**
* Returns true if the given object is an instance of FirewallRule. 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 FirewallRule;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The resource-specific properties for this resource.
*/
readonly properties: pulumi.Output<types.outputs.FirewallRulePropertiesResponse>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<types.outputs.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a FirewallRule 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: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a FirewallRule resource.
*/
export interface FirewallRuleArgs {
/**
* The name of the mongo cluster firewall rule.
*/
firewallRuleName?: pulumi.Input<string>;
/**
* The name of the mongo cluster.
*/
mongoClusterName: pulumi.Input<string>;
/**
* The resource-specific properties for this resource.
*/
properties?: pulumi.Input<types.inputs.FirewallRulePropertiesArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}