azure-native.securitydevops.GitHubConnector
Explore with Pulumi AI
Represents an ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors. API Version: 2022-09-01-preview.
Example Usage
GitHubConnector_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var gitHubConnector = new AzureNative.SecurityDevOps.GitHubConnector("gitHubConnector", new()
    {
        GitHubConnectorName = "testconnector",
        Location = "West US",
        Properties = new AzureNative.SecurityDevOps.Inputs.GitHubConnectorPropertiesArgs
        {
            Code = "00000000000000000000",
        },
        ResourceGroupName = "westusrg",
    });
});
package main
import (
	securitydevops "github.com/pulumi/pulumi-azure-native-sdk/securitydevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securitydevops.NewGitHubConnector(ctx, "gitHubConnector", &securitydevops.GitHubConnectorArgs{
			GitHubConnectorName: pulumi.String("testconnector"),
			Location:            pulumi.String("West US"),
			Properties: &securitydevops.GitHubConnectorPropertiesArgs{
				Code: pulumi.String("00000000000000000000"),
			},
			ResourceGroupName: pulumi.String("westusrg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securitydevops.GitHubConnector;
import com.pulumi.azurenative.securitydevops.GitHubConnectorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var gitHubConnector = new GitHubConnector("gitHubConnector", GitHubConnectorArgs.builder()        
            .gitHubConnectorName("testconnector")
            .location("West US")
            .properties(Map.of("code", "00000000000000000000"))
            .resourceGroupName("westusrg")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const gitHubConnector = new azure_native.securitydevops.GitHubConnector("gitHubConnector", {
    gitHubConnectorName: "testconnector",
    location: "West US",
    properties: {
        code: "00000000000000000000",
    },
    resourceGroupName: "westusrg",
});
import pulumi
import pulumi_azure_native as azure_native
git_hub_connector = azure_native.securitydevops.GitHubConnector("gitHubConnector",
    git_hub_connector_name="testconnector",
    location="West US",
    properties=azure_native.securitydevops.GitHubConnectorPropertiesArgs(
        code="00000000000000000000",
    ),
    resource_group_name="westusrg")
resources:
  gitHubConnector:
    type: azure-native:securitydevops:GitHubConnector
    properties:
      gitHubConnectorName: testconnector
      location: West US
      properties:
        code: '00000000000000000000'
      resourceGroupName: westusrg
Create GitHubConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GitHubConnector(name: string, args: GitHubConnectorArgs, opts?: CustomResourceOptions);@overload
def GitHubConnector(resource_name: str,
                    args: GitHubConnectorArgs,
                    opts: Optional[ResourceOptions] = None)
@overload
def GitHubConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    git_hub_connector_name: Optional[str] = None,
                    location: Optional[str] = None,
                    properties: Optional[GitHubConnectorPropertiesArgs] = None,
                    tags: Optional[Mapping[str, str]] = None)func NewGitHubConnector(ctx *Context, name string, args GitHubConnectorArgs, opts ...ResourceOption) (*GitHubConnector, error)public GitHubConnector(string name, GitHubConnectorArgs args, CustomResourceOptions? opts = null)
public GitHubConnector(String name, GitHubConnectorArgs args)
public GitHubConnector(String name, GitHubConnectorArgs args, CustomResourceOptions options)
type: azure-native:securitydevops:GitHubConnector
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 GitHubConnectorArgs
- 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 GitHubConnectorArgs
- 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 GitHubConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GitHubConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GitHubConnectorArgs
- 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 gitHubConnectorResource = new AzureNative.Securitydevops.GitHubConnector("gitHubConnectorResource", new()
{
    ResourceGroupName = "string",
    GitHubConnectorName = "string",
    Location = "string",
    Properties = 
    {
        { "code", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
example, err := securitydevops.NewGitHubConnector(ctx, "gitHubConnectorResource", &securitydevops.GitHubConnectorArgs{
	ResourceGroupName:   "string",
	GitHubConnectorName: "string",
	Location:            "string",
	Properties: map[string]interface{}{
		"code": "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})
var gitHubConnectorResource = new GitHubConnector("gitHubConnectorResource", GitHubConnectorArgs.builder()
    .resourceGroupName("string")
    .gitHubConnectorName("string")
    .location("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
git_hub_connector_resource = azure_native.securitydevops.GitHubConnector("gitHubConnectorResource",
    resource_group_name=string,
    git_hub_connector_name=string,
    location=string,
    properties={
        code: string,
    },
    tags={
        string: string,
    })
const gitHubConnectorResource = new azure_native.securitydevops.GitHubConnector("gitHubConnectorResource", {
    resourceGroupName: "string",
    gitHubConnectorName: "string",
    location: "string",
    properties: {
        code: "string",
    },
    tags: {
        string: "string",
    },
});
type: azure-native:securitydevops:GitHubConnector
properties:
    gitHubConnectorName: string
    location: string
    properties:
        code: string
    resourceGroupName: string
    tags:
        string: string
GitHubConnector 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 GitHubConnector resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- GitHub stringConnector Name 
- Name of the GitHub Connector.
- Location string
- The geo-location where the resource lives
- Properties
Pulumi.Azure Native. Security Dev Ops. Inputs. Git Hub Connector Properties 
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- Dictionary<string, string>
- Resource tags.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- GitHub stringConnector Name 
- Name of the GitHub Connector.
- Location string
- The geo-location where the resource lives
- Properties
GitHub Connector Properties Args 
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- map[string]string
- Resource tags.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- gitHub StringConnector Name 
- Name of the GitHub Connector.
- location String
- The geo-location where the resource lives
- properties
GitHub Connector Properties 
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- Map<String,String>
- Resource tags.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- gitHub stringConnector Name 
- Name of the GitHub Connector.
- location string
- The geo-location where the resource lives
- properties
GitHub Connector Properties 
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- {[key: string]: string}
- Resource tags.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- git_hub_ strconnector_ name 
- Name of the GitHub Connector.
- location str
- The geo-location where the resource lives
- properties
GitHub Connector Properties Args 
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- Mapping[str, str]
- Resource tags.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- gitHub StringConnector Name 
- Name of the GitHub Connector.
- location String
- The geo-location where the resource lives
- properties Property Map
- Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the GitHubConnector resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData Pulumi.Azure Native. Security Dev Ops. Outputs. System Data Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
GitHubConnectorProperties, GitHubConnectorPropertiesArgs        
- Code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- Code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- code String
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- code str
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- code String
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
GitHubConnectorPropertiesResponse, GitHubConnectorPropertiesResponseArgs          
- ProvisioningState string
- Code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- ProvisioningState string
- Code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- provisioningState String
- code String
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- provisioningState string
- code string
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- provisioning_state str
- code str
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
- provisioningState String
- code String
- Gets or sets one-time OAuth code to exchange for refresh and access tokens. - Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret. 
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:securitydevops:GitHubConnector testconnector /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/westusrg/providers/Microsoft.SecurityDevOps/gitHubConnectors/testconnector 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0