1. Packages
  2. Azure Native v2
  3. API Docs
  4. securityinsights
  5. getCustomizableConnectorDefinition
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.securityinsights.getCustomizableConnectorDefinition

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a data connector definition. Azure REST API version: 2023-07-01-preview.

Using getCustomizableConnectorDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomizableConnectorDefinition(args: GetCustomizableConnectorDefinitionArgs, opts?: InvokeOptions): Promise<GetCustomizableConnectorDefinitionResult>
function getCustomizableConnectorDefinitionOutput(args: GetCustomizableConnectorDefinitionOutputArgs, opts?: InvokeOptions): Output<GetCustomizableConnectorDefinitionResult>
Copy
def get_customizable_connector_definition(data_connector_definition_name: Optional[str] = None,
                                          resource_group_name: Optional[str] = None,
                                          workspace_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetCustomizableConnectorDefinitionResult
def get_customizable_connector_definition_output(data_connector_definition_name: Optional[pulumi.Input[str]] = None,
                                          resource_group_name: Optional[pulumi.Input[str]] = None,
                                          workspace_name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetCustomizableConnectorDefinitionResult]
Copy
func LookupCustomizableConnectorDefinition(ctx *Context, args *LookupCustomizableConnectorDefinitionArgs, opts ...InvokeOption) (*LookupCustomizableConnectorDefinitionResult, error)
func LookupCustomizableConnectorDefinitionOutput(ctx *Context, args *LookupCustomizableConnectorDefinitionOutputArgs, opts ...InvokeOption) LookupCustomizableConnectorDefinitionResultOutput
Copy

> Note: This function is named LookupCustomizableConnectorDefinition in the Go SDK.

public static class GetCustomizableConnectorDefinition 
{
    public static Task<GetCustomizableConnectorDefinitionResult> InvokeAsync(GetCustomizableConnectorDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomizableConnectorDefinitionResult> Invoke(GetCustomizableConnectorDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomizableConnectorDefinitionResult> getCustomizableConnectorDefinition(GetCustomizableConnectorDefinitionArgs args, InvokeOptions options)
public static Output<GetCustomizableConnectorDefinitionResult> getCustomizableConnectorDefinition(GetCustomizableConnectorDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getCustomizableConnectorDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataConnectorDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The data connector definition name.
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.
DataConnectorDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The data connector definition name.
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.
dataConnectorDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The data connector definition name.
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.
dataConnectorDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The data connector definition name.
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.
data_connector_definition_name
This property is required.
Changes to this property will trigger replacement.
str
The data connector definition name.
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.
dataConnectorDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The data connector definition name.
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.

getCustomizableConnectorDefinition Result

The following output properties are available:

ConnectorUiConfig Pulumi.AzureNative.SecurityInsights.Outputs.CustomizableConnectorUiConfigResponse
The UiConfig for 'Customizable' connector definition kind.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ConnectionsConfig Pulumi.AzureNative.SecurityInsights.Outputs.CustomizableConnectionsConfigResponse
The UiConfig for 'Customizable' connector definition kind.
CreatedTimeUtc string
Gets or sets the connector definition created date in UTC format.
Etag string
Etag of the azure resource
LastModifiedUtc string
Gets or sets the connector definition last modified date in UTC format.
ConnectorUiConfig CustomizableConnectorUiConfigResponse
The UiConfig for 'Customizable' connector definition kind.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ConnectionsConfig CustomizableConnectionsConfigResponse
The UiConfig for 'Customizable' connector definition kind.
CreatedTimeUtc string
Gets or sets the connector definition created date in UTC format.
Etag string
Etag of the azure resource
LastModifiedUtc string
Gets or sets the connector definition last modified date in UTC format.
connectorUiConfig CustomizableConnectorUiConfigResponse
The UiConfig for 'Customizable' connector definition kind.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
connectionsConfig CustomizableConnectionsConfigResponse
The UiConfig for 'Customizable' connector definition kind.
createdTimeUtc String
Gets or sets the connector definition created date in UTC format.
etag String
Etag of the azure resource
lastModifiedUtc String
Gets or sets the connector definition last modified date in UTC format.
connectorUiConfig CustomizableConnectorUiConfigResponse
The UiConfig for 'Customizable' connector definition kind.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
connectionsConfig CustomizableConnectionsConfigResponse
The UiConfig for 'Customizable' connector definition kind.
createdTimeUtc string
Gets or sets the connector definition created date in UTC format.
etag string
Etag of the azure resource
lastModifiedUtc string
Gets or sets the connector definition last modified date in UTC format.
connector_ui_config CustomizableConnectorUiConfigResponse
The UiConfig for 'Customizable' connector definition kind.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
connections_config CustomizableConnectionsConfigResponse
The UiConfig for 'Customizable' connector definition kind.
created_time_utc str
Gets or sets the connector definition created date in UTC format.
etag str
Etag of the azure resource
last_modified_utc str
Gets or sets the connector definition last modified date in UTC format.
connectorUiConfig Property Map
The UiConfig for 'Customizable' connector definition kind.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
connectionsConfig Property Map
The UiConfig for 'Customizable' connector definition kind.
createdTimeUtc String
Gets or sets the connector definition created date in UTC format.
etag String
Etag of the azure resource
lastModifiedUtc String
Gets or sets the connector definition last modified date in UTC format.

Supporting Types

ConnectivityCriterionResponse

Type This property is required. string
Gets or sets the type of connectivity.
Value List<string>
Gets or sets the queries for checking connectivity.
Type This property is required. string
Gets or sets the type of connectivity.
Value []string
Gets or sets the queries for checking connectivity.
type This property is required. String
Gets or sets the type of connectivity.
value List<String>
Gets or sets the queries for checking connectivity.
type This property is required. string
Gets or sets the type of connectivity.
value string[]
Gets or sets the queries for checking connectivity.
type This property is required. str
Gets or sets the type of connectivity.
value Sequence[str]
Gets or sets the queries for checking connectivity.
type This property is required. String
Gets or sets the type of connectivity.
value List<String>
Gets or sets the queries for checking connectivity.

ConnectorDataTypeResponse

LastDataReceivedQuery This property is required. string
Gets or sets the query to indicate when relevant data was last received in the workspace.
Name This property is required. string
Gets or sets the name of the data type to show in the graph.
LastDataReceivedQuery This property is required. string
Gets or sets the query to indicate when relevant data was last received in the workspace.
Name This property is required. string
Gets or sets the name of the data type to show in the graph.
lastDataReceivedQuery This property is required. String
Gets or sets the query to indicate when relevant data was last received in the workspace.
name This property is required. String
Gets or sets the name of the data type to show in the graph.
lastDataReceivedQuery This property is required. string
Gets or sets the query to indicate when relevant data was last received in the workspace.
name This property is required. string
Gets or sets the name of the data type to show in the graph.
last_data_received_query This property is required. str
Gets or sets the query to indicate when relevant data was last received in the workspace.
name This property is required. str
Gets or sets the name of the data type to show in the graph.
lastDataReceivedQuery This property is required. String
Gets or sets the query to indicate when relevant data was last received in the workspace.
name This property is required. String
Gets or sets the name of the data type to show in the graph.

ConnectorDefinitionsAvailabilityResponse

IsPreview bool
Gets or sets a value indicating whether the connector is preview.
Status int
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).
IsPreview bool
Gets or sets a value indicating whether the connector is preview.
Status int
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).
isPreview Boolean
Gets or sets a value indicating whether the connector is preview.
status Integer
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).
isPreview boolean
Gets or sets a value indicating whether the connector is preview.
status number
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).
is_preview bool
Gets or sets a value indicating whether the connector is preview.
status int
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).
isPreview Boolean
Gets or sets a value indicating whether the connector is preview.
status Number
The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).

