1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementAzureAd
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.ManagementAzureAd

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

    This resource allows you to execute Check Point Azure Ad.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      example:
        type: checkpoint:ManagementAzureAd
        properties:
          applicationId: a8662b33-306f-42ba-9ffb-a0ac27c8903f
          applicationKey: EjdJ2JcNGpw3[GV8:PMN_s2KH]JhtlpO
          directoryId: 19c063a8-3bee-4ea5-b984-e344asds37f7
          password: '123'
          userAuthentication: user-authentication
          username: example
    

    Create ManagementAzureAd Resource

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

    Constructor syntax

    new ManagementAzureAd(name: string, args: ManagementAzureAdArgs, opts?: CustomResourceOptions);
    @overload
    def ManagementAzureAd(resource_name: str,
                          args: ManagementAzureAdArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ManagementAzureAd(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          application_id: Optional[str] = None,
                          application_key: Optional[str] = None,
                          authentication_method: Optional[str] = None,
                          username: Optional[str] = None,
                          password: Optional[str] = None,
                          directory_id: Optional[str] = None,
                          ignore_errors: Optional[bool] = None,
                          ignore_warnings: Optional[bool] = None,
                          management_azure_ad_id: Optional[str] = None,
                          name: Optional[str] = None,
                          comments: Optional[str] = None,
                          tags: Optional[Sequence[str]] = None,
                          color: Optional[str] = None)
    func NewManagementAzureAd(ctx *Context, name string, args ManagementAzureAdArgs, opts ...ResourceOption) (*ManagementAzureAd, error)
    public ManagementAzureAd(string name, ManagementAzureAdArgs args, CustomResourceOptions? opts = null)
    public ManagementAzureAd(String name, ManagementAzureAdArgs args)
    public ManagementAzureAd(String name, ManagementAzureAdArgs args, CustomResourceOptions options)
    
    type: checkpoint:ManagementAzureAd
    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 ManagementAzureAdArgs
    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 ManagementAzureAdArgs
    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 ManagementAzureAdArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementAzureAdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementAzureAdArgs
    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 managementAzureAdResource = new Checkpoint.ManagementAzureAd("managementAzureAdResource", new()
    {
        ApplicationId = "string",
        ApplicationKey = "string",
        AuthenticationMethod = "string",
        Username = "string",
        Password = "string",
        DirectoryId = "string",
        IgnoreErrors = false,
        IgnoreWarnings = false,
        ManagementAzureAdId = "string",
        Name = "string",
        Comments = "string",
        Tags = new[]
        {
            "string",
        },
        Color = "string",
    });
    
    example, err := checkpoint.NewManagementAzureAd(ctx, "managementAzureAdResource", &checkpoint.ManagementAzureAdArgs{
    	ApplicationId:        pulumi.String("string"),
    	ApplicationKey:       pulumi.String("string"),
    	AuthenticationMethod: pulumi.String("string"),
    	Username:             pulumi.String("string"),
    	Password:             pulumi.String("string"),
    	DirectoryId:          pulumi.String("string"),
    	IgnoreErrors:         pulumi.Bool(false),
    	IgnoreWarnings:       pulumi.Bool(false),
    	ManagementAzureAdId:  pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	Comments:             pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Color: pulumi.String("string"),
    })
    
    var managementAzureAdResource = new ManagementAzureAd("managementAzureAdResource", ManagementAzureAdArgs.builder()
        .applicationId("string")
        .applicationKey("string")
        .authenticationMethod("string")
        .username("string")
        .password("string")
        .directoryId("string")
        .ignoreErrors(false)
        .ignoreWarnings(false)
        .managementAzureAdId("string")
        .name("string")
        .comments("string")
        .tags("string")
        .color("string")
        .build());
    
    management_azure_ad_resource = checkpoint.ManagementAzureAd("managementAzureAdResource",
        application_id="string",
        application_key="string",
        authentication_method="string",
        username="string",
        password="string",
        directory_id="string",
        ignore_errors=False,
        ignore_warnings=False,
        management_azure_ad_id="string",
        name="string",
        comments="string",
        tags=["string"],
        color="string")
    
    const managementAzureAdResource = new checkpoint.ManagementAzureAd("managementAzureAdResource", {
        applicationId: "string",
        applicationKey: "string",
        authenticationMethod: "string",
        username: "string",
        password: "string",
        directoryId: "string",
        ignoreErrors: false,
        ignoreWarnings: false,
        managementAzureAdId: "string",
        name: "string",
        comments: "string",
        tags: ["string"],
        color: "string",
    });
    
    type: checkpoint:ManagementAzureAd
    properties:
        applicationId: string
        applicationKey: string
        authenticationMethod: string
        color: string
        comments: string
        directoryId: string
        ignoreErrors: false
        ignoreWarnings: false
        managementAzureAdId: string
        name: string
        password: string
        tags:
            - string
        username: string
    

    ManagementAzureAd 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 ManagementAzureAd resource accepts the following input properties:

    ApplicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    ApplicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    AuthenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    DirectoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    Password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    Username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    IgnoreErrors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    IgnoreWarnings bool
    Apply changes ignoring warnings.
    ManagementAzureAdId string
    Name string
    Object name.
    Tags List<string>
    Collection of tag identifiers.tags blocks are documented below.
    ApplicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    ApplicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    AuthenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    DirectoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    Password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    Username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    IgnoreErrors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    IgnoreWarnings bool
    Apply changes ignoring warnings.
    ManagementAzureAdId string
    Name string
    Object name.
    Tags []string
    Collection of tag identifiers.tags blocks are documented below.
    applicationId String
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey String
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod String
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    directoryId String
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    password String
    Password of the Azure account.Required for authentication-method:user-authentication.
    username String
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    ignoreErrors Boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings Boolean
    Apply changes ignoring warnings.
    managementAzureAdId String
    name String
    Object name.
    tags List<String>
    Collection of tag identifiers.tags blocks are documented below.
    applicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    directoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    ignoreErrors boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings boolean
    Apply changes ignoring warnings.
    managementAzureAdId string
    name string
    Object name.
    tags string[]
    Collection of tag identifiers.tags blocks are documented below.
    application_id str
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    application_key str
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authentication_method str
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    directory_id str
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    password str
    Password of the Azure account.Required for authentication-method:user-authentication.
    username str
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    ignore_errors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignore_warnings bool
    Apply changes ignoring warnings.
    management_azure_ad_id str
    name str
    Object name.
    tags Sequence[str]
    Collection of tag identifiers.tags blocks are documented below.
    applicationId String
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey String
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod String
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    directoryId String
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    password String
    Password of the Azure account.Required for authentication-method:user-authentication.
    username String
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    ignoreErrors Boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings Boolean
    Apply changes ignoring warnings.
    managementAzureAdId String
    name String
    Object name.
    tags List<String>
    Collection of tag identifiers.tags blocks are documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    Id string
    The provider-assigned unique ID for this managed resource.
    TaskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    id string
    The provider-assigned unique ID for this managed resource.
    taskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    id str
    The provider-assigned unique ID for this managed resource.
    task_id str
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    id String
    The provider-assigned unique ID for this managed resource.
    taskId String
    Azure AD Operation task-id, use show-task command to check the progress of the task.

    Look up Existing ManagementAzureAd Resource

    Get an existing ManagementAzureAd 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?: ManagementAzureAdState, opts?: CustomResourceOptions): ManagementAzureAd
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            application_key: Optional[str] = None,
            authentication_method: Optional[str] = None,
            color: Optional[str] = None,
            comments: Optional[str] = None,
            directory_id: Optional[str] = None,
            ignore_errors: Optional[bool] = None,
            ignore_warnings: Optional[bool] = None,
            management_azure_ad_id: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            task_id: Optional[str] = None,
            username: Optional[str] = None) -> ManagementAzureAd
    func GetManagementAzureAd(ctx *Context, name string, id IDInput, state *ManagementAzureAdState, opts ...ResourceOption) (*ManagementAzureAd, error)
    public static ManagementAzureAd Get(string name, Input<string> id, ManagementAzureAdState? state, CustomResourceOptions? opts = null)
    public static ManagementAzureAd get(String name, Output<String> id, ManagementAzureAdState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementAzureAd    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:
    ApplicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    ApplicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    AuthenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    DirectoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    IgnoreErrors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    IgnoreWarnings bool
    Apply changes ignoring warnings.
    ManagementAzureAdId string
    Name string
    Object name.
    Password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    Tags List<string>
    Collection of tag identifiers.tags blocks are documented below.
    TaskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    Username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    ApplicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    ApplicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    AuthenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    Color string
    Color of the object. Should be one of existing colors.
    Comments string
    Comments string.
    DirectoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    IgnoreErrors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    IgnoreWarnings bool
    Apply changes ignoring warnings.
    ManagementAzureAdId string
    Name string
    Object name.
    Password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    Tags []string
    Collection of tag identifiers.tags blocks are documented below.
    TaskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    Username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    applicationId String
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey String
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod String
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    directoryId String
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    ignoreErrors Boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings Boolean
    Apply changes ignoring warnings.
    managementAzureAdId String
    name String
    Object name.
    password String
    Password of the Azure account.Required for authentication-method:user-authentication.
    tags List<String>
    Collection of tag identifiers.tags blocks are documented below.
    taskId String
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    username String
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    applicationId string
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey string
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod string
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    color string
    Color of the object. Should be one of existing colors.
    comments string
    Comments string.
    directoryId string
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    ignoreErrors boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings boolean
    Apply changes ignoring warnings.
    managementAzureAdId string
    name string
    Object name.
    password string
    Password of the Azure account.Required for authentication-method:user-authentication.
    tags string[]
    Collection of tag identifiers.tags blocks are documented below.
    taskId string
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    username string
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    application_id str
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    application_key str
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authentication_method str
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    color str
    Color of the object. Should be one of existing colors.
    comments str
    Comments string.
    directory_id str
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    ignore_errors bool
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignore_warnings bool
    Apply changes ignoring warnings.
    management_azure_ad_id str
    name str
    Object name.
    password str
    Password of the Azure account.Required for authentication-method:user-authentication.
    tags Sequence[str]
    Collection of tag identifiers.tags blocks are documented below.
    task_id str
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    username str
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.
    applicationId String
    The Application ID of the Service Principal, in UUID format.Required for authentication-method:service-principal-authentication.
    applicationKey String
    The key created for the Service Principal.Required for authentication-method:service-principal-authentication.
    authenticationMethod String
    user-authenticationUses the Azure AD User to authenticate.service-principal-authenticationUses the Service Principal to authenticate.
    color String
    Color of the object. Should be one of existing colors.
    comments String
    Comments string.
    directoryId String
    The Directory ID of the Azure AD, in UUID format.Required for authentication-method:service-principal-authentication.
    ignoreErrors Boolean
    Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    ignoreWarnings Boolean
    Apply changes ignoring warnings.
    managementAzureAdId String
    name String
    Object name.
    password String
    Password of the Azure account.Required for authentication-method:user-authentication.
    tags List<String>
    Collection of tag identifiers.tags blocks are documented below.
    taskId String
    Azure AD Operation task-id, use show-task command to check the progress of the task.
    username String
    An Azure Active Directory user Format<username>@<domain>.Required for authentication-method:user-authentication.

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    checkpoint logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw