Skip to content

Latest commit

 

History

History
1418 lines (890 loc) · 62.3 KB

integrationMicrosoftTeams.csharp.md

File metadata and controls

1418 lines (890 loc) · 62.3 KB

integrationMicrosoftTeams Submodule

Constructs

IntegrationMicrosoftTeams

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams gitlab_integration_microsoft_teams}.

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new IntegrationMicrosoftTeams(Construct Scope, string Id, IntegrationMicrosoftTeamsConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config IntegrationMicrosoftTeamsConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetBranchesToBeNotified No description.
ResetConfidentialIssuesEvents No description.
ResetConfidentialNoteEvents No description.
ResetId No description.
ResetIssuesEvents No description.
ResetMergeRequestsEvents No description.
ResetNoteEvents No description.
ResetNotifyOnlyBrokenPipelines No description.
ResetPipelineEvents No description.
ResetPushEvents No description.
ResetTagPushEvents No description.
ResetWikiPageEvents No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


ResetBranchesToBeNotified
private void ResetBranchesToBeNotified()
ResetConfidentialIssuesEvents
private void ResetConfidentialIssuesEvents()
ResetConfidentialNoteEvents
private void ResetConfidentialNoteEvents()
ResetId
private void ResetId()
ResetIssuesEvents
private void ResetIssuesEvents()
ResetMergeRequestsEvents
private void ResetMergeRequestsEvents()
ResetNoteEvents
private void ResetNoteEvents()
ResetNotifyOnlyBrokenPipelines
private void ResetNotifyOnlyBrokenPipelines()
ResetPipelineEvents
private void ResetPipelineEvents()
ResetPushEvents
private void ResetPushEvents()
ResetTagPushEvents
private void ResetTagPushEvents()
ResetWikiPageEvents
private void ResetWikiPageEvents()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a IntegrationMicrosoftTeams resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Gitlab;

IntegrationMicrosoftTeams.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Gitlab;

IntegrationMicrosoftTeams.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Gitlab;

IntegrationMicrosoftTeams.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Gitlab;

IntegrationMicrosoftTeams.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a IntegrationMicrosoftTeams resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the IntegrationMicrosoftTeams to import.


ImportFromIdRequired
  • Type: string

The id of the existing IntegrationMicrosoftTeams that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the IntegrationMicrosoftTeams to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Active HashiCorp.Cdktf.IResolvable No description.
CreatedAt string No description.
UpdatedAt string No description.
BranchesToBeNotifiedInput string No description.
ConfidentialIssuesEventsInput object No description.
ConfidentialNoteEventsInput object No description.
IdInput string No description.
IssuesEventsInput object No description.
MergeRequestsEventsInput object No description.
NoteEventsInput object No description.
NotifyOnlyBrokenPipelinesInput object No description.
PipelineEventsInput object No description.
ProjectInput string No description.
PushEventsInput object No description.
TagPushEventsInput object No description.
WebhookInput string No description.
WikiPageEventsInput object No description.
BranchesToBeNotified string No description.
ConfidentialIssuesEvents object No description.
ConfidentialNoteEvents object No description.
Id string No description.
IssuesEvents object No description.
MergeRequestsEvents object No description.
NoteEvents object No description.
NotifyOnlyBrokenPipelines object No description.
PipelineEvents object No description.
Project string No description.
PushEvents object No description.
TagPushEvents object No description.
Webhook string No description.
WikiPageEvents object No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ActiveRequired
public IResolvable Active { get; }
  • Type: HashiCorp.Cdktf.IResolvable

CreatedAtRequired
public string CreatedAt { get; }
  • Type: string

UpdatedAtRequired
public string UpdatedAt { get; }
  • Type: string

BranchesToBeNotifiedInputOptional
public string BranchesToBeNotifiedInput { get; }
  • Type: string

ConfidentialIssuesEventsInputOptional
public object ConfidentialIssuesEventsInput { get; }
  • Type: object

ConfidentialNoteEventsInputOptional
public object ConfidentialNoteEventsInput { get; }
  • Type: object

IdInputOptional
public string IdInput { get; }
  • Type: string

IssuesEventsInputOptional
public object IssuesEventsInput { get; }
  • Type: object

MergeRequestsEventsInputOptional
public object MergeRequestsEventsInput { get; }
  • Type: object

NoteEventsInputOptional
public object NoteEventsInput { get; }
  • Type: object

NotifyOnlyBrokenPipelinesInputOptional
public object NotifyOnlyBrokenPipelinesInput { get; }
  • Type: object

PipelineEventsInputOptional
public object PipelineEventsInput { get; }
  • Type: object

ProjectInputOptional
public string ProjectInput { get; }
  • Type: string

PushEventsInputOptional
public object PushEventsInput { get; }
  • Type: object

TagPushEventsInputOptional
public object TagPushEventsInput { get; }
  • Type: object

WebhookInputOptional
public string WebhookInput { get; }
  • Type: string

WikiPageEventsInputOptional
public object WikiPageEventsInput { get; }
  • Type: object

BranchesToBeNotifiedRequired
public string BranchesToBeNotified { get; }
  • Type: string

ConfidentialIssuesEventsRequired
public object ConfidentialIssuesEvents { get; }
  • Type: object

ConfidentialNoteEventsRequired
public object ConfidentialNoteEvents { get; }
  • Type: object

IdRequired
public string Id { get; }
  • Type: string

IssuesEventsRequired
public object IssuesEvents { get; }
  • Type: object

MergeRequestsEventsRequired
public object MergeRequestsEvents { get; }
  • Type: object

NoteEventsRequired
public object NoteEvents { get; }
  • Type: object

NotifyOnlyBrokenPipelinesRequired
public object NotifyOnlyBrokenPipelines { get; }
  • Type: object

PipelineEventsRequired
public object PipelineEvents { get; }
  • Type: object

ProjectRequired
public string Project { get; }
  • Type: string

PushEventsRequired
public object PushEvents { get; }
  • Type: object

TagPushEventsRequired
public object TagPushEvents { get; }
  • Type: object

WebhookRequired
public string Webhook { get; }
  • Type: string

WikiPageEventsRequired
public object WikiPageEvents { get; }
  • Type: object

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

IntegrationMicrosoftTeamsConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new IntegrationMicrosoftTeamsConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Project,
    string Webhook,
    string BranchesToBeNotified = null,
    object ConfidentialIssuesEvents = null,
    object ConfidentialNoteEvents = null,
    string Id = null,
    object IssuesEvents = null,
    object MergeRequestsEvents = null,
    object NoteEvents = null,
    object NotifyOnlyBrokenPipelines = null,
    object PipelineEvents = null,
    object PushEvents = null,
    object TagPushEvents = null,
    object WikiPageEvents = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Project string ID of the project you want to activate integration on.
Webhook string The Microsoft Teams webhook (Example, https://outlook.office.com/webhook/...). This value cannot be imported.
BranchesToBeNotified string Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “default_and_protected”. The default value is “default”.
ConfidentialIssuesEvents object Enable notifications for confidential issue events.
ConfidentialNoteEvents object Enable notifications for confidential note events.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#id IntegrationMicrosoftTeams#id}.
IssuesEvents object Enable notifications for issue events.
MergeRequestsEvents object Enable notifications for merge request events.
NoteEvents object Enable notifications for note events.
NotifyOnlyBrokenPipelines object Send notifications for broken pipelines.
PipelineEvents object Enable notifications for pipeline events.
PushEvents object Enable notifications for push events.
TagPushEvents object Enable notifications for tag push events.
WikiPageEvents object Enable notifications for wiki page events.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

ProjectRequired
public string Project { get; set; }
  • Type: string

ID of the project you want to activate integration on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#project IntegrationMicrosoftTeams#project}


WebhookRequired
public string Webhook { get; set; }
  • Type: string

The Microsoft Teams webhook (Example, https://outlook.office.com/webhook/...). This value cannot be imported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#webhook IntegrationMicrosoftTeams#webhook}


BranchesToBeNotifiedOptional
public string BranchesToBeNotified { get; set; }
  • Type: string

Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “default_and_protected”. The default value is “default”.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#branches_to_be_notified IntegrationMicrosoftTeams#branches_to_be_notified}


ConfidentialIssuesEventsOptional
public object ConfidentialIssuesEvents { get; set; }
  • Type: object

Enable notifications for confidential issue events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#confidential_issues_events IntegrationMicrosoftTeams#confidential_issues_events}


ConfidentialNoteEventsOptional
public object ConfidentialNoteEvents { get; set; }
  • Type: object

Enable notifications for confidential note events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#confidential_note_events IntegrationMicrosoftTeams#confidential_note_events}


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#id IntegrationMicrosoftTeams#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


IssuesEventsOptional
public object IssuesEvents { get; set; }
  • Type: object

Enable notifications for issue events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#issues_events IntegrationMicrosoftTeams#issues_events}


MergeRequestsEventsOptional
public object MergeRequestsEvents { get; set; }
  • Type: object

Enable notifications for merge request events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#merge_requests_events IntegrationMicrosoftTeams#merge_requests_events}


NoteEventsOptional
public object NoteEvents { get; set; }
  • Type: object

Enable notifications for note events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#note_events IntegrationMicrosoftTeams#note_events}


NotifyOnlyBrokenPipelinesOptional
public object NotifyOnlyBrokenPipelines { get; set; }
  • Type: object

Send notifications for broken pipelines.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#notify_only_broken_pipelines IntegrationMicrosoftTeams#notify_only_broken_pipelines}


PipelineEventsOptional
public object PipelineEvents { get; set; }
  • Type: object

Enable notifications for pipeline events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#pipeline_events IntegrationMicrosoftTeams#pipeline_events}


PushEventsOptional
public object PushEvents { get; set; }
  • Type: object

Enable notifications for push events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#push_events IntegrationMicrosoftTeams#push_events}


TagPushEventsOptional
public object TagPushEvents { get; set; }
  • Type: object

Enable notifications for tag push events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#tag_push_events IntegrationMicrosoftTeams#tag_push_events}


WikiPageEventsOptional
public object WikiPageEvents { get; set; }
  • Type: object

Enable notifications for wiki page events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/integration_microsoft_teams#wiki_page_events IntegrationMicrosoftTeams#wiki_page_events}