@pulumi/github/getBranchProtectionRules.d.ts

A Pulumi package for creating and managing github cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Use this data source to retrieve a list of repository branch protection rules.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const example = github.getBranchProtectionRules({
 *     repository: "example",
 * });
 * ```
 */
export declare function getBranchProtectionRules(args: GetBranchProtectionRulesArgs, opts?: pulumi.InvokeOptions): Promise<GetBranchProtectionRulesResult>;
/**
 * A collection of arguments for invoking getBranchProtectionRules.
 */
export interface GetBranchProtectionRulesArgs {
    /**
     * The GitHub repository name.
     */
    repository: string;
}
/**
 * A collection of values returned by getBranchProtectionRules.
 */
export interface GetBranchProtectionRulesResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly repository: string;
    /**
     * Collection of Branch Protection Rules. Each of the results conforms to the following scheme:
     */
    readonly rules: outputs.GetBranchProtectionRulesRule[];
}
/**
 * Use this data source to retrieve a list of repository branch protection rules.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const example = github.getBranchProtectionRules({
 *     repository: "example",
 * });
 * ```
 */
export declare function getBranchProtectionRulesOutput(args: GetBranchProtectionRulesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetBranchProtectionRulesResult>;
/**
 * A collection of arguments for invoking getBranchProtectionRules.
 */
export interface GetBranchProtectionRulesOutputArgs {
    /**
     * The GitHub repository name.
     */
    repository: pulumi.Input<string>;
}