@bdzscaler/pulumi-zpa
Version:
A Pulumi package for creating and managing Zscaler Private Access (ZPA) cloud resources.
189 lines (188 loc) • 6.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Import
*
* Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.
*
* Visit
*
* Provisioning key can be imported by using `<PROVISIONING KEY ID>` or `<PROVISIONING KEY NAME>` as the import ID.
*
* For example:
*
* ```sh
* $ pulumi import zpa:index/provisioningKey:ProvisioningKey example <provisioning_key_id>
* ```
*
* or
*
* ```sh
* $ pulumi import zpa:index/provisioningKey:ProvisioningKey example <provisioning_key_name>
* ```
*/
export declare class ProvisioningKey extends pulumi.CustomResource {
/**
* Get an existing ProvisioningKey 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProvisioningKeyState, opts?: pulumi.CustomResourceOptions): ProvisioningKey;
/**
* Returns true if the given object is an instance of ProvisioningKey. 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 ProvisioningKey;
/**
* read only field. Ignored in PUT/POST calls.
*/
readonly ProvisioningKeyValue: pulumi.Output<string>;
readonly appConnectorGroupId: pulumi.Output<string | undefined>;
/**
* Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
*/
readonly appConnectorGroupName: pulumi.Output<string>;
/**
* Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are
* CONNECTOR_GRP and SERVICE_EDGE_GRP.
*/
readonly associationType: pulumi.Output<string>;
/**
* Whether the provisioning key is enabled or not. Supported values: true, false
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* ID of the enrollment certificate that can be used for this provisioning key.
*/
readonly enrollmentCertId: pulumi.Output<string>;
readonly ipAcls: pulumi.Output<string[] | undefined>;
/**
* The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
*/
readonly maxUsage: pulumi.Output<string>;
readonly microtenantId: pulumi.Output<string>;
/**
* Name of the provisioning key.
*/
readonly name: pulumi.Output<string>;
readonly uiConfig: pulumi.Output<string | undefined>;
/**
* The provisioning key utilization count.
*/
readonly usageCount: pulumi.Output<string>;
/**
* ID of the existing App Connector or Service Edge Group.
*/
readonly zcomponentId: pulumi.Output<string>;
/**
* Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
*/
readonly zcomponentName: pulumi.Output<string>;
/**
* Create a ProvisioningKey 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: ProvisioningKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProvisioningKey resources.
*/
export interface ProvisioningKeyState {
/**
* read only field. Ignored in PUT/POST calls.
*/
ProvisioningKeyValue?: pulumi.Input<string>;
appConnectorGroupId?: pulumi.Input<string>;
/**
* Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
*/
appConnectorGroupName?: pulumi.Input<string>;
/**
* Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are
* CONNECTOR_GRP and SERVICE_EDGE_GRP.
*/
associationType?: pulumi.Input<string>;
/**
* Whether the provisioning key is enabled or not. Supported values: true, false
*/
enabled?: pulumi.Input<boolean>;
/**
* ID of the enrollment certificate that can be used for this provisioning key.
*/
enrollmentCertId?: pulumi.Input<string>;
ipAcls?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
*/
maxUsage?: pulumi.Input<string>;
microtenantId?: pulumi.Input<string>;
/**
* Name of the provisioning key.
*/
name?: pulumi.Input<string>;
uiConfig?: pulumi.Input<string>;
/**
* The provisioning key utilization count.
*/
usageCount?: pulumi.Input<string>;
/**
* ID of the existing App Connector or Service Edge Group.
*/
zcomponentId?: pulumi.Input<string>;
/**
* Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
*/
zcomponentName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ProvisioningKey resource.
*/
export interface ProvisioningKeyArgs {
/**
* read only field. Ignored in PUT/POST calls.
*/
ProvisioningKeyValue?: pulumi.Input<string>;
appConnectorGroupId?: pulumi.Input<string>;
/**
* Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are
* CONNECTOR_GRP and SERVICE_EDGE_GRP.
*/
associationType: pulumi.Input<string>;
/**
* Whether the provisioning key is enabled or not. Supported values: true, false
*/
enabled?: pulumi.Input<boolean>;
/**
* ID of the enrollment certificate that can be used for this provisioning key.
*/
enrollmentCertId: pulumi.Input<string>;
ipAcls?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
*/
maxUsage: pulumi.Input<string>;
microtenantId?: pulumi.Input<string>;
/**
* Name of the provisioning key.
*/
name?: pulumi.Input<string>;
uiConfig?: pulumi.Input<string>;
/**
* The provisioning key utilization count.
*/
usageCount?: pulumi.Input<string>;
/**
* ID of the existing App Connector or Service Edge Group.
*/
zcomponentId: pulumi.Input<string>;
/**
* Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
*/
zcomponentName?: pulumi.Input<string>;
}