1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. WebAppSourceControl
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

azure-native.web.WebAppSourceControl

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

    Source control configuration for an app. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:web:WebAppSourceControl myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web 
    

    Create WebAppSourceControl Resource

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

    Constructor syntax

    new WebAppSourceControl(name: string, args: WebAppSourceControlArgs, opts?: CustomResourceOptions);
    @overload
    def WebAppSourceControl(resource_name: str,
                            args: WebAppSourceControlArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebAppSourceControl(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            branch: Optional[str] = None,
                            deployment_rollback_enabled: Optional[bool] = None,
                            git_hub_action_configuration: Optional[GitHubActionConfigurationArgs] = None,
                            is_git_hub_action: Optional[bool] = None,
                            is_manual_integration: Optional[bool] = None,
                            is_mercurial: Optional[bool] = None,
                            kind: Optional[str] = None,
                            repo_url: Optional[str] = None)
    func NewWebAppSourceControl(ctx *Context, name string, args WebAppSourceControlArgs, opts ...ResourceOption) (*WebAppSourceControl, error)
    public WebAppSourceControl(string name, WebAppSourceControlArgs args, CustomResourceOptions? opts = null)
    public WebAppSourceControl(String name, WebAppSourceControlArgs args)
    public WebAppSourceControl(String name, WebAppSourceControlArgs args, CustomResourceOptions options)
    
    type: azure-native:web:WebAppSourceControl
    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 WebAppSourceControlArgs
    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 WebAppSourceControlArgs
    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 WebAppSourceControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppSourceControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppSourceControlArgs
    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 webAppSourceControlResource = new AzureNative.Web.WebAppSourceControl("webAppSourceControlResource", new()
    {
        Name = "string",
        ResourceGroupName = "string",
        Branch = "string",
        DeploymentRollbackEnabled = false,
        GitHubActionConfiguration = new AzureNative.Web.Inputs.GitHubActionConfigurationArgs
        {
            CodeConfiguration = new AzureNative.Web.Inputs.GitHubActionCodeConfigurationArgs
            {
                RuntimeStack = "string",
                RuntimeVersion = "string",
            },
            ContainerConfiguration = new AzureNative.Web.Inputs.GitHubActionContainerConfigurationArgs
            {
                ImageName = "string",
                Password = "string",
                ServerUrl = "string",
                Username = "string",
            },
            GenerateWorkflowFile = false,
            IsLinux = false,
        },
        IsGitHubAction = false,
        IsManualIntegration = false,
        IsMercurial = false,
        Kind = "string",
        RepoUrl = "string",
    });
    
    example, err := web.NewWebAppSourceControl(ctx, "webAppSourceControlResource", &web.WebAppSourceControlArgs{
    	Name:                      pulumi.String("string"),
    	ResourceGroupName:         pulumi.String("string"),
    	Branch:                    pulumi.String("string"),
    	DeploymentRollbackEnabled: pulumi.Bool(false),
    	GitHubActionConfiguration: &web.GitHubActionConfigurationArgs{
    		CodeConfiguration: &web.GitHubActionCodeConfigurationArgs{
    			RuntimeStack:   pulumi.String("string"),
    			RuntimeVersion: pulumi.String("string"),
    		},
    		ContainerConfiguration: &web.GitHubActionContainerConfigurationArgs{
    			ImageName: pulumi.String("string"),
    			Password:  pulumi.String("string"),
    			ServerUrl: pulumi.String("string"),
    			Username:  pulumi.String("string"),
    		},
    		GenerateWorkflowFile: pulumi.Bool(false),
    		IsLinux:              pulumi.Bool(false),
    	},
    	IsGitHubAction:      pulumi.Bool(false),
    	IsManualIntegration: pulumi.Bool(false),
    	IsMercurial:         pulumi.Bool(false),
    	Kind:                pulumi.String("string"),
    	RepoUrl:             pulumi.String("string"),
    })
    
    var webAppSourceControlResource = new WebAppSourceControl("webAppSourceControlResource", WebAppSourceControlArgs.builder()
        .name("string")
        .resourceGroupName("string")
        .branch("string")
        .deploymentRollbackEnabled(false)
        .gitHubActionConfiguration(GitHubActionConfigurationArgs.builder()
            .codeConfiguration(GitHubActionCodeConfigurationArgs.builder()
                .runtimeStack("string")
                .runtimeVersion("string")
                .build())
            .containerConfiguration(GitHubActionContainerConfigurationArgs.builder()
                .imageName("string")
                .password("string")
                .serverUrl("string")
                .username("string")
                .build())
            .generateWorkflowFile(false)
            .isLinux(false)
            .build())
        .isGitHubAction(false)
        .isManualIntegration(false)
        .isMercurial(false)
        .kind("string")
        .repoUrl("string")
        .build());
    
    web_app_source_control_resource = azure_native.web.WebAppSourceControl("webAppSourceControlResource",
        name="string",
        resource_group_name="string",
        branch="string",
        deployment_rollback_enabled=False,
        git_hub_action_configuration={
            "codeConfiguration": {
                "runtimeStack": "string",
                "runtimeVersion": "string",
            },
            "containerConfiguration": {
                "imageName": "string",
                "password": "string",
                "serverUrl": "string",
                "username": "string",
            },
            "generateWorkflowFile": False,
            "isLinux": False,
        },
        is_git_hub_action=False,
        is_manual_integration=False,
        is_mercurial=False,
        kind="string",
        repo_url="string")
    
    const webAppSourceControlResource = new azure_native.web.WebAppSourceControl("webAppSourceControlResource", {
        name: "string",
        resourceGroupName: "string",
        branch: "string",
        deploymentRollbackEnabled: false,
        gitHubActionConfiguration: {
            codeConfiguration: {
                runtimeStack: "string",
                runtimeVersion: "string",
            },
            containerConfiguration: {
                imageName: "string",
                password: "string",
                serverUrl: "string",
                username: "string",
            },
            generateWorkflowFile: false,
            isLinux: false,
        },
        isGitHubAction: false,
        isManualIntegration: false,
        isMercurial: false,
        kind: "string",
        repoUrl: "string",
    });
    
    type: azure-native:web:WebAppSourceControl
    properties:
        branch: string
        deploymentRollbackEnabled: false
        gitHubActionConfiguration:
            codeConfiguration:
                runtimeStack: string
                runtimeVersion: string
            containerConfiguration:
                imageName: string
                password: string
                serverUrl: string
                username: string
            generateWorkflowFile: false
            isLinux: false
        isGitHubAction: false
        isManualIntegration: false
        isMercurial: false
        kind: string
        name: string
        repoUrl: string
        resourceGroupName: string
    

    WebAppSourceControl Resource Properties

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

    Inputs

    The WebAppSourceControl resource accepts the following input properties:

    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Branch string
    Name of branch to use for deployment.
    DeploymentRollbackEnabled bool
    true to enable deployment rollback; otherwise, false.
    GitHubActionConfiguration Pulumi.AzureNative.Web.Inputs.GitHubActionConfiguration
    If GitHub Action is selected, than the associated configuration.
    IsGitHubAction bool
    true if this is deployed via GitHub action.
    IsManualIntegration bool
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    IsMercurial bool
    true for a Mercurial repository; false for a Git repository.
    Kind string
    Kind of resource.
    RepoUrl string
    Repository or source control URL.
    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Branch string
    Name of branch to use for deployment.
    DeploymentRollbackEnabled bool
    true to enable deployment rollback; otherwise, false.
    GitHubActionConfiguration GitHubActionConfigurationArgs
    If GitHub Action is selected, than the associated configuration.
    IsGitHubAction bool
    true if this is deployed via GitHub action.
    IsManualIntegration bool
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    IsMercurial bool
    true for a Mercurial repository; false for a Git repository.
    Kind string
    Kind of resource.
    RepoUrl string
    Repository or source control URL.
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    branch String
    Name of branch to use for deployment.
    deploymentRollbackEnabled Boolean
    true to enable deployment rollback; otherwise, false.
    gitHubActionConfiguration GitHubActionConfiguration
    If GitHub Action is selected, than the associated configuration.
    isGitHubAction Boolean
    true if this is deployed via GitHub action.
    isManualIntegration Boolean
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    isMercurial Boolean
    true for a Mercurial repository; false for a Git repository.
    kind String
    Kind of resource.
    repoUrl String
    Repository or source control URL.
    name string
    Name of the app.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    branch string
    Name of branch to use for deployment.
    deploymentRollbackEnabled boolean
    true to enable deployment rollback; otherwise, false.
    gitHubActionConfiguration GitHubActionConfiguration
    If GitHub Action is selected, than the associated configuration.
    isGitHubAction boolean
    true if this is deployed via GitHub action.
    isManualIntegration boolean
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    isMercurial boolean
    true for a Mercurial repository; false for a Git repository.
    kind string
    Kind of resource.
    repoUrl string
    Repository or source control URL.
    name str
    Name of the app.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    branch str
    Name of branch to use for deployment.
    deployment_rollback_enabled bool
    true to enable deployment rollback; otherwise, false.
    git_hub_action_configuration GitHubActionConfigurationArgs
    If GitHub Action is selected, than the associated configuration.
    is_git_hub_action bool
    true if this is deployed via GitHub action.
    is_manual_integration bool
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    is_mercurial bool
    true for a Mercurial repository; false for a Git repository.
    kind str
    Kind of resource.
    repo_url str
    Repository or source control URL.
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    branch String
    Name of branch to use for deployment.
    deploymentRollbackEnabled Boolean
    true to enable deployment rollback; otherwise, false.
    gitHubActionConfiguration Property Map
    If GitHub Action is selected, than the associated configuration.
    isGitHubAction Boolean
    true if this is deployed via GitHub action.
    isManualIntegration Boolean
    true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
    isMercurial Boolean
    true for a Mercurial repository; false for a Git repository.
    kind String
    Kind of resource.
    repoUrl String
    Repository or source control URL.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.

    Supporting Types

    GitHubActionCodeConfiguration, GitHubActionCodeConfigurationArgs

    RuntimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    RuntimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    RuntimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    RuntimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack String
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion String
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    runtime_stack str
    Runtime stack is used to determine the workflow file content for code base apps.
    runtime_version str
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack String
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion String
    Runtime version is used to determine what build version to set in the workflow file.

    GitHubActionCodeConfigurationResponse, GitHubActionCodeConfigurationResponseArgs

    RuntimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    RuntimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    RuntimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    RuntimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack String
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion String
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack string
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion string
    Runtime version is used to determine what build version to set in the workflow file.
    runtime_stack str
    Runtime stack is used to determine the workflow file content for code base apps.
    runtime_version str
    Runtime version is used to determine what build version to set in the workflow file.
    runtimeStack String
    Runtime stack is used to determine the workflow file content for code base apps.
    runtimeVersion String
    Runtime version is used to determine what build version to set in the workflow file.

    GitHubActionConfiguration, GitHubActionConfigurationArgs

    CodeConfiguration Pulumi.AzureNative.Web.Inputs.GitHubActionCodeConfiguration
    GitHub Action code configuration.
    ContainerConfiguration Pulumi.AzureNative.Web.Inputs.GitHubActionContainerConfiguration
    GitHub Action container configuration.
    GenerateWorkflowFile bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    IsLinux bool
    This will help determine the workflow configuration to select.
    CodeConfiguration GitHubActionCodeConfiguration
    GitHub Action code configuration.
    ContainerConfiguration GitHubActionContainerConfiguration
    GitHub Action container configuration.
    GenerateWorkflowFile bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    IsLinux bool
    This will help determine the workflow configuration to select.
    codeConfiguration GitHubActionCodeConfiguration
    GitHub Action code configuration.
    containerConfiguration GitHubActionContainerConfiguration
    GitHub Action container configuration.
    generateWorkflowFile Boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux Boolean
    This will help determine the workflow configuration to select.
    codeConfiguration GitHubActionCodeConfiguration
    GitHub Action code configuration.
    containerConfiguration GitHubActionContainerConfiguration
    GitHub Action container configuration.
    generateWorkflowFile boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux boolean
    This will help determine the workflow configuration to select.
    code_configuration GitHubActionCodeConfiguration
    GitHub Action code configuration.
    container_configuration GitHubActionContainerConfiguration
    GitHub Action container configuration.
    generate_workflow_file bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    is_linux bool
    This will help determine the workflow configuration to select.
    codeConfiguration Property Map
    GitHub Action code configuration.
    containerConfiguration Property Map
    GitHub Action container configuration.
    generateWorkflowFile Boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux Boolean
    This will help determine the workflow configuration to select.

    GitHubActionConfigurationResponse, GitHubActionConfigurationResponseArgs

    CodeConfiguration Pulumi.AzureNative.Web.Inputs.GitHubActionCodeConfigurationResponse
    GitHub Action code configuration.
    ContainerConfiguration Pulumi.AzureNative.Web.Inputs.GitHubActionContainerConfigurationResponse
    GitHub Action container configuration.
    GenerateWorkflowFile bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    IsLinux bool
    This will help determine the workflow configuration to select.
    CodeConfiguration GitHubActionCodeConfigurationResponse
    GitHub Action code configuration.
    ContainerConfiguration GitHubActionContainerConfigurationResponse
    GitHub Action container configuration.
    GenerateWorkflowFile bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    IsLinux bool
    This will help determine the workflow configuration to select.
    codeConfiguration GitHubActionCodeConfigurationResponse
    GitHub Action code configuration.
    containerConfiguration GitHubActionContainerConfigurationResponse
    GitHub Action container configuration.
    generateWorkflowFile Boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux Boolean
    This will help determine the workflow configuration to select.
    codeConfiguration GitHubActionCodeConfigurationResponse
    GitHub Action code configuration.
    containerConfiguration GitHubActionContainerConfigurationResponse
    GitHub Action container configuration.
    generateWorkflowFile boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux boolean
    This will help determine the workflow configuration to select.
    code_configuration GitHubActionCodeConfigurationResponse
    GitHub Action code configuration.
    container_configuration GitHubActionContainerConfigurationResponse
    GitHub Action container configuration.
    generate_workflow_file bool
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    is_linux bool
    This will help determine the workflow configuration to select.
    codeConfiguration Property Map
    GitHub Action code configuration.
    containerConfiguration Property Map
    GitHub Action container configuration.
    generateWorkflowFile Boolean
    Workflow option to determine whether the workflow file should be generated and written to the repository.
    isLinux Boolean
    This will help determine the workflow configuration to select.

    GitHubActionContainerConfiguration, GitHubActionContainerConfigurationArgs

    ImageName string
    The image name for the build.
    Password string
    The password used to upload the image to the container registry.
    ServerUrl string
    The server URL for the container registry where the build will be hosted.
    Username string
    The username used to upload the image to the container registry.
    ImageName string
    The image name for the build.
    Password string
    The password used to upload the image to the container registry.
    ServerUrl string
    The server URL for the container registry where the build will be hosted.
    Username string
    The username used to upload the image to the container registry.
    imageName String
    The image name for the build.
    password String
    The password used to upload the image to the container registry.
    serverUrl String
    The server URL for the container registry where the build will be hosted.
    username String
    The username used to upload the image to the container registry.
    imageName string
    The image name for the build.
    password string
    The password used to upload the image to the container registry.
    serverUrl string
    The server URL for the container registry where the build will be hosted.
    username string
    The username used to upload the image to the container registry.
    image_name str
    The image name for the build.
    password str
    The password used to upload the image to the container registry.
    server_url str
    The server URL for the container registry where the build will be hosted.
    username str
    The username used to upload the image to the container registry.
    imageName String
    The image name for the build.
    password String
    The password used to upload the image to the container registry.
    serverUrl String
    The server URL for the container registry where the build will be hosted.
    username String
    The username used to upload the image to the container registry.

    GitHubActionContainerConfigurationResponse, GitHubActionContainerConfigurationResponseArgs

    ImageName string
    The image name for the build.
    Password string
    The password used to upload the image to the container registry.
    ServerUrl string
    The server URL for the container registry where the build will be hosted.
    Username string
    The username used to upload the image to the container registry.
    ImageName string
    The image name for the build.
    Password string
    The password used to upload the image to the container registry.
    ServerUrl string
    The server URL for the container registry where the build will be hosted.
    Username string
    The username used to upload the image to the container registry.
    imageName String
    The image name for the build.
    password String
    The password used to upload the image to the container registry.
    serverUrl String
    The server URL for the container registry where the build will be hosted.
    username String
    The username used to upload the image to the container registry.
    imageName string
    The image name for the build.
    password string
    The password used to upload the image to the container registry.
    serverUrl string
    The server URL for the container registry where the build will be hosted.
    username string
    The username used to upload the image to the container registry.
    image_name str
    The image name for the build.
    password str
    The password used to upload the image to the container registry.
    server_url str
    The server URL for the container registry where the build will be hosted.
    username str
    The username used to upload the image to the container registry.
    imageName String
    The image name for the build.
    password String
    The password used to upload the image to the container registry.
    serverUrl String
    The server URL for the container registry where the build will be hosted.
    username String
    The username used to upload the image to the container registry.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi