1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. getSystem
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.getSystem

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 the system.

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

Other available API versions: 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 getSystem

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 getSystem(args: GetSystemArgs, opts?: InvokeOptions): Promise<GetSystemResult>
function getSystemOutput(args: GetSystemOutputArgs, opts?: InvokeOptions): Output<GetSystemResult>
Copy
def get_system(agent_resource_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               system_resource_name: Optional[str] = None,
               workspace_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSystemResult
def get_system_output(agent_resource_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               system_resource_name: Optional[pulumi.Input[str]] = None,
               workspace_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSystemResult]
Copy
func LookupSystem(ctx *Context, args *LookupSystemArgs, opts ...InvokeOption) (*LookupSystemResult, error)
func LookupSystemOutput(ctx *Context, args *LookupSystemOutputArgs, opts ...InvokeOption) LookupSystemResultOutput
Copy

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

public static class GetSystem 
{
    public static Task<GetSystemResult> InvokeAsync(GetSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetSystemResult> Invoke(GetSystemInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSystemResult> getSystem(GetSystemArgs args, InvokeOptions options)
public static Output<GetSystemResult> getSystem(GetSystemArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getSystem
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgentResourceName
This property is required.
Changes to this property will trigger replacement.
string
Business Application Agent 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.
SystemResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the system.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AgentResourceName
This property is required.
Changes to this property will trigger replacement.
string
Business Application Agent 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.
SystemResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the system.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
agentResourceName
This property is required.
Changes to this property will trigger replacement.
String
Business Application Agent 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.
systemResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the system.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
agentResourceName
This property is required.
Changes to this property will trigger replacement.
string
Business Application Agent 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.
systemResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the system.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
agent_resource_name
This property is required.
Changes to this property will trigger replacement.
str
Business Application Agent 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.
system_resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the system.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
agentResourceName
This property is required.
Changes to this property will trigger replacement.
String
Business Application Agent 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.
systemResourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the system.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getSystem Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Configuration Pulumi.AzureNative.SecurityInsights.Outputs.SapSystemsConfigurationResponse
The configuration of the system.
DisplayName string
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastModifiedTimeUtc string
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
Status string
The status of the system.
AzureApiVersion string
The Azure API version of the resource.
Configuration SapSystemsConfigurationResponse
The configuration of the system.
DisplayName string
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastModifiedTimeUtc string
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
Status string
The status of the system.
azureApiVersion String
The Azure API version of the resource.
configuration SapSystemsConfigurationResponse
The configuration of the system.
displayName String
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedTimeUtc String
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
status String
The status of the system.
azureApiVersion string
The Azure API version of the resource.
configuration SapSystemsConfigurationResponse
The configuration of the system.
displayName string
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedTimeUtc string
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
status string
The status of the system.
azure_api_version str
The Azure API version of the resource.
configuration SapSystemsConfigurationResponse
The configuration of the system.
display_name str
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
last_modified_time_utc str
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
status str
The status of the system.
azureApiVersion String
The Azure API version of the resource.
configuration Property Map
The configuration of the system.
displayName String
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedTimeUtc String
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
status String
The status of the system.

Supporting Types

LogResponse

Type This property is required. string
Types of logs and tables.
BulkSize int
The bulk size for the log.
Filters List<string>
The filters for the log.
IngestionType string
Types of ingestion.
ScheduleInterval int
The schedule interval in seconds.
Status string
Types of log status.
Type This property is required. string
Types of logs and tables.
BulkSize int
The bulk size for the log.
Filters []string
The filters for the log.
IngestionType string
Types of ingestion.
ScheduleInterval int
The schedule interval in seconds.
Status string
Types of log status.
type This property is required. String
Types of logs and tables.
bulkSize Integer
The bulk size for the log.
filters List<String>
The filters for the log.
ingestionType String
Types of ingestion.
scheduleInterval Integer
The schedule interval in seconds.
status String
Types of log status.
type This property is required. string
Types of logs and tables.
bulkSize number
The bulk size for the log.
filters string[]
The filters for the log.
ingestionType string
Types of ingestion.
scheduleInterval number
The schedule interval in seconds.
status string
Types of log status.
type This property is required. str
Types of logs and tables.
bulk_size int
The bulk size for the log.
filters Sequence[str]
The filters for the log.
ingestion_type str
Types of ingestion.
schedule_interval int
The schedule interval in seconds.
status str
Types of log status.
type This property is required. String
Types of logs and tables.
bulkSize Number
The bulk size for the log.
filters List<String>
The filters for the log.
ingestionType String
Types of ingestion.
scheduleInterval Number
The schedule interval in seconds.
status String
Types of log status.

RfcConnectorResponse

Client This property is required. string
Client number of the ABAP server. Example - 001
SystemId This property is required. string
System ID of the ABAP server. Example - A4H
SystemNumber This property is required. string
System number of the ABAP server.
AbapServerHost string
FQDN, hostname, or IP address of the ABAP server.
AuthenticationType string
The authentication type to SAP.
CodePage string
The SAP code page used for character encoding. Example - 1100
Group string
Logon group of the message server.
MessageServerHost string
FQDN, hostname, or IP address of the Message server.
MessageServerService string
Port number, or service name (from /etc/services) of the message server.
SncQop string
SNC QOP. Options are 1, 2, 3, 8, 9.
Client This property is required. string
Client number of the ABAP server. Example - 001
SystemId This property is required. string
System ID of the ABAP server. Example - A4H
SystemNumber This property is required. string
System number of the ABAP server.
AbapServerHost string
FQDN, hostname, or IP address of the ABAP server.
AuthenticationType string
The authentication type to SAP.
CodePage string
The SAP code page used for character encoding. Example - 1100
Group string
Logon group of the message server.
MessageServerHost string
FQDN, hostname, or IP address of the Message server.
MessageServerService string
Port number, or service name (from /etc/services) of the message server.
SncQop string
SNC QOP. Options are 1, 2, 3, 8, 9.
client This property is required. String
Client number of the ABAP server. Example - 001
systemId This property is required. String
System ID of the ABAP server. Example - A4H
systemNumber This property is required. String
System number of the ABAP server.
abapServerHost String
FQDN, hostname, or IP address of the ABAP server.
authenticationType String
The authentication type to SAP.
codePage String
The SAP code page used for character encoding. Example - 1100
group String
Logon group of the message server.
messageServerHost String
FQDN, hostname, or IP address of the Message server.
messageServerService String
Port number, or service name (from /etc/services) of the message server.
sncQop String
SNC QOP. Options are 1, 2, 3, 8, 9.
client This property is required. string
Client number of the ABAP server. Example - 001
systemId This property is required. string
System ID of the ABAP server. Example - A4H
systemNumber This property is required. string
System number of the ABAP server.
abapServerHost string
FQDN, hostname, or IP address of the ABAP server.
authenticationType string
The authentication type to SAP.
codePage string
The SAP code page used for character encoding. Example - 1100
group string
Logon group of the message server.
messageServerHost string
FQDN, hostname, or IP address of the Message server.
messageServerService string
Port number, or service name (from /etc/services) of the message server.
sncQop string
SNC QOP. Options are 1, 2, 3, 8, 9.
client This property is required. str
Client number of the ABAP server. Example - 001
system_id This property is required. str
System ID of the ABAP server. Example - A4H
system_number This property is required. str
System number of the ABAP server.
abap_server_host str
FQDN, hostname, or IP address of the ABAP server.
authentication_type str
The authentication type to SAP.
code_page str
The SAP code page used for character encoding. Example - 1100
group str
Logon group of the message server.
message_server_host str
FQDN, hostname, or IP address of the Message server.
message_server_service str
Port number, or service name (from /etc/services) of the message server.
snc_qop str
SNC QOP. Options are 1, 2, 3, 8, 9.
client This property is required. String
Client number of the ABAP server. Example - 001
systemId This property is required. String
System ID of the ABAP server. Example - A4H
systemNumber This property is required. String
System number of the ABAP server.
abapServerHost String
FQDN, hostname, or IP address of the ABAP server.
authenticationType String
The authentication type to SAP.
codePage String
The SAP code page used for character encoding. Example - 1100
group String
Logon group of the message server.
messageServerHost String
FQDN, hostname, or IP address of the Message server.
messageServerService String
Port number, or service name (from /etc/services) of the message server.
sncQop String
SNC QOP. Options are 1, 2, 3, 8, 9.

SapControlConnectorResponse

Instance This property is required. string
The instance number. Only 2 digits are allowed.
Server This property is required. string
The server name. FQDN or IP address.
HttpsConfiguration string
Represents the types of HTTPS configuration to connect to the SapControl service.
Port string
The port of the SOAP connection to SAP Control.
Timezone string
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
Instance This property is required. string
The instance number. Only 2 digits are allowed.
Server This property is required. string
The server name. FQDN or IP address.
HttpsConfiguration string
Represents the types of HTTPS configuration to connect to the SapControl service.
Port string
The port of the SOAP connection to SAP Control.
Timezone string
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
instance This property is required. String
The instance number. Only 2 digits are allowed.
server This property is required. String
The server name. FQDN or IP address.
httpsConfiguration String
Represents the types of HTTPS configuration to connect to the SapControl service.
port String
The port of the SOAP connection to SAP Control.
timezone String
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
instance This property is required. string
The instance number. Only 2 digits are allowed.
server This property is required. string
The server name. FQDN or IP address.
httpsConfiguration string
Represents the types of HTTPS configuration to connect to the SapControl service.
port string
The port of the SOAP connection to SAP Control.
timezone string
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
instance This property is required. str
The instance number. Only 2 digits are allowed.
server This property is required. str
The server name. FQDN or IP address.
https_configuration str
Represents the types of HTTPS configuration to connect to the SapControl service.
port str
The port of the SOAP connection to SAP Control.
timezone str
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
instance This property is required. String
The instance number. Only 2 digits are allowed.
server This property is required. String
The server name. FQDN or IP address.
httpsConfiguration String
Represents the types of HTTPS configuration to connect to the SapControl service.
port String
The port of the SOAP connection to SAP Control.
timezone String
The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"

SapSystemsConfigurationResponse

Connector This property is required. Pulumi.AzureNative.SecurityInsights.Inputs.RfcConnectorResponse | Pulumi.AzureNative.SecurityInsights.Inputs.SapControlConnectorResponse
Base Model for SAP System Connector.
AzureResourceId string
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
Logs List<Pulumi.AzureNative.SecurityInsights.Inputs.LogResponse>
The logs configuration.
Connector This property is required. RfcConnectorResponse | SapControlConnectorResponse
Base Model for SAP System Connector.
AzureResourceId string
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
Logs []LogResponse
The logs configuration.
connector This property is required. RfcConnectorResponse | SapControlConnectorResponse
Base Model for SAP System Connector.
azureResourceId String
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
logs List<LogResponse>
The logs configuration.
connector This property is required. RfcConnectorResponse | SapControlConnectorResponse
Base Model for SAP System Connector.
azureResourceId string
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
logs LogResponse[]
The logs configuration.
connector This property is required. RfcConnectorResponse | SapControlConnectorResponse
Base Model for SAP System Connector.
azure_resource_id str
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
logs Sequence[LogResponse]
The logs configuration.
connector This property is required. Property Map | Property Map
Base Model for SAP System Connector.
azureResourceId String
azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
logs List<Property Map>
The logs configuration.

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 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