1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. getFileImport
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.securityinsights.getFileImport

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets a file import.

Uses Azure REST API version 2025-01-01-preview.

Other available API versions: 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-12-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]. See the version guide for details.

Using getFileImport

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 getFileImport(args: GetFileImportArgs, opts?: InvokeOptions): Promise<GetFileImportResult>
function getFileImportOutput(args: GetFileImportOutputArgs, opts?: InvokeOptions): Output<GetFileImportResult>
Copy
def get_file_import(file_import_id: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    workspace_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFileImportResult
def get_file_import_output(file_import_id: 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[GetFileImportResult]
Copy
func LookupFileImport(ctx *Context, args *LookupFileImportArgs, opts ...InvokeOption) (*LookupFileImportResult, error)
func LookupFileImportOutput(ctx *Context, args *LookupFileImportOutputArgs, opts ...InvokeOption) LookupFileImportResultOutput
Copy

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

public static class GetFileImport 
{
    public static Task<GetFileImportResult> InvokeAsync(GetFileImportArgs args, InvokeOptions? opts = null)
    public static Output<GetFileImportResult> Invoke(GetFileImportInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFileImportResult> getFileImport(GetFileImportArgs args, InvokeOptions options)
public static Output<GetFileImportResult> getFileImport(GetFileImportArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getFileImport
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FileImportId
This property is required.
Changes to this property will trigger replacement.
string
File import ID
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.
FileImportId
This property is required.
Changes to this property will trigger replacement.
string
File import ID
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.
fileImportId
This property is required.
Changes to this property will trigger replacement.
String
File import ID
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.
fileImportId
This property is required.
Changes to this property will trigger replacement.
string
File import ID
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.
file_import_id
This property is required.
Changes to this property will trigger replacement.
str
File import ID
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.
fileImportId
This property is required.
Changes to this property will trigger replacement.
String
File import ID
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.

getFileImport Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ContentType string
The content type of this file.
CreatedTimeUTC string
The time the file was imported.
ErrorFile Pulumi.AzureNative.SecurityInsights.Outputs.FileMetadataResponse
Represents the error file (if the import was ingested with errors or failed the validation).
ErrorsPreview List<Pulumi.AzureNative.SecurityInsights.Outputs.ValidationErrorResponse>
An ordered list of some of the errors that were encountered during validation.
FilesValidUntilTimeUTC string
The time the files associated with this import are deleted from the storage account.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ImportFile Pulumi.AzureNative.SecurityInsights.Outputs.FileMetadataResponse
Represents the imported file.
ImportValidUntilTimeUTC string
The time the file import record is soft deleted from the database and history.
IngestedRecordCount int
The number of records that have been successfully ingested.
IngestionMode string
Describes how to ingest the records in the file.
Name string
The name of the resource
Source string
The source for the data in the file.
State string
The state of the file import.
SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TotalRecordCount int
The number of records in the file.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ValidRecordCount int
The number of records that have passed validation.
AzureApiVersion string
The Azure API version of the resource.
ContentType string
The content type of this file.
CreatedTimeUTC string
The time the file was imported.
ErrorFile FileMetadataResponse
Represents the error file (if the import was ingested with errors or failed the validation).
ErrorsPreview []ValidationErrorResponse
An ordered list of some of the errors that were encountered during validation.
FilesValidUntilTimeUTC string
The time the files associated with this import are deleted from the storage account.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ImportFile FileMetadataResponse
Represents the imported file.
ImportValidUntilTimeUTC string
The time the file import record is soft deleted from the database and history.
IngestedRecordCount int
The number of records that have been successfully ingested.
IngestionMode string
Describes how to ingest the records in the file.
Name string
The name of the resource
Source string
The source for the data in the file.
State string
The state of the file import.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TotalRecordCount int
The number of records in the file.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ValidRecordCount int
The number of records that have passed validation.
azureApiVersion String
The Azure API version of the resource.
contentType String
The content type of this file.
createdTimeUTC String
The time the file was imported.
errorFile FileMetadataResponse
Represents the error file (if the import was ingested with errors or failed the validation).
errorsPreview List<ValidationErrorResponse>
An ordered list of some of the errors that were encountered during validation.
filesValidUntilTimeUTC String
The time the files associated with this import are deleted from the storage account.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
importFile FileMetadataResponse
Represents the imported file.
importValidUntilTimeUTC String
The time the file import record is soft deleted from the database and history.
ingestedRecordCount Integer
The number of records that have been successfully ingested.
ingestionMode String
Describes how to ingest the records in the file.
name String
The name of the resource
source String
The source for the data in the file.
state String
The state of the file import.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalRecordCount Integer
The number of records in the file.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
validRecordCount Integer
The number of records that have passed validation.
azureApiVersion string
The Azure API version of the resource.
contentType string
The content type of this file.
createdTimeUTC string
The time the file was imported.
errorFile FileMetadataResponse
Represents the error file (if the import was ingested with errors or failed the validation).
errorsPreview ValidationErrorResponse[]
An ordered list of some of the errors that were encountered during validation.
filesValidUntilTimeUTC string
The time the files associated with this import are deleted from the storage account.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
importFile FileMetadataResponse
Represents the imported file.
importValidUntilTimeUTC string
The time the file import record is soft deleted from the database and history.
ingestedRecordCount number
The number of records that have been successfully ingested.
ingestionMode string
Describes how to ingest the records in the file.
name string
The name of the resource
source string
The source for the data in the file.
state string
The state of the file import.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalRecordCount number
The number of records in the file.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
validRecordCount number
The number of records that have passed validation.
azure_api_version str
The Azure API version of the resource.
content_type str
The content type of this file.
created_time_utc str
The time the file was imported.
error_file FileMetadataResponse
Represents the error file (if the import was ingested with errors or failed the validation).
errors_preview Sequence[ValidationErrorResponse]
An ordered list of some of the errors that were encountered during validation.
files_valid_until_time_utc str
The time the files associated with this import are deleted from the storage account.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
import_file FileMetadataResponse
Represents the imported file.
import_valid_until_time_utc str
The time the file import record is soft deleted from the database and history.
ingested_record_count int
The number of records that have been successfully ingested.
ingestion_mode str
Describes how to ingest the records in the file.
name str
The name of the resource
source str
The source for the data in the file.
state str
The state of the file import.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
total_record_count int
The number of records in the file.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
valid_record_count int
The number of records that have passed validation.
azureApiVersion String
The Azure API version of the resource.
contentType String
The content type of this file.
createdTimeUTC String
The time the file was imported.
errorFile Property Map
Represents the error file (if the import was ingested with errors or failed the validation).
errorsPreview List<Property Map>
An ordered list of some of the errors that were encountered during validation.
filesValidUntilTimeUTC String
The time the files associated with this import are deleted from the storage account.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
importFile Property Map
Represents the imported file.
importValidUntilTimeUTC String
The time the file import record is soft deleted from the database and history.
ingestedRecordCount Number
The number of records that have been successfully ingested.
ingestionMode String
Describes how to ingest the records in the file.
name String
The name of the resource
source String
The source for the data in the file.
state String
The state of the file import.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalRecordCount Number
The number of records in the file.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
validRecordCount Number
The number of records that have passed validation.

Supporting Types

FileMetadataResponse

DeleteStatus This property is required. string
Indicates whether the file was deleted from the storage account.
FileContentUri This property is required. string
A URI with a valid SAS token to allow uploading / downloading the file.
FileFormat string
The format of the file
FileName string
The name of the file.
FileSize int
The size of the file.
DeleteStatus This property is required. string
Indicates whether the file was deleted from the storage account.
FileContentUri This property is required. string
A URI with a valid SAS token to allow uploading / downloading the file.
FileFormat string
The format of the file
FileName string
The name of the file.
FileSize int
The size of the file.
deleteStatus This property is required. String
Indicates whether the file was deleted from the storage account.
fileContentUri This property is required. String
A URI with a valid SAS token to allow uploading / downloading the file.
fileFormat String
The format of the file
fileName String
The name of the file.
fileSize Integer
The size of the file.
deleteStatus This property is required. string
Indicates whether the file was deleted from the storage account.
fileContentUri This property is required. string
A URI with a valid SAS token to allow uploading / downloading the file.
fileFormat string
The format of the file
fileName string
The name of the file.
fileSize number
The size of the file.
delete_status This property is required. str
Indicates whether the file was deleted from the storage account.
file_content_uri This property is required. str
A URI with a valid SAS token to allow uploading / downloading the file.
file_format str
The format of the file
file_name str
The name of the file.
file_size int
The size of the file.
deleteStatus This property is required. String
Indicates whether the file was deleted from the storage account.
fileContentUri This property is required. String
A URI with a valid SAS token to allow uploading / downloading the file.
fileFormat String
The format of the file
fileName String
The name of the file.
fileSize Number
The size of the file.

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.

ValidationErrorResponse

ErrorMessages This property is required. List<string>
A list of descriptions of the error.
RecordIndex int
The number of the record that has the error.
ErrorMessages This property is required. []string
A list of descriptions of the error.
RecordIndex int
The number of the record that has the error.
errorMessages This property is required. List<String>
A list of descriptions of the error.
recordIndex Integer
The number of the record that has the error.
errorMessages This property is required. string[]
A list of descriptions of the error.
recordIndex number
The number of the record that has the error.
error_messages This property is required. Sequence[str]
A list of descriptions of the error.
record_index int
The number of the record that has the error.
errorMessages This property is required. List<String>
A list of descriptions of the error.
recordIndex Number
The number of the record that has the error.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi