1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. RestApiPollerDataConnector
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.securityinsights.RestApiPollerDataConnector

Explore with Pulumi AI

Represents Rest Api Poller data connector.

Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Example Usage

Creates or updates a MicrosoftThreatIntelligence data connector.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var restApiPollerDataConnector = new AzureNative.SecurityInsights.RestApiPollerDataConnector("restApiPollerDataConnector", new()
    {
        DataConnectorId = "c345bf40-8509-4ed2-b947-50cb773aaf04",
        ResourceGroupName = "myRg",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

import (
	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewRestApiPollerDataConnector(ctx, "restApiPollerDataConnector", &securityinsights.RestApiPollerDataConnectorArgs{
			DataConnectorId:   pulumi.String("c345bf40-8509-4ed2-b947-50cb773aaf04"),
			ResourceGroupName: pulumi.String("myRg"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnector;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnectorArgs;
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 restApiPollerDataConnector = new RestApiPollerDataConnector("restApiPollerDataConnector", RestApiPollerDataConnectorArgs.builder()
            .dataConnectorId("c345bf40-8509-4ed2-b947-50cb773aaf04")
            .resourceGroupName("myRg")
            .workspaceName("myWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const restApiPollerDataConnector = new azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector", {
    dataConnectorId: "c345bf40-8509-4ed2-b947-50cb773aaf04",
    resourceGroupName: "myRg",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

rest_api_poller_data_connector = azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector",
    data_connector_id="c345bf40-8509-4ed2-b947-50cb773aaf04",
    resource_group_name="myRg",
    workspace_name="myWorkspace")
Copy
resources:
  restApiPollerDataConnector:
    type: azure-native:securityinsights:RestApiPollerDataConnector
    properties:
      dataConnectorId: c345bf40-8509-4ed2-b947-50cb773aaf04
      resourceGroupName: myRg
      workspaceName: myWorkspace
Copy

Creates or updates a PremiumMicrosoftDefenderForThreatIntelligence data connector.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var restApiPollerDataConnector = new AzureNative.SecurityInsights.RestApiPollerDataConnector("restApiPollerDataConnector", new()
    {
        DataConnectorId = "8c569548-a86c-4fb4-8ae4-d1e35a6146f8",
        ResourceGroupName = "myRg",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

import (
	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewRestApiPollerDataConnector(ctx, "restApiPollerDataConnector", &securityinsights.RestApiPollerDataConnectorArgs{
			DataConnectorId:   pulumi.String("8c569548-a86c-4fb4-8ae4-d1e35a6146f8"),
			ResourceGroupName: pulumi.String("myRg"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnector;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnectorArgs;
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 restApiPollerDataConnector = new RestApiPollerDataConnector("restApiPollerDataConnector", RestApiPollerDataConnectorArgs.builder()
            .dataConnectorId("8c569548-a86c-4fb4-8ae4-d1e35a6146f8")
            .resourceGroupName("myRg")
            .workspaceName("myWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const restApiPollerDataConnector = new azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector", {
    dataConnectorId: "8c569548-a86c-4fb4-8ae4-d1e35a6146f8",
    resourceGroupName: "myRg",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

rest_api_poller_data_connector = azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector",
    data_connector_id="8c569548-a86c-4fb4-8ae4-d1e35a6146f8",
    resource_group_name="myRg",
    workspace_name="myWorkspace")
Copy
resources:
  restApiPollerDataConnector:
    type: azure-native:securityinsights:RestApiPollerDataConnector
    properties:
      dataConnectorId: 8c569548-a86c-4fb4-8ae4-d1e35a6146f8
      resourceGroupName: myRg
      workspaceName: myWorkspace
Copy

Creates or updates an Office365 data connector.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var restApiPollerDataConnector = new AzureNative.SecurityInsights.RestApiPollerDataConnector("restApiPollerDataConnector", new()
    {
        DataConnectorId = "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
        ResourceGroupName = "myRg",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

import (
	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewRestApiPollerDataConnector(ctx, "restApiPollerDataConnector", &securityinsights.RestApiPollerDataConnectorArgs{
			DataConnectorId:   pulumi.String("73e01a99-5cd7-4139-a149-9f2736ff2ab5"),
			ResourceGroupName: pulumi.String("myRg"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnector;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnectorArgs;
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 restApiPollerDataConnector = new RestApiPollerDataConnector("restApiPollerDataConnector", RestApiPollerDataConnectorArgs.builder()
            .dataConnectorId("73e01a99-5cd7-4139-a149-9f2736ff2ab5")
            .resourceGroupName("myRg")
            .workspaceName("myWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const restApiPollerDataConnector = new azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector", {
    dataConnectorId: "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
    resourceGroupName: "myRg",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

rest_api_poller_data_connector = azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector",
    data_connector_id="73e01a99-5cd7-4139-a149-9f2736ff2ab5",
    resource_group_name="myRg",
    workspace_name="myWorkspace")
Copy
resources:
  restApiPollerDataConnector:
    type: azure-native:securityinsights:RestApiPollerDataConnector
    properties:
      dataConnectorId: 73e01a99-5cd7-4139-a149-9f2736ff2ab5
      resourceGroupName: myRg
      workspaceName: myWorkspace
Copy

Creates or updates an Threat Intelligence Platform data connector.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var restApiPollerDataConnector = new AzureNative.SecurityInsights.RestApiPollerDataConnector("restApiPollerDataConnector", new()
    {
        DataConnectorId = "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
        ResourceGroupName = "myRg",
        WorkspaceName = "myWorkspace",
    });

});
Copy
package main

import (
	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewRestApiPollerDataConnector(ctx, "restApiPollerDataConnector", &securityinsights.RestApiPollerDataConnectorArgs{
			DataConnectorId:   pulumi.String("73e01a99-5cd7-4139-a149-9f2736ff2ab5"),
			ResourceGroupName: pulumi.String("myRg"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnector;
import com.pulumi.azurenative.securityinsights.RestApiPollerDataConnectorArgs;
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 restApiPollerDataConnector = new RestApiPollerDataConnector("restApiPollerDataConnector", RestApiPollerDataConnectorArgs.builder()
            .dataConnectorId("73e01a99-5cd7-4139-a149-9f2736ff2ab5")
            .resourceGroupName("myRg")
            .workspaceName("myWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const restApiPollerDataConnector = new azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector", {
    dataConnectorId: "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
    resourceGroupName: "myRg",
    workspaceName: "myWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

rest_api_poller_data_connector = azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnector",
    data_connector_id="73e01a99-5cd7-4139-a149-9f2736ff2ab5",
    resource_group_name="myRg",
    workspace_name="myWorkspace")
Copy
resources:
  restApiPollerDataConnector:
    type: azure-native:securityinsights:RestApiPollerDataConnector
    properties:
      dataConnectorId: 73e01a99-5cd7-4139-a149-9f2736ff2ab5
      resourceGroupName: myRg
      workspaceName: myWorkspace
Copy

Create RestApiPollerDataConnector Resource

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

Constructor syntax

new RestApiPollerDataConnector(name: string, args: RestApiPollerDataConnectorArgs, opts?: CustomResourceOptions);
@overload
def RestApiPollerDataConnector(resource_name: str,
                               args: RestApiPollerDataConnectorArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def RestApiPollerDataConnector(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               auth: Optional[Union[AWSAuthModelArgs, ApiKeyAuthModelArgs, BasicAuthModelArgs, GCPAuthModelArgs, GenericBlobSbsAuthModelArgs, GitHubAuthModelArgs, JwtAuthModelArgs, NoneAuthModelArgs, OAuthModelArgs, OracleAuthModelArgs, SessionAuthModelArgs]] = None,
                               connector_definition_name: Optional[str] = None,
                               workspace_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               request: Optional[RestApiPollerRequestConfigArgs] = None,
                               data_connector_id: Optional[str] = None,
                               is_active: Optional[bool] = None,
                               paging: Optional[RestApiPollerRequestPagingConfigArgs] = None,
                               dcr_config: Optional[DCRConfigurationArgs] = None,
                               data_type: Optional[str] = None,
                               response: Optional[CcpResponseConfigArgs] = None,
                               add_on_attributes: Optional[Mapping[str, str]] = None)
func NewRestApiPollerDataConnector(ctx *Context, name string, args RestApiPollerDataConnectorArgs, opts ...ResourceOption) (*RestApiPollerDataConnector, error)
public RestApiPollerDataConnector(string name, RestApiPollerDataConnectorArgs args, CustomResourceOptions? opts = null)
public RestApiPollerDataConnector(String name, RestApiPollerDataConnectorArgs args)
public RestApiPollerDataConnector(String name, RestApiPollerDataConnectorArgs args, CustomResourceOptions options)
type: azure-native:securityinsights:RestApiPollerDataConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RestApiPollerDataConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RestApiPollerDataConnectorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RestApiPollerDataConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RestApiPollerDataConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RestApiPollerDataConnectorArgs
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 restApiPollerDataConnectorResource = new AzureNative.SecurityInsights.RestApiPollerDataConnector("restApiPollerDataConnectorResource", new()
{
    Kind = "string",
    Auth = new AzureNative.SecurityInsights.Inputs.AWSAuthModelArgs
    {
        RoleArn = "string",
        Type = "AWS",
        ExternalId = "string",
    },
    ConnectorDefinitionName = "string",
    WorkspaceName = "string",
    ResourceGroupName = "string",
    Request = new AzureNative.SecurityInsights.Inputs.RestApiPollerRequestConfigArgs
    {
        ApiEndpoint = "string",
        EndTimeAttributeName = "string",
        Headers = 
        {
            { "string", "string" },
        },
        HttpMethod = "string",
        IsPostPayloadJson = false,
        QueryParameters = "any",
        QueryParametersTemplate = "string",
        QueryTimeFormat = "string",
        QueryTimeIntervalAttributeName = "string",
        QueryTimeIntervalDelimiter = "string",
        QueryTimeIntervalPrepend = "string",
        QueryWindowInMin = 0,
        RateLimitQPS = 0,
        RetryCount = 0,
        StartTimeAttributeName = "string",
        TimeoutInSeconds = 0,
    },
    DataConnectorId = "string",
    IsActive = false,
    Paging = new AzureNative.SecurityInsights.Inputs.RestApiPollerRequestPagingConfigArgs
    {
        PagingType = "string",
        PageSize = 0,
        PageSizeParameterName = "string",
    },
    DcrConfig = new AzureNative.SecurityInsights.Inputs.DCRConfigurationArgs
    {
        DataCollectionEndpoint = "string",
        DataCollectionRuleImmutableId = "string",
        StreamName = "string",
    },
    DataType = "string",
    Response = new AzureNative.SecurityInsights.Inputs.CcpResponseConfigArgs
    {
        EventsJsonPaths = new[]
        {
            "string",
        },
        CompressionAlgo = "string",
        ConvertChildPropertiesToArray = false,
        CsvDelimiter = "string",
        CsvEscape = "string",
        Format = "string",
        HasCsvBoundary = false,
        HasCsvHeader = false,
        IsGzipCompressed = false,
        SuccessStatusJsonPath = "string",
        SuccessStatusValue = "string",
    },
    AddOnAttributes = 
    {
        { "string", "string" },
    },
});
Copy
example, err := securityinsights.NewRestApiPollerDataConnector(ctx, "restApiPollerDataConnectorResource", &securityinsights.RestApiPollerDataConnectorArgs{
	Kind: pulumi.String("string"),
	Auth: &securityinsights.AWSAuthModelArgs{
		RoleArn:    pulumi.String("string"),
		Type:       pulumi.String("AWS"),
		ExternalId: pulumi.String("string"),
	},
	ConnectorDefinitionName: pulumi.String("string"),
	WorkspaceName:           pulumi.String("string"),
	ResourceGroupName:       pulumi.String("string"),
	Request: &securityinsights.RestApiPollerRequestConfigArgs{
		ApiEndpoint:          pulumi.String("string"),
		EndTimeAttributeName: pulumi.String("string"),
		Headers: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		HttpMethod:                     pulumi.String("string"),
		IsPostPayloadJson:              pulumi.Bool(false),
		QueryParameters:                pulumi.Any("any"),
		QueryParametersTemplate:        pulumi.String("string"),
		QueryTimeFormat:                pulumi.String("string"),
		QueryTimeIntervalAttributeName: pulumi.String("string"),
		QueryTimeIntervalDelimiter:     pulumi.String("string"),
		QueryTimeIntervalPrepend:       pulumi.String("string"),
		QueryWindowInMin:               pulumi.Int(0),
		RateLimitQPS:                   pulumi.Int(0),
		RetryCount:                     pulumi.Int(0),
		StartTimeAttributeName:         pulumi.String("string"),
		TimeoutInSeconds:               pulumi.Int(0),
	},
	DataConnectorId: pulumi.String("string"),
	IsActive:        pulumi.Bool(false),
	Paging: &securityinsights.RestApiPollerRequestPagingConfigArgs{
		PagingType:            pulumi.String("string"),
		PageSize:              pulumi.Int(0),
		PageSizeParameterName: pulumi.String("string"),
	},
	DcrConfig: &securityinsights.DCRConfigurationArgs{
		DataCollectionEndpoint:        pulumi.String("string"),
		DataCollectionRuleImmutableId: pulumi.String("string"),
		StreamName:                    pulumi.String("string"),
	},
	DataType: pulumi.String("string"),
	Response: &securityinsights.CcpResponseConfigArgs{
		EventsJsonPaths: pulumi.StringArray{
			pulumi.String("string"),
		},
		CompressionAlgo:               pulumi.String("string"),
		ConvertChildPropertiesToArray: pulumi.Bool(false),
		CsvDelimiter:                  pulumi.String("string"),
		CsvEscape:                     pulumi.String("string"),
		Format:                        pulumi.String("string"),
		HasCsvBoundary:                pulumi.Bool(false),
		HasCsvHeader:                  pulumi.Bool(false),
		IsGzipCompressed:              pulumi.Bool(false),
		SuccessStatusJsonPath:         pulumi.String("string"),
		SuccessStatusValue:            pulumi.String("string"),
	},
	AddOnAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var restApiPollerDataConnectorResource = new RestApiPollerDataConnector("restApiPollerDataConnectorResource", RestApiPollerDataConnectorArgs.builder()
    .kind("string")
    .auth(AWSAuthModelArgs.builder()
        .roleArn("string")
        .type("AWS")
        .externalId("string")
        .build())
    .connectorDefinitionName("string")
    .workspaceName("string")
    .resourceGroupName("string")
    .request(RestApiPollerRequestConfigArgs.builder()
        .apiEndpoint("string")
        .endTimeAttributeName("string")
        .headers(Map.of("string", "string"))
        .httpMethod("string")
        .isPostPayloadJson(false)
        .queryParameters("any")
        .queryParametersTemplate("string")
        .queryTimeFormat("string")
        .queryTimeIntervalAttributeName("string")
        .queryTimeIntervalDelimiter("string")
        .queryTimeIntervalPrepend("string")
        .queryWindowInMin(0)
        .rateLimitQPS(0)
        .retryCount(0)
        .startTimeAttributeName("string")
        .timeoutInSeconds(0)
        .build())
    .dataConnectorId("string")
    .isActive(false)
    .paging(RestApiPollerRequestPagingConfigArgs.builder()
        .pagingType("string")
        .pageSize(0)
        .pageSizeParameterName("string")
        .build())
    .dcrConfig(DCRConfigurationArgs.builder()
        .dataCollectionEndpoint("string")
        .dataCollectionRuleImmutableId("string")
        .streamName("string")
        .build())
    .dataType("string")
    .response(CcpResponseConfigArgs.builder()
        .eventsJsonPaths("string")
        .compressionAlgo("string")
        .convertChildPropertiesToArray(false)
        .csvDelimiter("string")
        .csvEscape("string")
        .format("string")
        .hasCsvBoundary(false)
        .hasCsvHeader(false)
        .isGzipCompressed(false)
        .successStatusJsonPath("string")
        .successStatusValue("string")
        .build())
    .addOnAttributes(Map.of("string", "string"))
    .build());
Copy
rest_api_poller_data_connector_resource = azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnectorResource",
    kind="string",
    auth={
        "role_arn": "string",
        "type": "AWS",
        "external_id": "string",
    },
    connector_definition_name="string",
    workspace_name="string",
    resource_group_name="string",
    request={
        "api_endpoint": "string",
        "end_time_attribute_name": "string",
        "headers": {
            "string": "string",
        },
        "http_method": "string",
        "is_post_payload_json": False,
        "query_parameters": "any",
        "query_parameters_template": "string",
        "query_time_format": "string",
        "query_time_interval_attribute_name": "string",
        "query_time_interval_delimiter": "string",
        "query_time_interval_prepend": "string",
        "query_window_in_min": 0,
        "rate_limit_qps": 0,
        "retry_count": 0,
        "start_time_attribute_name": "string",
        "timeout_in_seconds": 0,
    },
    data_connector_id="string",
    is_active=False,
    paging={
        "paging_type": "string",
        "page_size": 0,
        "page_size_parameter_name": "string",
    },
    dcr_config={
        "data_collection_endpoint": "string",
        "data_collection_rule_immutable_id": "string",
        "stream_name": "string",
    },
    data_type="string",
    response={
        "events_json_paths": ["string"],
        "compression_algo": "string",
        "convert_child_properties_to_array": False,
        "csv_delimiter": "string",
        "csv_escape": "string",
        "format": "string",
        "has_csv_boundary": False,
        "has_csv_header": False,
        "is_gzip_compressed": False,
        "success_status_json_path": "string",
        "success_status_value": "string",
    },
    add_on_attributes={
        "string": "string",
    })
Copy
const restApiPollerDataConnectorResource = new azure_native.securityinsights.RestApiPollerDataConnector("restApiPollerDataConnectorResource", {
    kind: "string",
    auth: {
        roleArn: "string",
        type: "AWS",
        externalId: "string",
    },
    connectorDefinitionName: "string",
    workspaceName: "string",
    resourceGroupName: "string",
    request: {
        apiEndpoint: "string",
        endTimeAttributeName: "string",
        headers: {
            string: "string",
        },
        httpMethod: "string",
        isPostPayloadJson: false,
        queryParameters: "any",
        queryParametersTemplate: "string",
        queryTimeFormat: "string",
        queryTimeIntervalAttributeName: "string",
        queryTimeIntervalDelimiter: "string",
        queryTimeIntervalPrepend: "string",
        queryWindowInMin: 0,
        rateLimitQPS: 0,
        retryCount: 0,
        startTimeAttributeName: "string",
        timeoutInSeconds: 0,
    },
    dataConnectorId: "string",
    isActive: false,
    paging: {
        pagingType: "string",
        pageSize: 0,
        pageSizeParameterName: "string",
    },
    dcrConfig: {
        dataCollectionEndpoint: "string",
        dataCollectionRuleImmutableId: "string",
        streamName: "string",
    },
    dataType: "string",
    response: {
        eventsJsonPaths: ["string"],
        compressionAlgo: "string",
        convertChildPropertiesToArray: false,
        csvDelimiter: "string",
        csvEscape: "string",
        format: "string",
        hasCsvBoundary: false,
        hasCsvHeader: false,
        isGzipCompressed: false,
        successStatusJsonPath: "string",
        successStatusValue: "string",
    },
    addOnAttributes: {
        string: "string",
    },
});
Copy
type: azure-native:securityinsights:RestApiPollerDataConnector
properties:
    addOnAttributes:
        string: string
    auth:
        externalId: string
        roleArn: string
        type: AWS
    connectorDefinitionName: string
    dataConnectorId: string
    dataType: string
    dcrConfig:
        dataCollectionEndpoint: string
        dataCollectionRuleImmutableId: string
        streamName: string
    isActive: false
    kind: string
    paging:
        pageSize: 0
        pageSizeParameterName: string
        pagingType: string
    request:
        apiEndpoint: string
        endTimeAttributeName: string
        headers:
            string: string
        httpMethod: string
        isPostPayloadJson: false
        queryParameters: any
        queryParametersTemplate: string
        queryTimeFormat: string
        queryTimeIntervalAttributeName: string
        queryTimeIntervalDelimiter: string
        queryTimeIntervalPrepend: string
        queryWindowInMin: 0
        rateLimitQPS: 0
        retryCount: 0
        startTimeAttributeName: string
        timeoutInSeconds: 0
    resourceGroupName: string
    response:
        compressionAlgo: string
        convertChildPropertiesToArray: false
        csvDelimiter: string
        csvEscape: string
        eventsJsonPaths:
            - string
        format: string
        hasCsvBoundary: false
        hasCsvHeader: false
        isGzipCompressed: false
        successStatusJsonPath: string
        successStatusValue: string
    workspaceName: string
Copy

RestApiPollerDataConnector 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 RestApiPollerDataConnector resource accepts the following input properties:

Auth This property is required. Pulumi.AzureNative.SecurityInsights.Inputs.AWSAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.ApiKeyAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.BasicAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.GCPAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.GenericBlobSbsAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.GitHubAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.JwtAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.NoneAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.OAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.OracleAuthModel | Pulumi.AzureNative.SecurityInsights.Inputs.SessionAuthModel
The a authentication model.
ConnectorDefinitionName This property is required. string
The connector definition name (the dataConnectorDefinition resource id).
Request This property is required. Pulumi.AzureNative.SecurityInsights.Inputs.RestApiPollerRequestConfig
The request configuration.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AddOnAttributes Dictionary<string, string>
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
DataConnectorId Changes to this property will trigger replacement. string
Connector ID
DataType string
The Log Analytics table destination.
DcrConfig Pulumi.AzureNative.SecurityInsights.Inputs.DCRConfiguration
The DCR related properties.
IsActive bool
Indicates whether the connector is active or not.
Paging Pulumi.AzureNative.SecurityInsights.Inputs.RestApiPollerRequestPagingConfig
The paging configuration.
Response Pulumi.AzureNative.SecurityInsights.Inputs.CcpResponseConfig
The response configuration.
Auth This property is required. AWSAuthModelArgs | ApiKeyAuthModelArgs | BasicAuthModelArgs | GCPAuthModelArgs | GenericBlobSbsAuthModelArgs | GitHubAuthModelArgs | JwtAuthModelArgs | NoneAuthModelArgs | OAuthModelArgs | OracleAuthModelArgs | SessionAuthModelArgs
The a authentication model.
ConnectorDefinitionName This property is required. string
The connector definition name (the dataConnectorDefinition resource id).
Request This property is required. RestApiPollerRequestConfigArgs
The request configuration.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AddOnAttributes map[string]string
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
DataConnectorId Changes to this property will trigger replacement. string
Connector ID
DataType string
The Log Analytics table destination.
DcrConfig DCRConfigurationArgs
The DCR related properties.
IsActive bool
Indicates whether the connector is active or not.
Paging RestApiPollerRequestPagingConfigArgs
The paging configuration.
Response CcpResponseConfigArgs
The response configuration.
auth This property is required. AWSAuthModel | ApiKeyAuthModel | BasicAuthModel | GCPAuthModel | GenericBlobSbsAuthModel | GitHubAuthModel | JwtAuthModel | NoneAuthModel | OAuthModel | OracleAuthModel | SessionAuthModel
The a authentication model.
connectorDefinitionName This property is required. String
The connector definition name (the dataConnectorDefinition resource id).
request This property is required. RestApiPollerRequestConfig
The request configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
addOnAttributes Map<String,String>
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
dataConnectorId Changes to this property will trigger replacement. String
Connector ID
dataType String
The Log Analytics table destination.
dcrConfig DCRConfiguration
The DCR related properties.
isActive Boolean
Indicates whether the connector is active or not.
paging RestApiPollerRequestPagingConfig
The paging configuration.
response CcpResponseConfig
The response configuration.
auth This property is required. AWSAuthModel | ApiKeyAuthModel | BasicAuthModel | GCPAuthModel | GenericBlobSbsAuthModel | GitHubAuthModel | JwtAuthModel | NoneAuthModel | OAuthModel | OracleAuthModel | SessionAuthModel
The a authentication model.
connectorDefinitionName This property is required. string
The connector definition name (the dataConnectorDefinition resource id).
request This property is required. RestApiPollerRequestConfig
The request configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
addOnAttributes {[key: string]: string}
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
dataConnectorId Changes to this property will trigger replacement. string
Connector ID
dataType string
The Log Analytics table destination.
dcrConfig DCRConfiguration
The DCR related properties.
isActive boolean
Indicates whether the connector is active or not.
paging RestApiPollerRequestPagingConfig
The paging configuration.
response CcpResponseConfig
The response configuration.
auth This property is required. AWSAuthModelArgs | ApiKeyAuthModelArgs | BasicAuthModelArgs | GCPAuthModelArgs | GenericBlobSbsAuthModelArgs | GitHubAuthModelArgs | JwtAuthModelArgs | NoneAuthModelArgs | OAuthModelArgs | OracleAuthModelArgs | SessionAuthModelArgs
The a authentication model.
connector_definition_name This property is required. str
The connector definition name (the dataConnectorDefinition resource id).
request This property is required. RestApiPollerRequestConfigArgs
The request configuration.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
add_on_attributes Mapping[str, str]
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
data_connector_id Changes to this property will trigger replacement. str
Connector ID
data_type str
The Log Analytics table destination.
dcr_config DCRConfigurationArgs
The DCR related properties.
is_active bool
Indicates whether the connector is active or not.
paging RestApiPollerRequestPagingConfigArgs
The paging configuration.
response CcpResponseConfigArgs
The response configuration.
auth This property is required. Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
The a authentication model.
connectorDefinitionName This property is required. String
The connector definition name (the dataConnectorDefinition resource id).
request This property is required. Property Map
The request configuration.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
addOnAttributes Map<String>
The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.
dataConnectorId Changes to this property will trigger replacement. String
Connector ID
dataType String
The Log Analytics table destination.
dcrConfig Property Map
The DCR related properties.
isActive Boolean
Indicates whether the connector is active or not.
paging Property Map
The paging configuration.
response Property Map
The response configuration.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
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"
Etag string
Etag of the azure resource
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
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"
Etag string
Etag of the azure resource
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
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"
etag String
Etag of the azure resource
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
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"
etag string
Etag of the azure resource
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
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"
etag str
Etag of the azure resource
azureApiVersion String
The Azure API version of the resource.
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"
etag String
Etag of the azure resource

Supporting Types

AWSAuthModel
, AWSAuthModelArgs

RoleArn This property is required. string
AWS STS assume role ARN
ExternalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
RoleArn This property is required. string
AWS STS assume role ARN
ExternalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. String
AWS STS assume role ARN
externalId String
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. string
AWS STS assume role ARN
externalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
role_arn This property is required. str
AWS STS assume role ARN
external_id str
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. String
AWS STS assume role ARN
externalId String
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'

AWSAuthModelResponse
, AWSAuthModelResponseArgs

RoleArn This property is required. string
AWS STS assume role ARN
ExternalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
RoleArn This property is required. string
AWS STS assume role ARN
ExternalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. String
AWS STS assume role ARN
externalId String
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. string
AWS STS assume role ARN
externalId string
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
role_arn This property is required. str
AWS STS assume role ARN
external_id str
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'
roleArn This property is required. String
AWS STS assume role ARN
externalId String
AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'

ApiKeyAuthModel
, ApiKeyAuthModelArgs

ApiKey This property is required. string
API Key for the user secret key credential
ApiKeyName This property is required. string
API Key name
ApiKeyIdentifier string
API Key Identifier
IsApiKeyInPostPayload bool
Flag to indicate if API key is set in HTTP POST payload
ApiKey This property is required. string
API Key for the user secret key credential
ApiKeyName This property is required. string
API Key name
ApiKeyIdentifier string
API Key Identifier
IsApiKeyInPostPayload bool
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. String
API Key for the user secret key credential
apiKeyName This property is required. String
API Key name
apiKeyIdentifier String
API Key Identifier
isApiKeyInPostPayload Boolean
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. string
API Key for the user secret key credential
apiKeyName This property is required. string
API Key name
apiKeyIdentifier string
API Key Identifier
isApiKeyInPostPayload boolean
Flag to indicate if API key is set in HTTP POST payload
api_key This property is required. str
API Key for the user secret key credential
api_key_name This property is required. str
API Key name
api_key_identifier str
API Key Identifier
is_api_key_in_post_payload bool
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. String
API Key for the user secret key credential
apiKeyName This property is required. String
API Key name
apiKeyIdentifier String
API Key Identifier
isApiKeyInPostPayload Boolean
Flag to indicate if API key is set in HTTP POST payload

ApiKeyAuthModelResponse
, ApiKeyAuthModelResponseArgs

ApiKey This property is required. string
API Key for the user secret key credential
ApiKeyName This property is required. string
API Key name
ApiKeyIdentifier string
API Key Identifier
IsApiKeyInPostPayload bool
Flag to indicate if API key is set in HTTP POST payload
ApiKey This property is required. string
API Key for the user secret key credential
ApiKeyName This property is required. string
API Key name
ApiKeyIdentifier string
API Key Identifier
IsApiKeyInPostPayload bool
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. String
API Key for the user secret key credential
apiKeyName This property is required. String
API Key name
apiKeyIdentifier String
API Key Identifier
isApiKeyInPostPayload Boolean
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. string
API Key for the user secret key credential
apiKeyName This property is required. string
API Key name
apiKeyIdentifier string
API Key Identifier
isApiKeyInPostPayload boolean
Flag to indicate if API key is set in HTTP POST payload
api_key This property is required. str
API Key for the user secret key credential
api_key_name This property is required. str
API Key name
api_key_identifier str
API Key Identifier
is_api_key_in_post_payload bool
Flag to indicate if API key is set in HTTP POST payload
apiKey This property is required. String
API Key for the user secret key credential
apiKeyName This property is required. String
API Key name
apiKeyIdentifier String
API Key Identifier
isApiKeyInPostPayload Boolean
Flag to indicate if API key is set in HTTP POST payload

BasicAuthModel
, BasicAuthModelArgs

Password This property is required. string
The password
UserName This property is required. string
The user name.
Password This property is required. string
The password
UserName This property is required. string
The user name.
password This property is required. String
The password
userName This property is required. String
The user name.
password This property is required. string
The password
userName This property is required. string
The user name.
password This property is required. str
The password
user_name This property is required. str
The user name.
password This property is required. String
The password
userName This property is required. String
The user name.

BasicAuthModelResponse
, BasicAuthModelResponseArgs

Password This property is required. string
The password
UserName This property is required. string
The user name.
Password This property is required. string
The password
UserName This property is required. string
The user name.
password This property is required. String
The password
userName This property is required. String
The user name.
password This property is required. string
The password
userName This property is required. string
The user name.
password This property is required. str
The password
user_name This property is required. str
The user name.
password This property is required. String
The password
userName This property is required. String
The user name.

CcpResponseConfig
, CcpResponseConfigArgs

EventsJsonPaths This property is required. List<string>
The json paths, '$' char is the json root.
CompressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
ConvertChildPropertiesToArray bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
CsvDelimiter string
The csv delimiter, in case the response format is CSV.
CsvEscape string
The character used to escape characters in CSV.
Format string
The response format. possible values are json,csv,xml
HasCsvBoundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
HasCsvHeader bool
The value indicating whether the response has headers in case the response in CSV format.
IsGzipCompressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
SuccessStatusJsonPath string
The value where the status message/code should appear in the response.
SuccessStatusValue string
The status value.
EventsJsonPaths This property is required. []string
The json paths, '$' char is the json root.
CompressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
ConvertChildPropertiesToArray bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
CsvDelimiter string
The csv delimiter, in case the response format is CSV.
CsvEscape string
The character used to escape characters in CSV.
Format string
The response format. possible values are json,csv,xml
HasCsvBoundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
HasCsvHeader bool
The value indicating whether the response has headers in case the response in CSV format.
IsGzipCompressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
SuccessStatusJsonPath string
The value where the status message/code should appear in the response.
SuccessStatusValue string
The status value.
eventsJsonPaths This property is required. List<String>
The json paths, '$' char is the json root.
compressionAlgo String
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray Boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter String
The csv delimiter, in case the response format is CSV.
csvEscape String
The character used to escape characters in CSV.
format String
The response format. possible values are json,csv,xml
hasCsvBoundary Boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader Boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed Boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath String
The value where the status message/code should appear in the response.
successStatusValue String
The status value.
eventsJsonPaths This property is required. string[]
The json paths, '$' char is the json root.
compressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter string
The csv delimiter, in case the response format is CSV.
csvEscape string
The character used to escape characters in CSV.
format string
The response format. possible values are json,csv,xml
hasCsvBoundary boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath string
The value where the status message/code should appear in the response.
successStatusValue string
The status value.
events_json_paths This property is required. Sequence[str]
The json paths, '$' char is the json root.
compression_algo str
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convert_child_properties_to_array bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csv_delimiter str
The csv delimiter, in case the response format is CSV.
csv_escape str
The character used to escape characters in CSV.
format str
The response format. possible values are json,csv,xml
has_csv_boundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
has_csv_header bool
The value indicating whether the response has headers in case the response in CSV format.
is_gzip_compressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
success_status_json_path str
The value where the status message/code should appear in the response.
success_status_value str
The status value.
eventsJsonPaths This property is required. List<String>
The json paths, '$' char is the json root.
compressionAlgo String
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray Boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter String
The csv delimiter, in case the response format is CSV.
csvEscape String
The character used to escape characters in CSV.
format String
The response format. possible values are json,csv,xml
hasCsvBoundary Boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader Boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed Boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath String
The value where the status message/code should appear in the response.
successStatusValue String
The status value.

CcpResponseConfigResponse
, CcpResponseConfigResponseArgs

EventsJsonPaths This property is required. List<string>
The json paths, '$' char is the json root.
CompressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
ConvertChildPropertiesToArray bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
CsvDelimiter string
The csv delimiter, in case the response format is CSV.
CsvEscape string
The character used to escape characters in CSV.
Format string
The response format. possible values are json,csv,xml
HasCsvBoundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
HasCsvHeader bool
The value indicating whether the response has headers in case the response in CSV format.
IsGzipCompressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
SuccessStatusJsonPath string
The value where the status message/code should appear in the response.
SuccessStatusValue string
The status value.
EventsJsonPaths This property is required. []string
The json paths, '$' char is the json root.
CompressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
ConvertChildPropertiesToArray bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
CsvDelimiter string
The csv delimiter, in case the response format is CSV.
CsvEscape string
The character used to escape characters in CSV.
Format string
The response format. possible values are json,csv,xml
HasCsvBoundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
HasCsvHeader bool
The value indicating whether the response has headers in case the response in CSV format.
IsGzipCompressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
SuccessStatusJsonPath string
The value where the status message/code should appear in the response.
SuccessStatusValue string
The status value.
eventsJsonPaths This property is required. List<String>
The json paths, '$' char is the json root.
compressionAlgo String
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray Boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter String
The csv delimiter, in case the response format is CSV.
csvEscape String
The character used to escape characters in CSV.
format String
The response format. possible values are json,csv,xml
hasCsvBoundary Boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader Boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed Boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath String
The value where the status message/code should appear in the response.
successStatusValue String
The status value.
eventsJsonPaths This property is required. string[]
The json paths, '$' char is the json root.
compressionAlgo string
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter string
The csv delimiter, in case the response format is CSV.
csvEscape string
The character used to escape characters in CSV.
format string
The response format. possible values are json,csv,xml
hasCsvBoundary boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath string
The value where the status message/code should appear in the response.
successStatusValue string
The status value.
events_json_paths This property is required. Sequence[str]
The json paths, '$' char is the json root.
compression_algo str
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convert_child_properties_to_array bool
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csv_delimiter str
The csv delimiter, in case the response format is CSV.
csv_escape str
The character used to escape characters in CSV.
format str
The response format. possible values are json,csv,xml
has_csv_boundary bool
The value indicating whether the response has CSV boundary in case the response in CSV format.
has_csv_header bool
The value indicating whether the response has headers in case the response in CSV format.
is_gzip_compressed bool
The value indicating whether the remote server support Gzip and we should expect Gzip response.
success_status_json_path str
The value where the status message/code should appear in the response.
success_status_value str
The status value.
eventsJsonPaths This property is required. List<String>
The json paths, '$' char is the json root.
compressionAlgo String
The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray Boolean
The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter String
The csv delimiter, in case the response format is CSV.
csvEscape String
The character used to escape characters in CSV.
format String
The response format. possible values are json,csv,xml
hasCsvBoundary Boolean
The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader Boolean
The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed Boolean
The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath String
The value where the status message/code should appear in the response.
successStatusValue String
The status value.

DCRConfiguration
, DCRConfigurationArgs

DataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
DataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
StreamName This property is required. string
The stream we are sending the data to.
DataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
DataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
StreamName This property is required. string
The stream we are sending the data to.
dataCollectionEndpoint This property is required. String
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. String
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. String
The stream we are sending the data to.
dataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. string
The stream we are sending the data to.
data_collection_endpoint This property is required. str
Represents the data collection ingestion endpoint in log analytics.
data_collection_rule_immutable_id This property is required. str
The data collection rule immutable id, the rule defines the transformation and data destination.
stream_name This property is required. str
The stream we are sending the data to.
dataCollectionEndpoint This property is required. String
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. String
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. String
The stream we are sending the data to.

DCRConfigurationResponse
, DCRConfigurationResponseArgs

DataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
DataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
StreamName This property is required. string
The stream we are sending the data to.
DataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
DataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
StreamName This property is required. string
The stream we are sending the data to.
dataCollectionEndpoint This property is required. String
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. String
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. String
The stream we are sending the data to.
dataCollectionEndpoint This property is required. string
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. string
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. string
The stream we are sending the data to.
data_collection_endpoint This property is required. str
Represents the data collection ingestion endpoint in log analytics.
data_collection_rule_immutable_id This property is required. str
The data collection rule immutable id, the rule defines the transformation and data destination.
stream_name This property is required. str
The stream we are sending the data to.
dataCollectionEndpoint This property is required. String
Represents the data collection ingestion endpoint in log analytics.
dataCollectionRuleImmutableId This property is required. String
The data collection rule immutable id, the rule defines the transformation and data destination.
streamName This property is required. String
The stream we are sending the data to.

GCPAuthModel
, GCPAuthModelArgs

ProjectNumber This property is required. string
GCP Project Number
ServiceAccountEmail This property is required. string
GCP Service Account Email
WorkloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
ProjectNumber This property is required. string
GCP Project Number
ServiceAccountEmail This property is required. string
GCP Service Account Email
WorkloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
projectNumber This property is required. String
GCP Project Number
serviceAccountEmail This property is required. String
GCP Service Account Email
workloadIdentityProviderId This property is required. String
GCP Workload Identity Provider ID
projectNumber This property is required. string
GCP Project Number
serviceAccountEmail This property is required. string
GCP Service Account Email
workloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
project_number This property is required. str
GCP Project Number
service_account_email This property is required. str
GCP Service Account Email
workload_identity_provider_id This property is required. str
GCP Workload Identity Provider ID
projectNumber This property is required. String
GCP Project Number
serviceAccountEmail This property is required. String
GCP Service Account Email
workloadIdentityProviderId This property is required. String
GCP Workload Identity Provider ID

GCPAuthModelResponse
, GCPAuthModelResponseArgs

ProjectNumber This property is required. string
GCP Project Number
ServiceAccountEmail This property is required. string
GCP Service Account Email
WorkloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
ProjectNumber This property is required. string
GCP Project Number
ServiceAccountEmail This property is required. string
GCP Service Account Email
WorkloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
projectNumber This property is required. String
GCP Project Number
serviceAccountEmail This property is required. String
GCP Service Account Email
workloadIdentityProviderId This property is required. String
GCP Workload Identity Provider ID
projectNumber This property is required. string
GCP Project Number
serviceAccountEmail This property is required. string
GCP Service Account Email
workloadIdentityProviderId This property is required. string
GCP Workload Identity Provider ID
project_number This property is required. str
GCP Project Number
service_account_email This property is required. str
GCP Service Account Email
workload_identity_provider_id This property is required. str
GCP Workload Identity Provider ID
projectNumber This property is required. String
GCP Project Number
serviceAccountEmail This property is required. String
GCP Service Account Email
workloadIdentityProviderId This property is required. String
GCP Workload Identity Provider ID

GenericBlobSbsAuthModel
, GenericBlobSbsAuthModelArgs

CredentialsConfig Dictionary<string, string>
Credentials for service bus namespace, keyvault uri for access key
StorageAccountCredentialsConfig Dictionary<string, string>
Credentials for storage account, keyvault uri for access key
CredentialsConfig map[string]string
Credentials for service bus namespace, keyvault uri for access key
StorageAccountCredentialsConfig map[string]string
Credentials for storage account, keyvault uri for access key
credentialsConfig Map<String,String>
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig Map<String,String>
Credentials for storage account, keyvault uri for access key
credentialsConfig {[key: string]: string}
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig {[key: string]: string}
Credentials for storage account, keyvault uri for access key
credentials_config Mapping[str, str]
Credentials for service bus namespace, keyvault uri for access key
storage_account_credentials_config Mapping[str, str]
Credentials for storage account, keyvault uri for access key
credentialsConfig Map<String>
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig Map<String>
Credentials for storage account, keyvault uri for access key

GenericBlobSbsAuthModelResponse
, GenericBlobSbsAuthModelResponseArgs

CredentialsConfig Dictionary<string, string>
Credentials for service bus namespace, keyvault uri for access key
StorageAccountCredentialsConfig Dictionary<string, string>
Credentials for storage account, keyvault uri for access key
CredentialsConfig map[string]string
Credentials for service bus namespace, keyvault uri for access key
StorageAccountCredentialsConfig map[string]string
Credentials for storage account, keyvault uri for access key
credentialsConfig Map<String,String>
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig Map<String,String>
Credentials for storage account, keyvault uri for access key
credentialsConfig {[key: string]: string}
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig {[key: string]: string}
Credentials for storage account, keyvault uri for access key
credentials_config Mapping[str, str]
Credentials for service bus namespace, keyvault uri for access key
storage_account_credentials_config Mapping[str, str]
Credentials for storage account, keyvault uri for access key
credentialsConfig Map<String>
Credentials for service bus namespace, keyvault uri for access key
storageAccountCredentialsConfig Map<String>
Credentials for storage account, keyvault uri for access key

GitHubAuthModel
, GitHubAuthModelArgs

InstallationId string
The GitHubApp auth installation id.
InstallationId string
The GitHubApp auth installation id.
installationId String
The GitHubApp auth installation id.
installationId string
The GitHubApp auth installation id.
installation_id str
The GitHubApp auth installation id.
installationId String
The GitHubApp auth installation id.

GitHubAuthModelResponse
, GitHubAuthModelResponseArgs

InstallationId string
The GitHubApp auth installation id.
InstallationId string
The GitHubApp auth installation id.
installationId String
The GitHubApp auth installation id.
installationId string
The GitHubApp auth installation id.
installation_id str
The GitHubApp auth installation id.
installationId String
The GitHubApp auth installation id.

HttpMethodVerb
, HttpMethodVerbArgs

GET
GET
POST
POST
PUT
PUT
DELETE
DELETE
HttpMethodVerbGET
GET
HttpMethodVerbPOST
POST
HttpMethodVerbPUT
PUT
HttpMethodVerbDELETE
DELETE
GET
GET
POST
POST
PUT
PUT
DELETE
DELETE
GET
GET
POST
POST
PUT
PUT
DELETE
DELETE
GET
GET
POST
POST
PUT
PUT
DELETE
DELETE
"GET"
GET
"POST"
POST
"PUT"
PUT
"DELETE"
DELETE

JwtAuthModel
, JwtAuthModelArgs

Password This property is required. Dictionary<string, string>
The password
TokenEndpoint This property is required. string
Token endpoint to request JWT
UserName This property is required. Dictionary<string, string>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
Headers Dictionary<string, string>
The custom headers we want to add once we send request to token endpoint.
IsCredentialsInHeaders bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
IsJsonRequest bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
QueryParameters Dictionary<string, string>
The custom query parameter we want to add once we send request to token endpoint.
RequestTimeoutInSeconds int
Request timeout in seconds.
Password This property is required. map[string]string
The password
TokenEndpoint This property is required. string
Token endpoint to request JWT
UserName This property is required. map[string]string
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
Headers map[string]string
The custom headers we want to add once we send request to token endpoint.
IsCredentialsInHeaders bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
IsJsonRequest bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
QueryParameters map[string]string
The custom query parameter we want to add once we send request to token endpoint.
RequestTimeoutInSeconds int
Request timeout in seconds.
password This property is required. Map<String,String>
The password
tokenEndpoint This property is required. String
Token endpoint to request JWT
userName This property is required. Map<String,String>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Map<String,String>
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders Boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest Boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters Map<String,String>
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds Integer
Request timeout in seconds.
password This property is required. {[key: string]: string}
The password
tokenEndpoint This property is required. string
Token endpoint to request JWT
userName This property is required. {[key: string]: string}
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers {[key: string]: string}
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters {[key: string]: string}
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds number
Request timeout in seconds.
password This property is required. Mapping[str, str]
The password
token_endpoint This property is required. str
Token endpoint to request JWT
user_name This property is required. Mapping[str, str]
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Mapping[str, str]
The custom headers we want to add once we send request to token endpoint.
is_credentials_in_headers bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
is_json_request bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
query_parameters Mapping[str, str]
The custom query parameter we want to add once we send request to token endpoint.
request_timeout_in_seconds int
Request timeout in seconds.
password This property is required. Map<String>
The password
tokenEndpoint This property is required. String
Token endpoint to request JWT
userName This property is required. Map<String>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Map<String>
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders Boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest Boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters Map<String>
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds Number
Request timeout in seconds.

JwtAuthModelResponse
, JwtAuthModelResponseArgs

Password This property is required. Dictionary<string, string>
The password
TokenEndpoint This property is required. string
Token endpoint to request JWT
UserName This property is required. Dictionary<string, string>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
Headers Dictionary<string, string>
The custom headers we want to add once we send request to token endpoint.
IsCredentialsInHeaders bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
IsJsonRequest bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
QueryParameters Dictionary<string, string>
The custom query parameter we want to add once we send request to token endpoint.
RequestTimeoutInSeconds int
Request timeout in seconds.
Password This property is required. map[string]string
The password
TokenEndpoint This property is required. string
Token endpoint to request JWT
UserName This property is required. map[string]string
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
Headers map[string]string
The custom headers we want to add once we send request to token endpoint.
IsCredentialsInHeaders bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
IsJsonRequest bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
QueryParameters map[string]string
The custom query parameter we want to add once we send request to token endpoint.
RequestTimeoutInSeconds int
Request timeout in seconds.
password This property is required. Map<String,String>
The password
tokenEndpoint This property is required. String
Token endpoint to request JWT
userName This property is required. Map<String,String>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Map<String,String>
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders Boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest Boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters Map<String,String>
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds Integer
Request timeout in seconds.
password This property is required. {[key: string]: string}
The password
tokenEndpoint This property is required. string
Token endpoint to request JWT
userName This property is required. {[key: string]: string}
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers {[key: string]: string}
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters {[key: string]: string}
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds number
Request timeout in seconds.
password This property is required. Mapping[str, str]
The password
token_endpoint This property is required. str
Token endpoint to request JWT
user_name This property is required. Mapping[str, str]
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Mapping[str, str]
The custom headers we want to add once we send request to token endpoint.
is_credentials_in_headers bool
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
is_json_request bool
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
query_parameters Mapping[str, str]
The custom query parameter we want to add once we send request to token endpoint.
request_timeout_in_seconds int
Request timeout in seconds.
password This property is required. Map<String>
The password
tokenEndpoint This property is required. String
Token endpoint to request JWT
userName This property is required. Map<String>
The user name. If user name and password sent in header request we only need to populate the value property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the Key and Value.
headers Map<String>
The custom headers we want to add once we send request to token endpoint.
isCredentialsInHeaders Boolean
Flag indicating whether we want to send the user name and password to token endpoint in the headers.
isJsonRequest Boolean
Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded).
queryParameters Map<String>
The custom query parameter we want to add once we send request to token endpoint.
requestTimeoutInSeconds Number
Request timeout in seconds.

NoneAuthModel
, NoneAuthModelArgs

NoneAuthModelResponse
, NoneAuthModelResponseArgs

OAuthModel
, OAuthModelArgs

ClientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
ClientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
GrantType This property is required. string
The grant type, usually will be 'authorization code'.
TokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
AccessTokenPrepend string
Access token prepend. Default is 'Bearer'.
AuthorizationCode string
The user's authorization code.
AuthorizationEndpoint string
The authorization endpoint.
AuthorizationEndpointHeaders Dictionary<string, string>
The authorization endpoint headers.
AuthorizationEndpointQueryParameters Dictionary<string, string>
The authorization endpoint query parameters.
IsCredentialsInHeaders bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
IsJwtBearerFlow bool
A value indicating whether it's a JWT flow.
RedirectUri string
The Application redirect url that the user config in the OAuth provider.
Scope string
The Application (client) Scope that the OAuth provider assigned to your app.
TokenEndpointHeaders Dictionary<string, string>
The token endpoint headers.
TokenEndpointQueryParameters Dictionary<string, string>
The token endpoint query parameters.
ClientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
ClientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
GrantType This property is required. string
The grant type, usually will be 'authorization code'.
TokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
AccessTokenPrepend string
Access token prepend. Default is 'Bearer'.
AuthorizationCode string
The user's authorization code.
AuthorizationEndpoint string
The authorization endpoint.
AuthorizationEndpointHeaders map[string]string
The authorization endpoint headers.
AuthorizationEndpointQueryParameters map[string]string
The authorization endpoint query parameters.
IsCredentialsInHeaders bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
IsJwtBearerFlow bool
A value indicating whether it's a JWT flow.
RedirectUri string
The Application redirect url that the user config in the OAuth provider.
Scope string
The Application (client) Scope that the OAuth provider assigned to your app.
TokenEndpointHeaders map[string]string
The token endpoint headers.
TokenEndpointQueryParameters map[string]string
The token endpoint query parameters.
clientId This property is required. String
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. String
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. String
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. String
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend String
Access token prepend. Default is 'Bearer'.
authorizationCode String
The user's authorization code.
authorizationEndpoint String
The authorization endpoint.
authorizationEndpointHeaders Map<String,String>
The authorization endpoint headers.
authorizationEndpointQueryParameters Map<String,String>
The authorization endpoint query parameters.
isCredentialsInHeaders Boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow Boolean
A value indicating whether it's a JWT flow.
redirectUri String
The Application redirect url that the user config in the OAuth provider.
scope String
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders Map<String,String>
The token endpoint headers.
tokenEndpointQueryParameters Map<String,String>
The token endpoint query parameters.
clientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. string
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend string
Access token prepend. Default is 'Bearer'.
authorizationCode string
The user's authorization code.
authorizationEndpoint string
The authorization endpoint.
authorizationEndpointHeaders {[key: string]: string}
The authorization endpoint headers.
authorizationEndpointQueryParameters {[key: string]: string}
The authorization endpoint query parameters.
isCredentialsInHeaders boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow boolean
A value indicating whether it's a JWT flow.
redirectUri string
The Application redirect url that the user config in the OAuth provider.
scope string
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders {[key: string]: string}
The token endpoint headers.
tokenEndpointQueryParameters {[key: string]: string}
The token endpoint query parameters.
client_id This property is required. str
The Application (client) ID that the OAuth provider assigned to your app.
client_secret This property is required. str
The Application (client) secret that the OAuth provider assigned to your app.
grant_type This property is required. str
The grant type, usually will be 'authorization code'.
token_endpoint This property is required. str
The token endpoint. Defines the OAuth2 refresh token.
access_token_prepend str
Access token prepend. Default is 'Bearer'.
authorization_code str
The user's authorization code.
authorization_endpoint str
The authorization endpoint.
authorization_endpoint_headers Mapping[str, str]
The authorization endpoint headers.
authorization_endpoint_query_parameters Mapping[str, str]
The authorization endpoint query parameters.
is_credentials_in_headers bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
is_jwt_bearer_flow bool
A value indicating whether it's a JWT flow.
redirect_uri str
The Application redirect url that the user config in the OAuth provider.
scope str
The Application (client) Scope that the OAuth provider assigned to your app.
token_endpoint_headers Mapping[str, str]
The token endpoint headers.
token_endpoint_query_parameters Mapping[str, str]
The token endpoint query parameters.
clientId This property is required. String
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. String
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. String
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. String
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend String
Access token prepend. Default is 'Bearer'.
authorizationCode String
The user's authorization code.
authorizationEndpoint String
The authorization endpoint.
authorizationEndpointHeaders Map<String>
The authorization endpoint headers.
authorizationEndpointQueryParameters Map<String>
The authorization endpoint query parameters.
isCredentialsInHeaders Boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow Boolean
A value indicating whether it's a JWT flow.
redirectUri String
The Application redirect url that the user config in the OAuth provider.
scope String
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders Map<String>
The token endpoint headers.
tokenEndpointQueryParameters Map<String>
The token endpoint query parameters.

OAuthModelResponse
, OAuthModelResponseArgs

ClientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
ClientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
GrantType This property is required. string
The grant type, usually will be 'authorization code'.
TokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
AccessTokenPrepend string
Access token prepend. Default is 'Bearer'.
AuthorizationCode string
The user's authorization code.
AuthorizationEndpoint string
The authorization endpoint.
AuthorizationEndpointHeaders Dictionary<string, string>
The authorization endpoint headers.
AuthorizationEndpointQueryParameters Dictionary<string, string>
The authorization endpoint query parameters.
IsCredentialsInHeaders bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
IsJwtBearerFlow bool
A value indicating whether it's a JWT flow.
RedirectUri string
The Application redirect url that the user config in the OAuth provider.
Scope string
The Application (client) Scope that the OAuth provider assigned to your app.
TokenEndpointHeaders Dictionary<string, string>
The token endpoint headers.
TokenEndpointQueryParameters Dictionary<string, string>
The token endpoint query parameters.
ClientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
ClientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
GrantType This property is required. string
The grant type, usually will be 'authorization code'.
TokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
AccessTokenPrepend string
Access token prepend. Default is 'Bearer'.
AuthorizationCode string
The user's authorization code.
AuthorizationEndpoint string
The authorization endpoint.
AuthorizationEndpointHeaders map[string]string
The authorization endpoint headers.
AuthorizationEndpointQueryParameters map[string]string
The authorization endpoint query parameters.
IsCredentialsInHeaders bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
IsJwtBearerFlow bool
A value indicating whether it's a JWT flow.
RedirectUri string
The Application redirect url that the user config in the OAuth provider.
Scope string
The Application (client) Scope that the OAuth provider assigned to your app.
TokenEndpointHeaders map[string]string
The token endpoint headers.
TokenEndpointQueryParameters map[string]string
The token endpoint query parameters.
clientId This property is required. String
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. String
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. String
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. String
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend String
Access token prepend. Default is 'Bearer'.
authorizationCode String
The user's authorization code.
authorizationEndpoint String
The authorization endpoint.
authorizationEndpointHeaders Map<String,String>
The authorization endpoint headers.
authorizationEndpointQueryParameters Map<String,String>
The authorization endpoint query parameters.
isCredentialsInHeaders Boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow Boolean
A value indicating whether it's a JWT flow.
redirectUri String
The Application redirect url that the user config in the OAuth provider.
scope String
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders Map<String,String>
The token endpoint headers.
tokenEndpointQueryParameters Map<String,String>
The token endpoint query parameters.
clientId This property is required. string
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. string
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. string
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. string
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend string
Access token prepend. Default is 'Bearer'.
authorizationCode string
The user's authorization code.
authorizationEndpoint string
The authorization endpoint.
authorizationEndpointHeaders {[key: string]: string}
The authorization endpoint headers.
authorizationEndpointQueryParameters {[key: string]: string}
The authorization endpoint query parameters.
isCredentialsInHeaders boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow boolean
A value indicating whether it's a JWT flow.
redirectUri string
The Application redirect url that the user config in the OAuth provider.
scope string
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders {[key: string]: string}
The token endpoint headers.
tokenEndpointQueryParameters {[key: string]: string}
The token endpoint query parameters.
client_id This property is required. str
The Application (client) ID that the OAuth provider assigned to your app.
client_secret This property is required. str
The Application (client) secret that the OAuth provider assigned to your app.
grant_type This property is required. str
The grant type, usually will be 'authorization code'.
token_endpoint This property is required. str
The token endpoint. Defines the OAuth2 refresh token.
access_token_prepend str
Access token prepend. Default is 'Bearer'.
authorization_code str
The user's authorization code.
authorization_endpoint str
The authorization endpoint.
authorization_endpoint_headers Mapping[str, str]
The authorization endpoint headers.
authorization_endpoint_query_parameters Mapping[str, str]
The authorization endpoint query parameters.
is_credentials_in_headers bool
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
is_jwt_bearer_flow bool
A value indicating whether it's a JWT flow.
redirect_uri str
The Application redirect url that the user config in the OAuth provider.
scope str
The Application (client) Scope that the OAuth provider assigned to your app.
token_endpoint_headers Mapping[str, str]
The token endpoint headers.
token_endpoint_query_parameters Mapping[str, str]
The token endpoint query parameters.
clientId This property is required. String
The Application (client) ID that the OAuth provider assigned to your app.
clientSecret This property is required. String
The Application (client) secret that the OAuth provider assigned to your app.
grantType This property is required. String
The grant type, usually will be 'authorization code'.
tokenEndpoint This property is required. String
The token endpoint. Defines the OAuth2 refresh token.
accessTokenPrepend String
Access token prepend. Default is 'Bearer'.
authorizationCode String
The user's authorization code.
authorizationEndpoint String
The authorization endpoint.
authorizationEndpointHeaders Map<String>
The authorization endpoint headers.
authorizationEndpointQueryParameters Map<String>
The authorization endpoint query parameters.
isCredentialsInHeaders Boolean
Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers.
isJwtBearerFlow Boolean
A value indicating whether it's a JWT flow.
redirectUri String
The Application redirect url that the user config in the OAuth provider.
scope String
The Application (client) Scope that the OAuth provider assigned to your app.
tokenEndpointHeaders Map<String>
The token endpoint headers.
tokenEndpointQueryParameters Map<String>
The token endpoint query parameters.

OracleAuthModel
, OracleAuthModelArgs

PemFile This property is required. string
Content of the PRM file
PublicFingerprint This property is required. string
Public Fingerprint
TenantId This property is required. string
Oracle tenant ID
UserId This property is required. string
Oracle user ID
PemFile This property is required. string
Content of the PRM file
PublicFingerprint This property is required. string
Public Fingerprint
TenantId This property is required. string
Oracle tenant ID
UserId This property is required. string
Oracle user ID
pemFile This property is required. String
Content of the PRM file
publicFingerprint This property is required. String
Public Fingerprint
tenantId This property is required. String
Oracle tenant ID
userId This property is required. String
Oracle user ID
pemFile This property is required. string
Content of the PRM file
publicFingerprint This property is required. string
Public Fingerprint
tenantId This property is required. string
Oracle tenant ID
userId This property is required. string
Oracle user ID
pem_file This property is required. str
Content of the PRM file
public_fingerprint This property is required. str
Public Fingerprint
tenant_id This property is required. str
Oracle tenant ID
user_id This property is required. str
Oracle user ID
pemFile This property is required. String
Content of the PRM file
publicFingerprint This property is required. String
Public Fingerprint
tenantId This property is required. String
Oracle tenant ID
userId This property is required. String
Oracle user ID

OracleAuthModelResponse
, OracleAuthModelResponseArgs

PemFile This property is required. string
Content of the PRM file
PublicFingerprint This property is required. string
Public Fingerprint
TenantId This property is required. string
Oracle tenant ID
UserId This property is required. string
Oracle user ID
PemFile This property is required. string
Content of the PRM file
PublicFingerprint This property is required. string
Public Fingerprint
TenantId This property is required. string
Oracle tenant ID
UserId This property is required. string
Oracle user ID
pemFile This property is required. String
Content of the PRM file
publicFingerprint This property is required. String
Public Fingerprint
tenantId This property is required. String
Oracle tenant ID
userId This property is required. String
Oracle user ID
pemFile This property is required. string
Content of the PRM file
publicFingerprint This property is required. string
Public Fingerprint
tenantId This property is required. string
Oracle tenant ID
userId This property is required. string
Oracle user ID
pem_file This property is required. str
Content of the PRM file
public_fingerprint This property is required. str
Public Fingerprint
tenant_id This property is required. str
Oracle tenant ID
user_id This property is required. str
Oracle user ID
pemFile This property is required. String
Content of the PRM file
publicFingerprint This property is required. String
Public Fingerprint
tenantId This property is required. String
Oracle tenant ID
userId This property is required. String
Oracle user ID

RestApiPollerRequestConfig
, RestApiPollerRequestConfigArgs

ApiEndpoint This property is required. string
The API endpoint.
EndTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
Headers Dictionary<string, string>
The header for the request for the remote server.
HttpMethod string | Pulumi.AzureNative.SecurityInsights.HttpMethodVerb
The HTTP method, default value GET.
IsPostPayloadJson bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
QueryParameters object
The HTTP query parameters to RESTful API.
QueryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
QueryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
QueryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
QueryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
QueryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
QueryWindowInMin int
The query window in minutes for the request.
RateLimitQPS int
The Rate limit queries per second for the request..
RetryCount int
The retry count.
StartTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
TimeoutInSeconds int
The timeout in seconds.
ApiEndpoint This property is required. string
The API endpoint.
EndTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
Headers map[string]string
The header for the request for the remote server.
HttpMethod string | HttpMethodVerb
The HTTP method, default value GET.
IsPostPayloadJson bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
QueryParameters interface{}
The HTTP query parameters to RESTful API.
QueryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
QueryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
QueryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
QueryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
QueryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
QueryWindowInMin int
The query window in minutes for the request.
RateLimitQPS int
The Rate limit queries per second for the request..
RetryCount int
The retry count.
StartTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
TimeoutInSeconds int
The timeout in seconds.
apiEndpoint This property is required. String
The API endpoint.
endTimeAttributeName String
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Map<String,String>
The header for the request for the remote server.
httpMethod String | HttpMethodVerb
The HTTP method, default value GET.
isPostPayloadJson Boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters Object
The HTTP query parameters to RESTful API.
queryParametersTemplate String
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat String
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName String
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter String
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend String
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin Integer
The query window in minutes for the request.
rateLimitQPS Integer
The Rate limit queries per second for the request..
retryCount Integer
The retry count.
startTimeAttributeName String
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds Integer
The timeout in seconds.
apiEndpoint This property is required. string
The API endpoint.
endTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers {[key: string]: string}
The header for the request for the remote server.
httpMethod string | HttpMethodVerb
The HTTP method, default value GET.
isPostPayloadJson boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters any
The HTTP query parameters to RESTful API.
queryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin number
The query window in minutes for the request.
rateLimitQPS number
The Rate limit queries per second for the request..
retryCount number
The retry count.
startTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds number
The timeout in seconds.
api_endpoint This property is required. str
The API endpoint.
end_time_attribute_name str
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Mapping[str, str]
The header for the request for the remote server.
http_method str | HttpMethodVerb
The HTTP method, default value GET.
is_post_payload_json bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
query_parameters Any
The HTTP query parameters to RESTful API.
query_parameters_template str
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
query_time_format str
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
query_time_interval_attribute_name str
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
query_time_interval_delimiter str
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
query_time_interval_prepend str
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
query_window_in_min int
The query window in minutes for the request.
rate_limit_qps int
The Rate limit queries per second for the request..
retry_count int
The retry count.
start_time_attribute_name str
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeout_in_seconds int
The timeout in seconds.
apiEndpoint This property is required. String
The API endpoint.
endTimeAttributeName String
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Map<String>
The header for the request for the remote server.
httpMethod String | "GET" | "POST" | "PUT" | "DELETE"
The HTTP method, default value GET.
isPostPayloadJson Boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters Any
The HTTP query parameters to RESTful API.
queryParametersTemplate String
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat String
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName String
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter String
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend String
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin Number
The query window in minutes for the request.
rateLimitQPS Number
The Rate limit queries per second for the request..
retryCount Number
The retry count.
startTimeAttributeName String
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds Number
The timeout in seconds.

RestApiPollerRequestConfigResponse
, RestApiPollerRequestConfigResponseArgs

ApiEndpoint This property is required. string
The API endpoint.
EndTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
Headers Dictionary<string, string>
The header for the request for the remote server.
HttpMethod string
The HTTP method, default value GET.
IsPostPayloadJson bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
QueryParameters object
The HTTP query parameters to RESTful API.
QueryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
QueryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
QueryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
QueryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
QueryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
QueryWindowInMin int
The query window in minutes for the request.
RateLimitQPS int
The Rate limit queries per second for the request..
RetryCount int
The retry count.
StartTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
TimeoutInSeconds int
The timeout in seconds.
ApiEndpoint This property is required. string
The API endpoint.
EndTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
Headers map[string]string
The header for the request for the remote server.
HttpMethod string
The HTTP method, default value GET.
IsPostPayloadJson bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
QueryParameters interface{}
The HTTP query parameters to RESTful API.
QueryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
QueryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
QueryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
QueryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
QueryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
QueryWindowInMin int
The query window in minutes for the request.
RateLimitQPS int
The Rate limit queries per second for the request..
RetryCount int
The retry count.
StartTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
TimeoutInSeconds int
The timeout in seconds.
apiEndpoint This property is required. String
The API endpoint.
endTimeAttributeName String
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Map<String,String>
The header for the request for the remote server.
httpMethod String
The HTTP method, default value GET.
isPostPayloadJson Boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters Object
The HTTP query parameters to RESTful API.
queryParametersTemplate String
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat String
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName String
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter String
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend String
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin Integer
The query window in minutes for the request.
rateLimitQPS Integer
The Rate limit queries per second for the request..
retryCount Integer
The retry count.
startTimeAttributeName String
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds Integer
The timeout in seconds.
apiEndpoint This property is required. string
The API endpoint.
endTimeAttributeName string
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers {[key: string]: string}
The header for the request for the remote server.
httpMethod string
The HTTP method, default value GET.
isPostPayloadJson boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters any
The HTTP query parameters to RESTful API.
queryParametersTemplate string
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat string
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName string
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter string
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend string
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin number
The query window in minutes for the request.
rateLimitQPS number
The Rate limit queries per second for the request..
retryCount number
The retry count.
startTimeAttributeName string
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds number
The timeout in seconds.
api_endpoint This property is required. str
The API endpoint.
end_time_attribute_name str
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Mapping[str, str]
The header for the request for the remote server.
http_method str
The HTTP method, default value GET.
is_post_payload_json bool
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
query_parameters Any
The HTTP query parameters to RESTful API.
query_parameters_template str
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
query_time_format str
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
query_time_interval_attribute_name str
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
query_time_interval_delimiter str
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
query_time_interval_prepend str
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
query_window_in_min int
The query window in minutes for the request.
rate_limit_qps int
The Rate limit queries per second for the request..
retry_count int
The retry count.
start_time_attribute_name str
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeout_in_seconds int
The timeout in seconds.
apiEndpoint This property is required. String
The API endpoint.
endTimeAttributeName String
The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers Map<String>
The header for the request for the remote server.
httpMethod String
The HTTP method, default value GET.
isPostPayloadJson Boolean
Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters Any
The HTTP query parameters to RESTful API.
queryParametersTemplate String
the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat String
The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName String
The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter String
The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend String
The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin Number
The query window in minutes for the request.
rateLimitQPS Number
The Rate limit queries per second for the request..
retryCount Number
The retry count.
startTimeAttributeName String
The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds Number
The timeout in seconds.

RestApiPollerRequestPagingConfig
, RestApiPollerRequestPagingConfigArgs

PagingType This property is required. string | Pulumi.AzureNative.SecurityInsights.RestApiPollerRequestPagingKind
Type of paging
PageSize int
Page size
PageSizeParameterName string
Page size parameter name
PagingType This property is required. string | RestApiPollerRequestPagingKind
Type of paging
PageSize int
Page size
PageSizeParameterName string
Page size parameter name
pagingType This property is required. String | RestApiPollerRequestPagingKind
Type of paging
pageSize Integer
Page size
pageSizeParameterName String
Page size parameter name
pagingType This property is required. string | RestApiPollerRequestPagingKind
Type of paging
pageSize number
Page size
pageSizeParameterName string
Page size parameter name
paging_type This property is required. str | RestApiPollerRequestPagingKind
Type of paging
page_size int
Page size
page_size_parameter_name str
Page size parameter name

RestApiPollerRequestPagingConfigResponse
, RestApiPollerRequestPagingConfigResponseArgs

PagingType This property is required. string
Type of paging
PageSize int
Page size
PageSizeParameterName string
Page size parameter name
PagingType This property is required. string
Type of paging
PageSize int
Page size
PageSizeParameterName string
Page size parameter name
pagingType This property is required. String
Type of paging
pageSize Integer
Page size
pageSizeParameterName String
Page size parameter name
pagingType This property is required. string
Type of paging
pageSize number
Page size
pageSizeParameterName string
Page size parameter name
paging_type This property is required. str
Type of paging
page_size int
Page size
page_size_parameter_name str
Page size parameter name
pagingType This property is required. String
Type of paging
pageSize Number
Page size
pageSizeParameterName String
Page size parameter name

RestApiPollerRequestPagingKind
, RestApiPollerRequestPagingKindArgs

LinkHeader
LinkHeader
NextPageToken
NextPageToken
NextPageUrl
NextPageUrl
PersistentToken
PersistentToken
PersistentLinkHeader
PersistentLinkHeader
Offset
Offset
CountBasedPaging
CountBasedPaging
RestApiPollerRequestPagingKindLinkHeader
LinkHeader
RestApiPollerRequestPagingKindNextPageToken
NextPageToken
RestApiPollerRequestPagingKindNextPageUrl
NextPageUrl
RestApiPollerRequestPagingKindPersistentToken
PersistentToken
RestApiPollerRequestPagingKindPersistentLinkHeader
PersistentLinkHeader
RestApiPollerRequestPagingKindOffset
Offset
RestApiPollerRequestPagingKindCountBasedPaging
CountBasedPaging
LinkHeader
LinkHeader
NextPageToken
NextPageToken
NextPageUrl
NextPageUrl
PersistentToken
PersistentToken
PersistentLinkHeader
PersistentLinkHeader
Offset
Offset
CountBasedPaging
CountBasedPaging
LinkHeader
LinkHeader
NextPageToken
NextPageToken
NextPageUrl
NextPageUrl
PersistentToken
PersistentToken
PersistentLinkHeader
PersistentLinkHeader
Offset
Offset
CountBasedPaging
CountBasedPaging
LINK_HEADER
LinkHeader
NEXT_PAGE_TOKEN
NextPageToken
NEXT_PAGE_URL
NextPageUrl
PERSISTENT_TOKEN
PersistentToken
PERSISTENT_LINK_HEADER
PersistentLinkHeader
OFFSET
Offset
COUNT_BASED_PAGING
CountBasedPaging
"LinkHeader"
LinkHeader
"NextPageToken"
NextPageToken
"NextPageUrl"
NextPageUrl
"PersistentToken"
PersistentToken
"PersistentLinkHeader"
PersistentLinkHeader
"Offset"
Offset
"CountBasedPaging"
CountBasedPaging

SessionAuthModel
, SessionAuthModelArgs

Password This property is required. Dictionary<string, string>
The password attribute name.
UserName This property is required. Dictionary<string, string>
The user name attribute key value.
Headers Dictionary<string, string>
HTTP request headers to session service endpoint.
IsPostPayloadJson bool
Indicating whether API key is set in HTTP POST payload.
QueryParameters object
Query parameters to session service endpoint.
SessionIdName string
Session id attribute name from HTTP response header.
SessionLoginRequestUri string
HTTP request URL to session service endpoint.
SessionTimeoutInMinutes int
Session timeout in minutes.
Password This property is required. map[string]string
The password attribute name.
UserName This property is required. map[string]string
The user name attribute key value.
Headers map[string]string
HTTP request headers to session service endpoint.
IsPostPayloadJson bool
Indicating whether API key is set in HTTP POST payload.
QueryParameters interface{}
Query parameters to session service endpoint.
SessionIdName string
Session id attribute name from HTTP response header.
SessionLoginRequestUri string
HTTP request URL to session service endpoint.
SessionTimeoutInMinutes int
Session timeout in minutes.
password This property is required. Map<String,String>
The password attribute name.
userName This property is required. Map<String,String>
The user name attribute key value.
headers Map<String,String>
HTTP request headers to session service endpoint.
isPostPayloadJson Boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters Object
Query parameters to session service endpoint.
sessionIdName String
Session id attribute name from HTTP response header.
sessionLoginRequestUri String
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes Integer
Session timeout in minutes.
password This property is required. {[key: string]: string}
The password attribute name.
userName This property is required. {[key: string]: string}
The user name attribute key value.
headers {[key: string]: string}
HTTP request headers to session service endpoint.
isPostPayloadJson boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters any
Query parameters to session service endpoint.
sessionIdName string
Session id attribute name from HTTP response header.
sessionLoginRequestUri string
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes number
Session timeout in minutes.
password This property is required. Mapping[str, str]
The password attribute name.
user_name This property is required. Mapping[str, str]
The user name attribute key value.
headers Mapping[str, str]
HTTP request headers to session service endpoint.
is_post_payload_json bool
Indicating whether API key is set in HTTP POST payload.
query_parameters Any
Query parameters to session service endpoint.
session_id_name str
Session id attribute name from HTTP response header.
session_login_request_uri str
HTTP request URL to session service endpoint.
session_timeout_in_minutes int
Session timeout in minutes.
password This property is required. Map<String>
The password attribute name.
userName This property is required. Map<String>
The user name attribute key value.
headers Map<String>
HTTP request headers to session service endpoint.
isPostPayloadJson Boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters Any
Query parameters to session service endpoint.
sessionIdName String
Session id attribute name from HTTP response header.
sessionLoginRequestUri String
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes Number
Session timeout in minutes.

SessionAuthModelResponse
, SessionAuthModelResponseArgs

Password This property is required. Dictionary<string, string>
The password attribute name.
UserName This property is required. Dictionary<string, string>
The user name attribute key value.
Headers Dictionary<string, string>
HTTP request headers to session service endpoint.
IsPostPayloadJson bool
Indicating whether API key is set in HTTP POST payload.
QueryParameters object
Query parameters to session service endpoint.
SessionIdName string
Session id attribute name from HTTP response header.
SessionLoginRequestUri string
HTTP request URL to session service endpoint.
SessionTimeoutInMinutes int
Session timeout in minutes.
Password This property is required. map[string]string
The password attribute name.
UserName This property is required. map[string]string
The user name attribute key value.
Headers map[string]string
HTTP request headers to session service endpoint.
IsPostPayloadJson bool
Indicating whether API key is set in HTTP POST payload.
QueryParameters interface{}
Query parameters to session service endpoint.
SessionIdName string
Session id attribute name from HTTP response header.
SessionLoginRequestUri string
HTTP request URL to session service endpoint.
SessionTimeoutInMinutes int
Session timeout in minutes.
password This property is required. Map<String,String>
The password attribute name.
userName This property is required. Map<String,String>
The user name attribute key value.
headers Map<String,String>
HTTP request headers to session service endpoint.
isPostPayloadJson Boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters Object
Query parameters to session service endpoint.
sessionIdName String
Session id attribute name from HTTP response header.
sessionLoginRequestUri String
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes Integer
Session timeout in minutes.
password This property is required. {[key: string]: string}
The password attribute name.
userName This property is required. {[key: string]: string}
The user name attribute key value.
headers {[key: string]: string}
HTTP request headers to session service endpoint.
isPostPayloadJson boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters any
Query parameters to session service endpoint.
sessionIdName string
Session id attribute name from HTTP response header.
sessionLoginRequestUri string
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes number
Session timeout in minutes.
password This property is required. Mapping[str, str]
The password attribute name.
user_name This property is required. Mapping[str, str]
The user name attribute key value.
headers Mapping[str, str]
HTTP request headers to session service endpoint.
is_post_payload_json bool
Indicating whether API key is set in HTTP POST payload.
query_parameters Any
Query parameters to session service endpoint.
session_id_name str
Session id attribute name from HTTP response header.
session_login_request_uri str
HTTP request URL to session service endpoint.
session_timeout_in_minutes int
Session timeout in minutes.
password This property is required. Map<String>
The password attribute name.
userName This property is required. Map<String>
The user name attribute key value.
headers Map<String>
HTTP request headers to session service endpoint.
isPostPayloadJson Boolean
Indicating whether API key is set in HTTP POST payload.
queryParameters Any
Query parameters to session service endpoint.
sessionIdName String
Session id attribute name from HTTP response header.
sessionLoginRequestUri String
HTTP request URL to session service endpoint.
sessionTimeoutInMinutes Number
Session timeout in minutes.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
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.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
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.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
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.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
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_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
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.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
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:securityinsights:RestApiPollerDataConnector 73e01a99-5cd7-4139-a149-9f2736ff2ab5 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0