azure-native.web.WebAppSourceControl
Explore with Pulumi AI
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, 2024-04-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={
        "code_configuration": {
            "runtime_stack": "string",
            "runtime_version": "string",
        },
        "container_configuration": {
            "image_name": "string",
            "password": "string",
            "server_url": "string",
            "username": "string",
        },
        "generate_workflow_file": False,
        "is_linux": 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WebAppSourceControl resource accepts the following input properties:
- Name string
- Name of the app.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- Branch string
- Name of branch to use for deployment.
- DeploymentRollback boolEnabled 
- true to enable deployment rollback; otherwise, false.
- GitHub Pulumi.Action Configuration Azure Native. Web. Inputs. Git Hub Action Configuration 
- If GitHub Action is selected, than the associated configuration.
- IsGit boolHub Action 
- true if this is deployed via GitHub action.
- IsManual boolIntegration 
- 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.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- Branch string
- Name of branch to use for deployment.
- DeploymentRollback boolEnabled 
- true to enable deployment rollback; otherwise, false.
- GitHub GitAction Configuration Hub Action Configuration Args 
- If GitHub Action is selected, than the associated configuration.
- IsGit boolHub Action 
- true if this is deployed via GitHub action.
- IsManual boolIntegration 
- 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.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- branch String
- Name of branch to use for deployment.
- deploymentRollback BooleanEnabled 
- true to enable deployment rollback; otherwise, false.
- gitHub GitAction Configuration Hub Action Configuration 
- If GitHub Action is selected, than the associated configuration.
- isGit BooleanHub Action 
- true if this is deployed via GitHub action.
- isManual BooleanIntegration 
- 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.
- resourceGroup stringName 
- Name of the resource group to which the resource belongs.
- branch string
- Name of branch to use for deployment.
- deploymentRollback booleanEnabled 
- true to enable deployment rollback; otherwise, false.
- gitHub GitAction Configuration Hub Action Configuration 
- If GitHub Action is selected, than the associated configuration.
- isGit booleanHub Action 
- true if this is deployed via GitHub action.
- isManual booleanIntegration 
- 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_ strname 
- Name of the resource group to which the resource belongs.
- branch str
- Name of branch to use for deployment.
- deployment_rollback_ boolenabled 
- true to enable deployment rollback; otherwise, false.
- git_hub_ Gitaction_ configuration Hub Action Configuration Args 
- If GitHub Action is selected, than the associated configuration.
- is_git_ boolhub_ action 
- true if this is deployed via GitHub action.
- is_manual_ boolintegration 
- 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.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- branch String
- Name of branch to use for deployment.
- deploymentRollback BooleanEnabled 
- true to enable deployment rollback; otherwise, false.
- gitHub Property MapAction Configuration 
- If GitHub Action is selected, than the associated configuration.
- isGit BooleanHub Action 
- true if this is deployed via GitHub action.
- isManual BooleanIntegration 
- 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:
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.Azure Native. Web. Inputs. Git Hub Action Code Configuration 
- GitHub Action code configuration.
- ContainerConfiguration Pulumi.Azure Native. Web. Inputs. Git Hub Action Container Configuration 
- GitHub Action container configuration.
- GenerateWorkflow boolFile 
- 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 GitHub Action Code Configuration 
- GitHub Action code configuration.
- ContainerConfiguration GitHub Action Container Configuration 
- GitHub Action container configuration.
- GenerateWorkflow boolFile 
- 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 GitHub Action Code Configuration 
- GitHub Action code configuration.
- containerConfiguration GitHub Action Container Configuration 
- GitHub Action container configuration.
- generateWorkflow BooleanFile 
- 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 GitHub Action Code Configuration 
- GitHub Action code configuration.
- containerConfiguration GitHub Action Container Configuration 
- GitHub Action container configuration.
- generateWorkflow booleanFile 
- 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 GitHub Action Code Configuration 
- GitHub Action code configuration.
- container_configuration GitHub Action Container Configuration 
- GitHub Action container configuration.
- generate_workflow_ boolfile 
- 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.
- generateWorkflow BooleanFile 
- 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.Azure Native. Web. Inputs. Git Hub Action Code Configuration Response 
- GitHub Action code configuration.
- ContainerConfiguration Pulumi.Azure Native. Web. Inputs. Git Hub Action Container Configuration Response 
- GitHub Action container configuration.
- GenerateWorkflow boolFile 
- 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 GitHub Action Code Configuration Response 
- GitHub Action code configuration.
- ContainerConfiguration GitHub Action Container Configuration Response 
- GitHub Action container configuration.
- GenerateWorkflow boolFile 
- 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 GitHub Action Code Configuration Response 
- GitHub Action code configuration.
- containerConfiguration GitHub Action Container Configuration Response 
- GitHub Action container configuration.
- generateWorkflow BooleanFile 
- 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 GitHub Action Code Configuration Response 
- GitHub Action code configuration.
- containerConfiguration GitHub Action Container Configuration Response 
- GitHub Action container configuration.
- generateWorkflow booleanFile 
- 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 GitHub Action Code Configuration Response 
- GitHub Action code configuration.
- container_configuration GitHub Action Container Configuration Response 
- GitHub Action container configuration.
- generate_workflow_ boolfile 
- 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.
- generateWorkflow BooleanFile 
- 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          
- 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.
GitHubActionContainerConfigurationResponse, GitHubActionContainerConfigurationResponseArgs            
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0