Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. ProvisioningKey
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

zpa.ProvisioningKey

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

    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:

    $ pulumi import zpa:index/provisioningKey:ProvisioningKey example <provisioning_key_id>

    or

    $ pulumi import zpa:index/provisioningKey:ProvisioningKey example <provisioning_key_name>

    Create ProvisioningKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProvisioningKey(name: string, args: ProvisioningKeyArgs, opts?: CustomResourceOptions);
    @overload
def ProvisioningKey(resource_name: str,
                    args: ProvisioningKeyArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ProvisioningKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    enrollment_cert_id: Optional[str] = None,
                    zcomponent_id: Optional[str] = None,
                    association_type: Optional[str] = None,
                    max_usage: Optional[str] = None,
                    enabled: Optional[bool] = None,
                    ip_acls: Optional[Sequence[str]] = None,
                    provisioning_key_value: Optional[str] = None,
                    microtenant_id: Optional[str] = None,
                    name: Optional[str] = None,
                    ui_config: Optional[str] = None,
                    usage_count: Optional[str] = None,
                    app_connector_group_id: Optional[str] = None,
                    zcomponent_name: Optional[str] = None)
    func NewProvisioningKey(ctx *Context, name string, args ProvisioningKeyArgs, opts ...ResourceOption) (*ProvisioningKey, error)
    public ProvisioningKey(string name, ProvisioningKeyArgs args, CustomResourceOptions? opts = null)
    public ProvisioningKey(String name, ProvisioningKeyArgs args)
public ProvisioningKey(String name, ProvisioningKeyArgs args, CustomResourceOptions options)

    type: zpa:ProvisioningKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProvisioningKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProvisioningKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProvisioningKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProvisioningKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProvisioningKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var provisioningKeyResource = new Zpa.ProvisioningKey("provisioningKeyResource", new()
{
    EnrollmentCertId = "string",
    ZcomponentId = "string",
    AssociationType = "string",
    MaxUsage = "string",
    Enabled = false,
    IpAcls = new[]
    {
        "string",
    },
    ProvisioningKeyValue = "string",
    MicrotenantId = "string",
    Name = "string",
    UiConfig = "string",
    UsageCount = "string",
    AppConnectorGroupId = "string",
    ZcomponentName = "string",
});

    example, err := zpa.NewProvisioningKey(ctx, "provisioningKeyResource", &zpa.ProvisioningKeyArgs{
	EnrollmentCertId: pulumi.String("string"),
	ZcomponentId:     pulumi.String("string"),
	AssociationType:  pulumi.String("string"),
	MaxUsage:         pulumi.String("string"),
	Enabled:          pulumi.Bool(false),
	IpAcls: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProvisioningKeyValue: pulumi.String("string"),
	MicrotenantId:        pulumi.String("string"),
	Name:                 pulumi.String("string"),
	UiConfig:             pulumi.String("string"),
	UsageCount:           pulumi.String("string"),
	AppConnectorGroupId:  pulumi.String("string"),
	ZcomponentName:       pulumi.String("string"),
})

    var provisioningKeyResource = new ProvisioningKey("provisioningKeyResource", ProvisioningKeyArgs.builder()
    .enrollmentCertId("string")
    .zcomponentId("string")
    .associationType("string")
    .maxUsage("string")
    .enabled(false)
    .ipAcls("string")
    .ProvisioningKeyValue("string")
    .microtenantId("string")
    .name("string")
    .uiConfig("string")
    .usageCount("string")
    .appConnectorGroupId("string")
    .zcomponentName("string")
    .build());

    provisioning_key_resource = zpa.ProvisioningKey("provisioningKeyResource",
    enrollment_cert_id="string",
    zcomponent_id="string",
    association_type="string",
    max_usage="string",
    enabled=False,
    ip_acls=["string"],
    provisioning_key_value="string",
    microtenant_id="string",
    name="string",
    ui_config="string",
    usage_count="string",
    app_connector_group_id="string",
    zcomponent_name="string")

    const provisioningKeyResource = new zpa.ProvisioningKey("provisioningKeyResource", {
    enrollmentCertId: "string",
    zcomponentId: "string",
    associationType: "string",
    maxUsage: "string",
    enabled: false,
    ipAcls: ["string"],
    ProvisioningKeyValue: "string",
    microtenantId: "string",
    name: "string",
    uiConfig: "string",
    usageCount: "string",
    appConnectorGroupId: "string",
    zcomponentName: "string",
});

    type: zpa:ProvisioningKey
properties:
    ProvisioningKeyValue: string
    appConnectorGroupId: string
    associationType: string
    enabled: false
    enrollmentCertId: string
    ipAcls:
        - string
    maxUsage: string
    microtenantId: string
    name: string
    uiConfig: string
    usageCount: string
    zcomponentId: string
    zcomponentName: string

    ProvisioningKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProvisioningKey resource accepts the following input properties:

    AssociationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    MaxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    ZcomponentId string
    ID of the existing App Connector or Service Edge Group.
    AppConnectorGroupId string
    Enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    IpAcls List<string>
    MicrotenantId string
    Name string
    Name of the provisioning key.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    UiConfig string
    UsageCount string
    The provisioning key utilization count.
    ZcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    AssociationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    MaxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    ZcomponentId string
    ID of the existing App Connector or Service Edge Group.
    AppConnectorGroupId string
    Enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    IpAcls []string
    MicrotenantId string
    Name string
    Name of the provisioning key.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    UiConfig string
    UsageCount string
    The provisioning key utilization count.
    ZcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType String
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enrollmentCertId String
    ID of the enrollment certificate that can be used for this provisioning key.
    maxUsage String
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    zcomponentId String
    ID of the existing App Connector or Service Edge Group.
    ProvisioningKeyValue String
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId String
    enabled Boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    ipAcls List<String>
    microtenantId String
    name String
    Name of the provisioning key.
    uiConfig String
    usageCount String
    The provisioning key utilization count.
    zcomponentName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    maxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    zcomponentId string
    ID of the existing App Connector or Service Edge Group.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId string
    enabled boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    ipAcls string[]
    microtenantId string
    name string
    Name of the provisioning key.
    uiConfig string
    usageCount string
    The provisioning key utilization count.
    zcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    association_type str
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enrollment_cert_id str
    ID of the enrollment certificate that can be used for this provisioning key.
    max_usage str
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    zcomponent_id str
    ID of the existing App Connector or Service Edge Group.
    app_connector_group_id str
    enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    ip_acls Sequence[str]
    microtenant_id str
    name str
    Name of the provisioning key.
    provisioning_key_value str
    read only field. Ignored in PUT/POST calls.
    ui_config str
    usage_count str
    The provisioning key utilization count.
    zcomponent_name str
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType String
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enrollmentCertId String
    ID of the enrollment certificate that can be used for this provisioning key.
    maxUsage String
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    zcomponentId String
    ID of the existing App Connector or Service Edge Group.
    ProvisioningKeyValue String
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId String
    enabled Boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    ipAcls List<String>
    microtenantId String
    name String
    Name of the provisioning key.
    uiConfig String
    usageCount String
    The provisioning key utilization count.
    zcomponentName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProvisioningKey resource produces the following output properties:

    AppConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    Id string
    The provider-assigned unique ID for this managed resource.
    AppConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    Id string
    The provider-assigned unique ID for this managed resource.
    appConnectorGroupName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    id String
    The provider-assigned unique ID for this managed resource.
    appConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    id string
    The provider-assigned unique ID for this managed resource.
    app_connector_group_name str
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    id str
    The provider-assigned unique ID for this managed resource.
    appConnectorGroupName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProvisioningKey Resource

    Get an existing ProvisioningKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProvisioningKeyState, opts?: CustomResourceOptions): ProvisioningKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        provisioning_key_value: Optional[str] = None,
        app_connector_group_id: Optional[str] = None,
        app_connector_group_name: Optional[str] = None,
        association_type: Optional[str] = None,
        enabled: Optional[bool] = None,
        enrollment_cert_id: Optional[str] = None,
        ip_acls: Optional[Sequence[str]] = None,
        max_usage: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        ui_config: Optional[str] = None,
        usage_count: Optional[str] = None,
        zcomponent_id: Optional[str] = None,
        zcomponent_name: Optional[str] = None) -> ProvisioningKey
    func GetProvisioningKey(ctx *Context, name string, id IDInput, state *ProvisioningKeyState, opts ...ResourceOption) (*ProvisioningKey, error)
    public static ProvisioningKey Get(string name, Input<string> id, ProvisioningKeyState? state, CustomResourceOptions? opts = null)
    public static ProvisioningKey get(String name, Output<String> id, ProvisioningKeyState state, CustomResourceOptions options)
    resources:  _:    type: zpa:ProvisioningKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppConnectorGroupId string
    AppConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    AssociationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    Enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    IpAcls List<string>
    MaxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    MicrotenantId string
    Name string
    Name of the provisioning key.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    UiConfig string
    UsageCount string
    The provisioning key utilization count.
    ZcomponentId string
    ID of the existing App Connector or Service Edge Group.
    ZcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    AppConnectorGroupId string
    AppConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    AssociationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    Enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    IpAcls []string
    MaxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    MicrotenantId string
    Name string
    Name of the provisioning key.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    UiConfig string
    UsageCount string
    The provisioning key utilization count.
    ZcomponentId string
    ID of the existing App Connector or Service Edge Group.
    ZcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    ProvisioningKeyValue String
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId String
    appConnectorGroupName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType String
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enabled Boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    enrollmentCertId String
    ID of the enrollment certificate that can be used for this provisioning key.
    ipAcls List<String>
    maxUsage String
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    microtenantId String
    name String
    Name of the provisioning key.
    uiConfig String
    usageCount String
    The provisioning key utilization count.
    zcomponentId String
    ID of the existing App Connector or Service Edge Group.
    zcomponentName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    ProvisioningKeyValue string
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId string
    appConnectorGroupName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType string
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enabled boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    enrollmentCertId string
    ID of the enrollment certificate that can be used for this provisioning key.
    ipAcls string[]
    maxUsage string
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    microtenantId string
    name string
    Name of the provisioning key.
    uiConfig string
    usageCount string
    The provisioning key utilization count.
    zcomponentId string
    ID of the existing App Connector or Service Edge Group.
    zcomponentName string
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    app_connector_group_id str
    app_connector_group_name str
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    association_type str
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enabled bool
    Whether the provisioning key is enabled or not. Supported values: true, false
    enrollment_cert_id str
    ID of the enrollment certificate that can be used for this provisioning key.
    ip_acls Sequence[str]
    max_usage str
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    microtenant_id str
    name str
    Name of the provisioning key.
    provisioning_key_value str
    read only field. Ignored in PUT/POST calls.
    ui_config str
    usage_count str
    The provisioning key utilization count.
    zcomponent_id str
    ID of the existing App Connector or Service Edge Group.
    zcomponent_name str
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    ProvisioningKeyValue String
    read only field. Ignored in PUT/POST calls.
    appConnectorGroupId String
    appConnectorGroupName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
    associationType String
    Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.
    enabled Boolean
    Whether the provisioning key is enabled or not. Supported values: true, false
    enrollmentCertId String
    ID of the enrollment certificate that can be used for this provisioning key.
    ipAcls List<String>
    maxUsage String
    The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
    microtenantId String
    name String
    Name of the provisioning key.
    uiConfig String
    usageCount String
    The provisioning key utilization count.
    zcomponentId String
    ID of the existing App Connector or Service Edge Group.
    zcomponentName String
    Read only property. Applicable only for GET calls, ignored in PUT/POST calls.

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zpa