Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/16568 PowerShell, Microsoft 365, Loops, Logs & SSH first pass #104

Merged
merged 7 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 44 additions & 17 deletions content/en/docs/2024.3/Reference/data-types/logs/eventseverity.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,65 @@ description: "Used to represent the severity of an event when it is logged."

<p class="namespace">(Cortex.DataTypes.Logs.EventSeverity)</p>

{{< workinprogress >}}
{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}}
cortex-lp marked this conversation as resolved.
Show resolved Hide resolved

## Summary

## Values
The `EventSeverity` data type is used to represent the severity of an event when it is logged.

`EventSeverity` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value.

| | |
|-|-|
| **Category:** | Logs |
| **Name:** | `EventSeverity` |
| **Full Name:** | `Cortex.DataTypes.Logs.EventSeverity` |
| **Alias:** | N/A |
| **Description:** | Used to represent the severity of an event when it is logged. |
| **Default Value:** | `(EventSeverity)0` |
| **Can be used as:** | `EventSeverity`, `Object`, `dynamic` |
| **Can be cast to:** | `Int16` (e.g. `(Int16)EventSeverity.Verbose` or `(System.Int16)EventSeverity.Verbose` or `(short)EventSeverity.Verbose`) |
| | `Int32` (e.g. `(Int32)EventSeverity.Verbose` or `(System.Int32)EventSeverity.Verbose` or `(int)EventSeverity.Verbose`) |
| | `Int64` (e.g. `(Int64)EventSeverity.Verbose` or `(System.Int64)EventSeverity.Verbose` or `(long)EventSeverity.Verbose`) |
| | `Single` (e.g. `(Single)EventSeverity.Verbose` or `(System.Single)EventSeverity.Verbose` or `(float)EventSeverity.Verbose`) |
| | `Double` (e.g. `(Double)EventSeverity.Verbose` or `(System.Double)EventSeverity.Verbose` or `(double)EventSeverity.Verbose`) |

### Verbose
## Remarks

### Debug
### Property Editor Support

### Information
- The Expression Editor is available for [Input][] properties where the data type is `EventSeverity`.
- The Literal Editor is available for [Input][] properties where the data type is `EventSeverity`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `EventSeverity`.

### Warning
### Known Limitations

### Error
None

### Fatal
## See Also

## Remarks
### Related Data Types

### Create an EventSeverity
- [Int32][]
- [String][]

### Convert EventSeverity to Text
### Related Concepts

### Property Editor Support
- [Explicit Casting][]
- [Working with Enums][]

### Known Limitations
### External Documentation

## See Also
- [System.Enum][]

### Related Data Types
[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}

### Related Concepts
[Working with Enums]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Enums.MainDoc" >}}
[Explicit Casting]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Objects.ObjectCasting.ExplicitCast" >}}

### External Documentation
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}}

[System.Enum]: {{< url path="MSDocs.DotNet.Api.System.Enum.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,70 @@ description: "Used to represent an error code explaining the reason an `Infinite

<p class="namespace">(Cortex.DataTypes.Loops.InfiniteLoopErrorCode)</p>

{{< workinprogress >}}
{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}}

## Summary

## Values

### IncrementIsZero

### IncrementIsNegative

### IncrementIsPositive
The `InfiniteLoopErrorCode` data type is used to represent an error code explaining the reason an [InfiniteLoopException][] occurred. For more information on the exception itself, see [InfiniteLoopException][].

`InfiniteLoopErrorCode` is an [enum][Working with Enums] data type, which means it has a defined set of values, where each value has an associated [String][] name and [Int32][] value.

| | |
|-|-|
| **Category:** | Loops |
| **Name:** | `InfiniteLoopErrorCode` |
| **Full Name:** | `Cortex.DataTypes.Loops.InfiniteLoopErrorCode` |
| **Alias:** | N/A |
| **Description:** | Error code explaining the reason an [InfiniteLoopException][] occurred. |
| **Default Value:** | `(InfiniteLoopErrorCode)0` |
| **Can be used as:** | `InfiniteLoopErrorCode`, `Object`, `dynamic` |
| **Can be cast to:** | `Int16` (e.g. `(Int16)InfiniteLoopErrorCode.IncrementIsZero` or `(System.Int16)InfiniteLoopErrorCode.IncrementIsZero` or `(short)InfiniteLoopErrorCode.IncrementIsZero`) |
| | `Int32` (e.g. `(Int32)InfiniteLoopErrorCode.IncrementIsZero` or `(System.Int32)InfiniteLoopErrorCode.IncrementIsZero` or `(int)InfiniteLoopErrorCode.IncrementIsZero`) |
| | `Int64` (e.g. `(Int64)InfiniteLoopErrorCode.IncrementIsZero` or `(System.Int64)InfiniteLoopErrorCode.IncrementIsZero` or `(long)InfiniteLoopErrorCode.IncrementIsZero`) |
| | `Single` (e.g. `(Single)InfiniteLoopErrorCode.IncrementIsZero` or `(System.Single)InfiniteLoopErrorCode.IncrementIsZero` or `(float)InfiniteLoopErrorCode.IncrementIsZero`) |
| | `Double` (e.g. `(Double)InfiniteLoopErrorCode.IncrementIsZero` or `(System.Double)InfiniteLoopErrorCode.IncrementIsZero` or `(double)InfiniteLoopErrorCode.IncrementIsZero`) |

## Remarks

### Create an InfiniteLoopErrorCode

### Convert InfiniteLoopErrorCode to Text

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `InfiniteLoopErrorCode`.
- The Literal Editor is available for [Input][] properties where the data type is `InfiniteLoopErrorCode`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `InfiniteLoopErrorCode`.

### Known Limitations

None

## See Also

### Related Data Types

- [Int32][]
- [String][]
- [InfiniteLoopException][]

### Related Concepts

- [Explicit Casting][]
- [Working with Enums][]
- [Working with Loops][]

### External Documentation

- [System.Enum][]

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}

[System.Enum]: {{< url path="MSDocs.DotNet.Api.System.Enum.MainDoc" >}}

[Working with Enums]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Enums.MainDoc" >}}
[Working with Loops]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Loops.MainDoc" >}}
[Explicit Casting]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Objects.ObjectCasting.ExplicitCast" >}}

[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
[Int32]: {{< url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc" >}}

[InfiniteLoopException]: {{< url path = "Cortex.Reference.Exceptions.Loops.InfiniteLoopException.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -1,12 +1,63 @@
---
title: "Microsoft365Credentials"
linkTitle: "Microsoft365Credentials"
description: "Used to represent details required to authenticate with Microsoft 365."
description: "Any data type used to represent details required when establishing a connection with a mail server hosted by Outlook."
weight: 1
---

# {{% param title %}}

<p class="namespace">(Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365Credentials)</p>

{{< workinprogress >}}
{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}}

## Summary

Any data type used to represent details required when establishing a connection with a mail server hosted by Outlook.

| | |
|-|-|
| **Category:** | Microsoft365 |
| **Name:** | `Microsoft365Credentials` |
| **Full Name:** | `Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365Credentials` |
| **Alias:** | N/A |
| **Description:** | Any data type used to represent details required when establishing a connection with a mail server hosted by Outlook. |
| **Default Value:** | null |
| **Can be used as:** | `Microsoft365Credentials`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |

## Remarks

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `Microsoft365Credentials`.
- The Literal Editor is available for [Input][] properties where the data type is `Microsoft365Credentials`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Microsoft365Credentials`.

### Known Limitations

None

## See Also

### Related Data Types

- [Microsoft365OAuthCertificateCredentials][]
- [Microsoft365OAuthCredentials][]

### Related Concepts

- [Working with Email][]

### External Documentation

None

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}

[Microsoft365OAuthCertificateCredentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCertificateCredentials.MainDoc" >}}
[Microsoft365OAuthCredentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCredentials.MainDoc" >}}

[Working with Email]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Email.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
---
title: "Microsoft365OAuthCertificateCredentials"
linkTitle: "Microsoft365OAuthCertificateCredentials"
description: "Used to represent configuration for authentication via OAuth using a certificate when establishing a connection with a mail server hosted by Outlook."
description: "Used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth."
weight: 1
---

# {{% param title %}}

<p class="namespace">(Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCertificateCredentials)</p>

{{< workinprogress >}}
{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}}

## Summary

The `Microsoft365OAuthCertificateCredentials` data type is used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth.
cortex-lp marked this conversation as resolved.
Show resolved Hide resolved

| | |
|-|-|
| **Category:** | Microsoft365 |
| **Name:** | `Microsoft365OAuthCertificateCredentials` |
| **Full Name:** | `Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCertificateCredentials` |
| **Alias:** | N/A |
| **Description:** | Used to represent public key credentials required to authenticate with a server hosted by Outlook via OAuth. |
| **Default Value:** | null |
| **Can be used as:** | `Microsoft365OAuthCertificateCredentials`, `Microsoft365Credentials`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |
cortex-lp marked this conversation as resolved.
Show resolved Hide resolved

## Properties

### ObjectId

### CertificatePath

### CertificatePassword
Expand All @@ -23,4 +38,43 @@ weight: 1

### TenantId

### ObjectId
## Remarks

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `Microsoft365OAuthCertificateCredentials`.
- The Literal Editor is available for [Input][] properties where the data type is `Microsoft365OAuthCertificateCredentials`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Microsoft365OAuthCertificateCredentials`.

### Known Limitations

None

## See Also

### Related Data Types

- [EncryptableText][]
- [EncryptedText][]
- [Microsoft365Credentials][]
- [Microsoft365OAuthCredentials][]

### Related Concepts

- [Working with Email][]

### External Documentation

None
cortex-lp marked this conversation as resolved.
Show resolved Hide resolved

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}

[Working with Email]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Email.MainDoc" >}}

[Microsoft365Credentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365Credentials.MainDoc" >}}
[Microsoft365OAuthCredentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCredentials.MainDoc" >}}

[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}}
[EncryptedText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptedText.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -1,24 +1,78 @@
---
title: "Microsoft365OAuthCredentials"
cortex-lp marked this conversation as resolved.
Show resolved Hide resolved
linkTitle: "Microsoft365OAuthCredentials"
description: "Used to represent configuration for authentication via OAuth when establishing a connection with a mail server hosted by Outlook."
description: "Used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth."
weight: 1
---

# {{% param title %}}

<p class="namespace">(Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCredentials)</p>

{{< workinprogress >}}
{{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}}

## Summary

The `Microsoft365OAuthCredentials` data type is used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth.

| | |
|-|-|
| **Category:** | Microsoft365 |
| **Name:** | `Microsoft365OAuthCredentials` |
| **Full Name:** | `Cortex.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCredentials` |
| **Alias:** | N/A |
| **Description:** | Used to represent client credentials required to authenticate with a server hosted by Outlook via OAuth. |
| **Default Value:** | null |
| **Can be used as:** | `Microsoft365OAuthCredentials`, `Microsoft365Credentials`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |

## Properties

### ObjectId

### ClientId

### ClientSecret

### TenantId

### ObjectId
## Remarks

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `Microsoft365OAuthCredentials`.
- The Literal Editor is available for [Input][] properties where the data type is `Microsoft365OAuthCredentials`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Microsoft365OAuthCredentials`.

### Known Limitations

None

## See Also

### Related Data Types

- [EncryptableText][]
- [EncryptedText][]
- [Microsoft365Credentials][]
- [Microsoft365OAuthCertificateCredentials][]

### Related Concepts

- [Working with Email][]

### External Documentation

None

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}

[Working with Email]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Email.MainDoc" >}}

[Microsoft365Credentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365Credentials.MainDoc" >}}
[Microsoft365OAuthCertificateCredentials]: {{< url path="Cortex.Reference.DataTypes.Microsoft365.Authentication.OAuth.Microsoft365OAuthCertificateCredentials.MainDoc" >}}

[EncryptableText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptableText.MainDoc" >}}
[EncryptedText]: {{< url path="Cortex.Reference.DataTypes.Text.EncryptedText.MainDoc" >}}
Loading
Loading