ConnectorDefinitionsPermissionsResponse

Customs List<Pulumi.AzureNative.SecurityInsights.Inputs.CustomPermissionDetailsResponse>
Gets or sets the customs permissions required for the user to create connections.
Licenses List<string>
Gets or sets the required licenses for the user to create connections.
ResourceProvider List<Pulumi.AzureNative.SecurityInsights.Inputs.ConnectorDefinitionsResourceProviderResponse>
Gets or sets the resource provider permissions required for the user to create connections.
Tenant List<string>
Gets or sets the required tenant permissions for the connector.
Customs []CustomPermissionDetailsResponse
Gets or sets the customs permissions required for the user to create connections.
Licenses []string
Gets or sets the required licenses for the user to create connections.
ResourceProvider []ConnectorDefinitionsResourceProviderResponse
Gets or sets the resource provider permissions required for the user to create connections.
Tenant []string
Gets or sets the required tenant permissions for the connector.
customs List<CustomPermissionDetailsResponse>
Gets or sets the customs permissions required for the user to create connections.
licenses List<String>
Gets or sets the required licenses for the user to create connections.
resourceProvider List<ConnectorDefinitionsResourceProviderResponse>
Gets or sets the resource provider permissions required for the user to create connections.
tenant List<String>
Gets or sets the required tenant permissions for the connector.
customs CustomPermissionDetailsResponse[]
Gets or sets the customs permissions required for the user to create connections.
licenses string[]
Gets or sets the required licenses for the user to create connections.
resourceProvider ConnectorDefinitionsResourceProviderResponse[]
Gets or sets the resource provider permissions required for the user to create connections.
tenant string[]
Gets or sets the required tenant permissions for the connector.
customs Sequence[CustomPermissionDetailsResponse]
Gets or sets the customs permissions required for the user to create connections.
licenses Sequence[str]
Gets or sets the required licenses for the user to create connections.
resource_provider Sequence[ConnectorDefinitionsResourceProviderResponse]
Gets or sets the resource provider permissions required for the user to create connections.
tenant Sequence[str]
Gets or sets the required tenant permissions for the connector.
customs List<Property Map>
Gets or sets the customs permissions required for the user to create connections.
licenses List<String>
Gets or sets the required licenses for the user to create connections.
resourceProvider List<Property Map>
Gets or sets the resource provider permissions required for the user to create connections.
tenant List<String>
Gets or sets the required tenant permissions for the connector.

