Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getRepoRuleBranch
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.getRepoRuleBranch

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

    Data source for retrieving a Harness repo branch rule.

    Using getRepoRuleBranch

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRepoRuleBranch(args: GetRepoRuleBranchArgs, opts?: InvokeOptions): Promise<GetRepoRuleBranchResult>
function getRepoRuleBranchOutput(args: GetRepoRuleBranchOutputArgs, opts?: InvokeOptions): Output<GetRepoRuleBranchResult>
    def get_repo_rule_branch(bypasses: Optional[Sequence[GetRepoRuleBranchBypass]] = None,
                         description: Optional[str] = None,
                         identifier: Optional[str] = None,
                         org_id: Optional[str] = None,
                         patterns: Optional[Sequence[GetRepoRuleBranchPattern]] = None,
                         policies: Optional[Sequence[GetRepoRuleBranchPolicy]] = None,
                         project_id: Optional[str] = None,
                         repo_identifier: Optional[str] = None,
                         state: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRepoRuleBranchResult
def get_repo_rule_branch_output(bypasses: Optional[pulumi.Input[Sequence[pulumi.Input[GetRepoRuleBranchBypassArgs]]]] = None,
                         description: Optional[pulumi.Input[str]] = None,
                         identifier: Optional[pulumi.Input[str]] = None,
                         org_id: Optional[pulumi.Input[str]] = None,
                         patterns: Optional[pulumi.Input[Sequence[pulumi.Input[GetRepoRuleBranchPatternArgs]]]] = None,
                         policies: Optional[pulumi.Input[Sequence[pulumi.Input[GetRepoRuleBranchPolicyArgs]]]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         repo_identifier: Optional[pulumi.Input[str]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRepoRuleBranchResult]
    func LookupRepoRuleBranch(ctx *Context, args *LookupRepoRuleBranchArgs, opts ...InvokeOption) (*LookupRepoRuleBranchResult, error)
func LookupRepoRuleBranchOutput(ctx *Context, args *LookupRepoRuleBranchOutputArgs, opts ...InvokeOption) LookupRepoRuleBranchResultOutput

    > Note: This function is named LookupRepoRuleBranch in the Go SDK.

    public static class GetRepoRuleBranch 
{
    public static Task<GetRepoRuleBranchResult> InvokeAsync(GetRepoRuleBranchArgs args, InvokeOptions? opts = null)
    public static Output<GetRepoRuleBranchResult> Invoke(GetRepoRuleBranchInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRepoRuleBranchResult> getRepoRuleBranch(GetRepoRuleBranchArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: harness:platform/getRepoRuleBranch:getRepoRuleBranch
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Bypasses List<GetRepoRuleBranchBypass>
    List of users who can bypass this rule.
    Identifier string
    Identifier of the rule.
    Policies List<GetRepoRuleBranchPolicy>
    Policies to be applied for this rule.
    RepoIdentifier string
    Repo identifier of the repository.
    State string
    State of the rule (active, disable, monitor).
    Description string
    Description of the rule.
    OrgId string
    Unique identifier of the organization.
    Patterns List<GetRepoRuleBranchPattern>
    Pattern of branch to which rule will apply.
    ProjectId string
    Unique identifier of the project.
    Bypasses []GetRepoRuleBranchBypass
    List of users who can bypass this rule.
    Identifier string
    Identifier of the rule.
    Policies []GetRepoRuleBranchPolicy
    Policies to be applied for this rule.
    RepoIdentifier string
    Repo identifier of the repository.
    State string
    State of the rule (active, disable, monitor).
    Description string
    Description of the rule.
    OrgId string
    Unique identifier of the organization.
    Patterns []GetRepoRuleBranchPattern
    Pattern of branch to which rule will apply.
    ProjectId string
    Unique identifier of the project.
    bypasses List<GetRepoRuleBranchBypass>
    List of users who can bypass this rule.
    identifier String
    Identifier of the rule.
    policies List<GetRepoRuleBranchPolicy>
    Policies to be applied for this rule.
    repoIdentifier String
    Repo identifier of the repository.
    state String
    State of the rule (active, disable, monitor).
    description String
    Description of the rule.
    orgId String
    Unique identifier of the organization.
    patterns List<GetRepoRuleBranchPattern>
    Pattern of branch to which rule will apply.
    projectId String
    Unique identifier of the project.
    bypasses GetRepoRuleBranchBypass[]
    List of users who can bypass this rule.
    identifier string
    Identifier of the rule.
    policies GetRepoRuleBranchPolicy[]
    Policies to be applied for this rule.
    repoIdentifier string
    Repo identifier of the repository.
    state string
    State of the rule (active, disable, monitor).
    description string
    Description of the rule.
    orgId string
    Unique identifier of the organization.
    patterns GetRepoRuleBranchPattern[]
    Pattern of branch to which rule will apply.
    projectId string
    Unique identifier of the project.
    bypasses Sequence[GetRepoRuleBranchBypass]
    List of users who can bypass this rule.
    identifier str
    Identifier of the rule.
    policies Sequence[GetRepoRuleBranchPolicy]
    Policies to be applied for this rule.
    repo_identifier str
    Repo identifier of the repository.
    state str
    State of the rule (active, disable, monitor).
    description str
    Description of the rule.
    org_id str
    Unique identifier of the organization.
    patterns Sequence[GetRepoRuleBranchPattern]
    Pattern of branch to which rule will apply.
    project_id str
    Unique identifier of the project.
    bypasses List<Property Map>
    List of users who can bypass this rule.
    identifier String
    Identifier of the rule.
    policies List<Property Map>
    Policies to be applied for this rule.
    repoIdentifier String
    Repo identifier of the repository.
    state String
    State of the rule (active, disable, monitor).
    description String
    Description of the rule.
    orgId String
    Unique identifier of the organization.
    patterns List<Property Map>
    Pattern of branch to which rule will apply.
    projectId String
    Unique identifier of the project.

    getRepoRuleBranch Result

    The following output properties are available:

    Bypasses List<GetRepoRuleBranchBypass>
    List of users who can bypass this rule.
    Created int
    Timestamp when the rule was created.
    CreatedBy int
    ID of the user who created the rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identifier of the rule.
    Policies List<GetRepoRuleBranchPolicy>
    Policies to be applied for this rule.
    RepoIdentifier string
    Repo identifier of the repository.
    State string
    State of the rule (active, disable, monitor).
    Updated int
    Timestamp when the rule was updated.
    UpdatedBy int
    ID of the user who updated the rule.
    Description string
    Description of the rule.
    OrgId string
    Unique identifier of the organization.
    Patterns List<GetRepoRuleBranchPattern>
    Pattern of branch to which rule will apply.
    ProjectId string
    Unique identifier of the project.
    Bypasses []GetRepoRuleBranchBypass
    List of users who can bypass this rule.
    Created int
    Timestamp when the rule was created.
    CreatedBy int
    ID of the user who created the rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identifier of the rule.
    Policies []GetRepoRuleBranchPolicy
    Policies to be applied for this rule.
    RepoIdentifier string
    Repo identifier of the repository.
    State string
    State of the rule (active, disable, monitor).
    Updated int
    Timestamp when the rule was updated.
    UpdatedBy int
    ID of the user who updated the rule.
    Description string
    Description of the rule.
    OrgId string
    Unique identifier of the organization.
    Patterns []GetRepoRuleBranchPattern
    Pattern of branch to which rule will apply.
    ProjectId string
    Unique identifier of the project.
    bypasses List<GetRepoRuleBranchBypass>
    List of users who can bypass this rule.
    created Integer
    Timestamp when the rule was created.
    createdBy Integer
    ID of the user who created the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identifier of the rule.
    policies List<GetRepoRuleBranchPolicy>
    Policies to be applied for this rule.
    repoIdentifier String
    Repo identifier of the repository.
    state String
    State of the rule (active, disable, monitor).
    updated Integer
    Timestamp when the rule was updated.
    updatedBy Integer
    ID of the user who updated the rule.
    description String
    Description of the rule.
    orgId String
    Unique identifier of the organization.
    patterns List<GetRepoRuleBranchPattern>
    Pattern of branch to which rule will apply.
    projectId String
    Unique identifier of the project.
    bypasses GetRepoRuleBranchBypass[]
    List of users who can bypass this rule.
    created number
    Timestamp when the rule was created.
    createdBy number
    ID of the user who created the rule.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Identifier of the rule.
    policies GetRepoRuleBranchPolicy[]
    Policies to be applied for this rule.
    repoIdentifier string
    Repo identifier of the repository.
    state string
    State of the rule (active, disable, monitor).
    updated number
    Timestamp when the rule was updated.
    updatedBy number
    ID of the user who updated the rule.
    description string
    Description of the rule.
    orgId string
    Unique identifier of the organization.
    patterns GetRepoRuleBranchPattern[]
    Pattern of branch to which rule will apply.
    projectId string
    Unique identifier of the project.
    bypasses Sequence[GetRepoRuleBranchBypass]
    List of users who can bypass this rule.
    created int
    Timestamp when the rule was created.
    created_by int
    ID of the user who created the rule.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Identifier of the rule.
    policies Sequence[GetRepoRuleBranchPolicy]
    Policies to be applied for this rule.
    repo_identifier str
    Repo identifier of the repository.
    state str
    State of the rule (active, disable, monitor).
    updated int
    Timestamp when the rule was updated.
    updated_by int
    ID of the user who updated the rule.
    description str
    Description of the rule.
    org_id str
    Unique identifier of the organization.
    patterns Sequence[GetRepoRuleBranchPattern]
    Pattern of branch to which rule will apply.
    project_id str
    Unique identifier of the project.
    bypasses List<Property Map>
    List of users who can bypass this rule.
    created Number
    Timestamp when the rule was created.
    createdBy Number
    ID of the user who created the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identifier of the rule.
    policies List<Property Map>
    Policies to be applied for this rule.
    repoIdentifier String
    Repo identifier of the repository.
    state String
    State of the rule (active, disable, monitor).
    updated Number
    Timestamp when the rule was updated.
    updatedBy Number
    ID of the user who updated the rule.
    description String
    Description of the rule.
    orgId String
    Unique identifier of the organization.
    patterns List<Property Map>
    Pattern of branch to which rule will apply.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetRepoRuleBranchBypass

    RepoOwners bool
    Allow users with repository edit permission to bypass.
    UserIds List<string>
    List of user ids with who can bypass.
    RepoOwners bool
    Allow users with repository edit permission to bypass.
    UserIds []string
    List of user ids with who can bypass.
    repoOwners Boolean
    Allow users with repository edit permission to bypass.
    userIds List<String>
    List of user ids with who can bypass.
    repoOwners boolean
    Allow users with repository edit permission to bypass.
    userIds string[]
    List of user ids with who can bypass.
    repo_owners bool
    Allow users with repository edit permission to bypass.
    user_ids Sequence[str]
    List of user ids with who can bypass.
    repoOwners Boolean
    Allow users with repository edit permission to bypass.
    userIds List<String>
    List of user ids with who can bypass.

    GetRepoRuleBranchPattern

    DefaultBranch bool
    Should rule apply to default branch of the repository.
    Excludes List<string>
    Globstar branch patterns on which rules will NOT be applied.
    Includes List<string>
    Globstar branch patterns on which rules will be applied.
    DefaultBranch bool
    Should rule apply to default branch of the repository.
    Excludes []string
    Globstar branch patterns on which rules will NOT be applied.
    Includes []string
    Globstar branch patterns on which rules will be applied.
    defaultBranch Boolean
    Should rule apply to default branch of the repository.
    excludes List<String>
    Globstar branch patterns on which rules will NOT be applied.
    includes List<String>
    Globstar branch patterns on which rules will be applied.
    defaultBranch boolean
    Should rule apply to default branch of the repository.
    excludes string[]
    Globstar branch patterns on which rules will NOT be applied.
    includes string[]
    Globstar branch patterns on which rules will be applied.
    default_branch bool
    Should rule apply to default branch of the repository.
    excludes Sequence[str]
    Globstar branch patterns on which rules will NOT be applied.
    includes Sequence[str]
    Globstar branch patterns on which rules will be applied.
    defaultBranch Boolean
    Should rule apply to default branch of the repository.
    excludes List<String>
    Globstar branch patterns on which rules will NOT be applied.
    includes List<String>
    Globstar branch patterns on which rules will be applied.

    GetRepoRuleBranchPolicy

    AllowMergeStrategies List<string>
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    BlockBranchCreation bool
    Only allow users with bypass permission to create matching branches.
    BlockBranchDeletion bool
    Only allow users with bypass permission to delete matching branches.
    DeleteBranchOnMerge bool
    Automatically delete the source branch of a pull request after it is merged.
    RequireCodeOwners bool
    Require approval on pull requests from one reviewer for each codeowner rule.
    RequireLatestCommitApproval bool
    Require re-approval when there are new changes in the pull request.
    RequireMinimumApprovalCount int
    Require approval on pull requests from a minimum number of reviewers.
    RequireNoChangeRequest bool
    Require all request for changes have been resolved.
    RequirePullRequest bool
    Do not allow any changes to matching branches without a pull request.
    RequireResolveAllComments bool
    All comments on a pull request must be resolved before it can be merged.
    RequireStatusChecks List<string>
    Selected status checks must pass before a pull request can be merged.
    AllowMergeStrategies []string
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    BlockBranchCreation bool
    Only allow users with bypass permission to create matching branches.
    BlockBranchDeletion bool
    Only allow users with bypass permission to delete matching branches.
    DeleteBranchOnMerge bool
    Automatically delete the source branch of a pull request after it is merged.
    RequireCodeOwners bool
    Require approval on pull requests from one reviewer for each codeowner rule.
    RequireLatestCommitApproval bool
    Require re-approval when there are new changes in the pull request.
    RequireMinimumApprovalCount int
    Require approval on pull requests from a minimum number of reviewers.
    RequireNoChangeRequest bool
    Require all request for changes have been resolved.
    RequirePullRequest bool
    Do not allow any changes to matching branches without a pull request.
    RequireResolveAllComments bool
    All comments on a pull request must be resolved before it can be merged.
    RequireStatusChecks []string
    Selected status checks must pass before a pull request can be merged.
    allowMergeStrategies List<String>
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    blockBranchCreation Boolean
    Only allow users with bypass permission to create matching branches.
    blockBranchDeletion Boolean
    Only allow users with bypass permission to delete matching branches.
    deleteBranchOnMerge Boolean
    Automatically delete the source branch of a pull request after it is merged.
    requireCodeOwners Boolean
    Require approval on pull requests from one reviewer for each codeowner rule.
    requireLatestCommitApproval Boolean
    Require re-approval when there are new changes in the pull request.
    requireMinimumApprovalCount Integer
    Require approval on pull requests from a minimum number of reviewers.
    requireNoChangeRequest Boolean
    Require all request for changes have been resolved.
    requirePullRequest Boolean
    Do not allow any changes to matching branches without a pull request.
    requireResolveAllComments Boolean
    All comments on a pull request must be resolved before it can be merged.
    requireStatusChecks List<String>
    Selected status checks must pass before a pull request can be merged.
    allowMergeStrategies string[]
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    blockBranchCreation boolean
    Only allow users with bypass permission to create matching branches.
    blockBranchDeletion boolean
    Only allow users with bypass permission to delete matching branches.
    deleteBranchOnMerge boolean
    Automatically delete the source branch of a pull request after it is merged.
    requireCodeOwners boolean
    Require approval on pull requests from one reviewer for each codeowner rule.
    requireLatestCommitApproval boolean
    Require re-approval when there are new changes in the pull request.
    requireMinimumApprovalCount number
    Require approval on pull requests from a minimum number of reviewers.
    requireNoChangeRequest boolean
    Require all request for changes have been resolved.
    requirePullRequest boolean
    Do not allow any changes to matching branches without a pull request.
    requireResolveAllComments boolean
    All comments on a pull request must be resolved before it can be merged.
    requireStatusChecks string[]
    Selected status checks must pass before a pull request can be merged.
    allow_merge_strategies Sequence[str]
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    block_branch_creation bool
    Only allow users with bypass permission to create matching branches.
    block_branch_deletion bool
    Only allow users with bypass permission to delete matching branches.
    delete_branch_on_merge bool
    Automatically delete the source branch of a pull request after it is merged.
    require_code_owners bool
    Require approval on pull requests from one reviewer for each codeowner rule.
    require_latest_commit_approval bool
    Require re-approval when there are new changes in the pull request.
    require_minimum_approval_count int
    Require approval on pull requests from a minimum number of reviewers.
    require_no_change_request bool
    Require all request for changes have been resolved.
    require_pull_request bool
    Do not allow any changes to matching branches without a pull request.
    require_resolve_all_comments bool
    All comments on a pull request must be resolved before it can be merged.
    require_status_checks Sequence[str]
    Selected status checks must pass before a pull request can be merged.
    allowMergeStrategies List<String>
    Limit which merge strategies are available to merge a pull request(Any of squash, rebase, merge).
    blockBranchCreation Boolean
    Only allow users with bypass permission to create matching branches.
    blockBranchDeletion Boolean
    Only allow users with bypass permission to delete matching branches.
    deleteBranchOnMerge Boolean
    Automatically delete the source branch of a pull request after it is merged.
    requireCodeOwners Boolean
    Require approval on pull requests from one reviewer for each codeowner rule.
    requireLatestCommitApproval Boolean
    Require re-approval when there are new changes in the pull request.
    requireMinimumApprovalCount Number
    Require approval on pull requests from a minimum number of reviewers.
    requireNoChangeRequest Boolean
    Require all request for changes have been resolved.
    requirePullRequest Boolean
    Do not allow any changes to matching branches without a pull request.
    requireResolveAllComments Boolean
    All comments on a pull request must be resolved before it can be merged.
    requireStatusChecks List<String>
    Selected status checks must pass before a pull request can be merged.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-harness