ConnectorDefinitionsResourceProviderResponse

PermissionsDisplayText This property is required. string
Gets or sets the permissions description text.
Provider This property is required. string
Gets or sets the provider name.
ProviderDisplayName This property is required. string
Gets or sets the permissions provider display name.
RequiredPermissions This property is required. Pulumi.AzureNative.SecurityInsights.Inputs.ResourceProviderRequiredPermissionsResponse
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
Scope This property is required. string
The scope on which the user should have permissions, in order to be able to create connections.
PermissionsDisplayText This property is required. string
Gets or sets the permissions description text.
Provider This property is required. string
Gets or sets the provider name.
ProviderDisplayName This property is required. string
Gets or sets the permissions provider display name.
RequiredPermissions This property is required. ResourceProviderRequiredPermissionsResponse
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
Scope This property is required. string
The scope on which the user should have permissions, in order to be able to create connections.
permissionsDisplayText This property is required. String
Gets or sets the permissions description text.
provider This property is required. String
Gets or sets the provider name.
providerDisplayName This property is required. String
Gets or sets the permissions provider display name.
requiredPermissions This property is required. ResourceProviderRequiredPermissionsResponse
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
scope This property is required. String
The scope on which the user should have permissions, in order to be able to create connections.
permissionsDisplayText This property is required. string
Gets or sets the permissions description text.
provider This property is required. string
Gets or sets the provider name.
providerDisplayName This property is required. string
Gets or sets the permissions provider display name.
requiredPermissions This property is required. ResourceProviderRequiredPermissionsResponse
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
scope This property is required. string
The scope on which the user should have permissions, in order to be able to create connections.
permissions_display_text This property is required. str
Gets or sets the permissions description text.
provider This property is required. str
Gets or sets the provider name.
provider_display_name This property is required. str
Gets or sets the permissions provider display name.
required_permissions This property is required. ResourceProviderRequiredPermissionsResponse
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
scope This property is required. str
The scope on which the user should have permissions, in order to be able to create connections.
permissionsDisplayText This property is required. String
Gets or sets the permissions description text.
provider This property is required. String
Gets or sets the provider name.
providerDisplayName This property is required. String
Gets or sets the permissions provider display name.
requiredPermissions This property is required. Property Map
Required permissions for the connector resource provider that define in ResourceProviders. For more information about the permissions see here.
scope This property is required. String
The scope on which the user should have permissions, in order to be able to create connections.

CustomPermissionDetailsResponse

Description This property is required. string
Gets or sets the custom permissions description.
Name This property is required. string
Gets or sets the custom permissions name.
Description This property is required. string
Gets or sets the custom permissions description.
Name This property is required. string
Gets or sets the custom permissions name.
description This property is required. String
Gets or sets the custom permissions description.
name This property is required. String
Gets or sets the custom permissions name.
description This property is required. string
Gets or sets the custom permissions description.
name This property is required. string
Gets or sets the custom permissions name.
description This property is required. str
Gets or sets the custom permissions description.
name This property is required. str
Gets or sets the custom permissions name.
description This property is required. String
Gets or sets the custom permissions description.
name This property is required. String
Gets or sets the custom permissions name.

CustomizableConnectionsConfigResponse

TemplateSpecName This property is required. string
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
TemplateSpecVersion This property is required. string
Gets or sets the template version.
TemplateSpecName This property is required. string
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
TemplateSpecVersion This property is required. string
Gets or sets the template version.
templateSpecName This property is required. String
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
templateSpecVersion This property is required. String
Gets or sets the template version.
templateSpecName This property is required. string
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
templateSpecVersion This property is required. string
Gets or sets the template version.
template_spec_name This property is required. str
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
template_spec_version This property is required. str
Gets or sets the template version.
templateSpecName This property is required. String
Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates.
templateSpecVersion This property is required. String
Gets or sets the template version.

CustomizableConnectorUiConfigResponse

ConnectivityCriteria This property is required. List<Pulumi.AzureNative.SecurityInsights.Inputs.ConnectivityCriterionResponse>
Gets or sets the way the connector checks whether the connector is connected.
DataTypes This property is required. List<Pulumi.AzureNative.SecurityInsights.Inputs.ConnectorDataTypeResponse>
Gets or sets the data types to check for last data received.
DescriptionMarkdown This property is required. string
Gets or sets the connector description in markdown format.
GraphQueries This property is required. List<Pulumi.AzureNative.SecurityInsights.Inputs.GraphQueryResponse>
Gets or sets the graph queries to show the current data volume over time.
InstructionSteps This property is required. List<Pulumi.AzureNative.SecurityInsights.Inputs.InstructionStepResponse>
Gets or sets the instruction steps to enable the connector.
Permissions This property is required. Pulumi.AzureNative.SecurityInsights.Inputs.ConnectorDefinitionsPermissionsResponse
The required Permissions for the connector.
Publisher This property is required. string
Gets or sets the connector publisher name.
SampleQueries This property is required. List<Pulumi.AzureNative.SecurityInsights.Inputs.SampleQueryResponse>
Gets or sets the sample queries for the connector.
Title This property is required. string
Gets or sets the connector blade title.
Availability Pulumi.AzureNative.SecurityInsights.Inputs.ConnectorDefinitionsAvailabilityResponse
The exposure status of the connector to the customers.
GraphQueriesTableName string
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
Id string
Gets or sets custom connector id. optional field.
IsConnectivityCriteriasMatchSome bool
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
Logo string
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.
ConnectivityCriteria This property is required. []ConnectivityCriterionResponse
Gets or sets the way the connector checks whether the connector is connected.
DataTypes This property is required. []ConnectorDataTypeResponse
Gets or sets the data types to check for last data received.
DescriptionMarkdown This property is required. string
Gets or sets the connector description in markdown format.
GraphQueries This property is required. []GraphQueryResponse
Gets or sets the graph queries to show the current data volume over time.
InstructionSteps This property is required. []InstructionStepResponse
Gets or sets the instruction steps to enable the connector.
Permissions This property is required. ConnectorDefinitionsPermissionsResponse
The required Permissions for the connector.
Publisher This property is required. string
Gets or sets the connector publisher name.
SampleQueries This property is required. []SampleQueryResponse
Gets or sets the sample queries for the connector.
Title This property is required. string
Gets or sets the connector blade title.
Availability ConnectorDefinitionsAvailabilityResponse
The exposure status of the connector to the customers.
GraphQueriesTableName string
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
Id string
Gets or sets custom connector id. optional field.
IsConnectivityCriteriasMatchSome bool
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
Logo string
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.
connectivityCriteria This property is required. List<ConnectivityCriterionResponse>
Gets or sets the way the connector checks whether the connector is connected.
dataTypes This property is required. List<ConnectorDataTypeResponse>
Gets or sets the data types to check for last data received.
descriptionMarkdown This property is required. String
Gets or sets the connector description in markdown format.
graphQueries This property is required. List<GraphQueryResponse>
Gets or sets the graph queries to show the current data volume over time.
instructionSteps This property is required. List<InstructionStepResponse>
Gets or sets the instruction steps to enable the connector.
permissions This property is required. ConnectorDefinitionsPermissionsResponse
The required Permissions for the connector.
publisher This property is required. String
Gets or sets the connector publisher name.
sampleQueries This property is required. List<SampleQueryResponse>
Gets or sets the sample queries for the connector.
title This property is required. String
Gets or sets the connector blade title.
availability ConnectorDefinitionsAvailabilityResponse
The exposure status of the connector to the customers.
graphQueriesTableName String
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
id String
Gets or sets custom connector id. optional field.
isConnectivityCriteriasMatchSome Boolean
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
logo String
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.
connectivityCriteria This property is required. ConnectivityCriterionResponse[]
Gets or sets the way the connector checks whether the connector is connected.
dataTypes This property is required. ConnectorDataTypeResponse[]
Gets or sets the data types to check for last data received.
descriptionMarkdown This property is required. string
Gets or sets the connector description in markdown format.
graphQueries This property is required. GraphQueryResponse[]
Gets or sets the graph queries to show the current data volume over time.
instructionSteps This property is required. InstructionStepResponse[]
Gets or sets the instruction steps to enable the connector.
permissions This property is required. ConnectorDefinitionsPermissionsResponse
The required Permissions for the connector.
publisher This property is required. string
Gets or sets the connector publisher name.
sampleQueries This property is required. SampleQueryResponse[]
Gets or sets the sample queries for the connector.
title This property is required. string
Gets or sets the connector blade title.
availability ConnectorDefinitionsAvailabilityResponse
The exposure status of the connector to the customers.
graphQueriesTableName string
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
id string
Gets or sets custom connector id. optional field.
isConnectivityCriteriasMatchSome boolean
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
logo string
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.
connectivity_criteria This property is required. Sequence[ConnectivityCriterionResponse]
Gets or sets the way the connector checks whether the connector is connected.
data_types This property is required. Sequence[ConnectorDataTypeResponse]
Gets or sets the data types to check for last data received.
description_markdown This property is required. str
Gets or sets the connector description in markdown format.
graph_queries This property is required. Sequence[GraphQueryResponse]
Gets or sets the graph queries to show the current data volume over time.
instruction_steps This property is required. Sequence[InstructionStepResponse]
Gets or sets the instruction steps to enable the connector.
permissions This property is required. ConnectorDefinitionsPermissionsResponse
The required Permissions for the connector.
publisher This property is required. str
Gets or sets the connector publisher name.
sample_queries This property is required. Sequence[SampleQueryResponse]
Gets or sets the sample queries for the connector.
title This property is required. str
Gets or sets the connector blade title.
availability ConnectorDefinitionsAvailabilityResponse
The exposure status of the connector to the customers.
graph_queries_table_name str
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
id str
Gets or sets custom connector id. optional field.
is_connectivity_criterias_match_some bool
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
logo str
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.
connectivityCriteria This property is required. List<Property Map>
Gets or sets the way the connector checks whether the connector is connected.
dataTypes This property is required. List<Property Map>
Gets or sets the data types to check for last data received.
descriptionMarkdown This property is required. String
Gets or sets the connector description in markdown format.
graphQueries This property is required. List<Property Map>
Gets or sets the graph queries to show the current data volume over time.
instructionSteps This property is required. List<Property Map>
Gets or sets the instruction steps to enable the connector.
permissions This property is required. Property Map
The required Permissions for the connector.
publisher This property is required. String
Gets or sets the connector publisher name.
sampleQueries This property is required. List<Property Map>
Gets or sets the sample queries for the connector.
title This property is required. String
Gets or sets the connector blade title.
availability Property Map
The exposure status of the connector to the customers.
graphQueriesTableName String
Gets or sets the name of the table the connector will insert the data to. This name can be used in other queries by specifying {{graphQueriesTableName}} placeholder in Query and LastDataReceivedQuery values.
id String
Gets or sets custom connector id. optional field.
isConnectivityCriteriasMatchSome Boolean
Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items.
logo String
Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. The logo value should be in SVG format.

GraphQueryResponse

BaseQuery This property is required. string
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
Legend This property is required. string
Gets or sets the legend for the graph.
MetricName This property is required. string
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.
BaseQuery This property is required. string
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
Legend This property is required. string
Gets or sets the legend for the graph.
MetricName This property is required. string
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.
baseQuery This property is required. String
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
legend This property is required. String
Gets or sets the legend for the graph.
metricName This property is required. String
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.
baseQuery This property is required. string
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
legend This property is required. string
Gets or sets the legend for the graph.
metricName This property is required. string
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.
base_query This property is required. str
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
legend This property is required. str
Gets or sets the legend for the graph.
metric_name This property is required. str
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.
baseQuery This property is required. String
Gets or sets the base query for the graph. The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time.
legend This property is required. String
Gets or sets the legend for the graph.
metricName This property is required. String
Gets or sets the metric name that the query is checking. For example: 'Total data receive'.

InstructionStepDetailsResponse

Parameters This property is required. object
Gets or sets the instruction type parameters settings.
Type This property is required. string
Gets or sets the instruction type name.
Parameters This property is required. interface{}
Gets or sets the instruction type parameters settings.
Type This property is required. string
Gets or sets the instruction type name.
parameters This property is required. Object
Gets or sets the instruction type parameters settings.
type This property is required. String
Gets or sets the instruction type name.
parameters This property is required. any
Gets or sets the instruction type parameters settings.
type This property is required. string
Gets or sets the instruction type name.
parameters This property is required. Any
Gets or sets the instruction type parameters settings.
type This property is required. str
Gets or sets the instruction type name.
parameters This property is required. Any
Gets or sets the instruction type parameters settings.
type This property is required. String
Gets or sets the instruction type name.

InstructionStepResponse

Description string
Gets or sets the instruction step description.
InnerSteps List<Pulumi.AzureNative.SecurityInsights.Inputs.InstructionStepResponse>
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
Instructions List<Pulumi.AzureNative.SecurityInsights.Inputs.InstructionStepDetailsResponse>
Gets or sets the instruction step details.
Title string
Gets or sets the instruction step title.
Description string
Gets or sets the instruction step description.
InnerSteps []InstructionStepResponse
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
Instructions []InstructionStepDetailsResponse
Gets or sets the instruction step details.
Title string
Gets or sets the instruction step title.
description String
Gets or sets the instruction step description.
innerSteps List<InstructionStepResponse>
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
instructions List<InstructionStepDetailsResponse>
Gets or sets the instruction step details.
title String
Gets or sets the instruction step title.
description string
Gets or sets the instruction step description.
innerSteps InstructionStepResponse[]
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
instructions InstructionStepDetailsResponse[]
Gets or sets the instruction step details.
title string
Gets or sets the instruction step title.
description str
Gets or sets the instruction step description.
inner_steps Sequence[InstructionStepResponse]
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
instructions Sequence[InstructionStepDetailsResponse]
Gets or sets the instruction step details.
title str
Gets or sets the instruction step title.
description String
Gets or sets the instruction step description.
innerSteps List<Property Map>
Gets or sets the inner instruction steps details. Foe Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2].
instructions List<Property Map>
Gets or sets the instruction step details.
title String
Gets or sets the instruction step title.

ResourceProviderRequiredPermissionsResponse

Action bool
Gets or sets a value indicating whether the permission is custom actions (POST).
Delete bool
Gets or sets a value indicating whether the permission is delete action (DELETE).
Read bool
Gets or sets a value indicating whether the permission is read action (GET).
Write bool
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).
Action bool
Gets or sets a value indicating whether the permission is custom actions (POST).
Delete bool
Gets or sets a value indicating whether the permission is delete action (DELETE).
Read bool
Gets or sets a value indicating whether the permission is read action (GET).
Write bool
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).
action Boolean
Gets or sets a value indicating whether the permission is custom actions (POST).
delete Boolean
Gets or sets a value indicating whether the permission is delete action (DELETE).
read Boolean
Gets or sets a value indicating whether the permission is read action (GET).
write Boolean
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).
action boolean
Gets or sets a value indicating whether the permission is custom actions (POST).
delete boolean
Gets or sets a value indicating whether the permission is delete action (DELETE).
read boolean
Gets or sets a value indicating whether the permission is read action (GET).
write boolean
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).
action bool
Gets or sets a value indicating whether the permission is custom actions (POST).
delete bool
Gets or sets a value indicating whether the permission is delete action (DELETE).
read bool
Gets or sets a value indicating whether the permission is read action (GET).
write bool
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).
action Boolean
Gets or sets a value indicating whether the permission is custom actions (POST).
delete Boolean
Gets or sets a value indicating whether the permission is delete action (DELETE).
read Boolean
Gets or sets a value indicating whether the permission is read action (GET).
write Boolean
Gets or sets a value indicating whether the permission is write action (PUT or PATCH).

SampleQueryResponse

Description This property is required. string
Gets or sets the sample query description.
Query This property is required. string
Gets or sets the KQL sample query.
Description This property is required. string
Gets or sets the sample query description.
Query This property is required. string
Gets or sets the KQL sample query.
description This property is required. String
Gets or sets the sample query description.
query This property is required. String
Gets or sets the KQL sample query.
description This property is required. string
Gets or sets the sample query description.
query This property is required. string
Gets or sets the KQL sample query.
description This property is required. str
Gets or sets the sample query description.
query This property is required. str
Gets or sets the KQL sample query.
description This property is required. String
Gets or sets the sample query description.
query This property is required. String
Gets or sets the KQL sample query.

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi