Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. securityinsights
  5. getBusinessApplicationAgent
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
pulumi/pulumi-azure-native

azure-native-v2.securityinsights.getBusinessApplicationAgent

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
pulumi/pulumi-azure-native

Gets Business Application Agent. Azure REST API version: 2024-04-01-preview.

Other available API versions: 2024-10-01-preview.

Using getBusinessApplicationAgent

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 getBusinessApplicationAgent(args: GetBusinessApplicationAgentArgs, opts?: InvokeOptions): Promise<GetBusinessApplicationAgentResult>
function getBusinessApplicationAgentOutput(args: GetBusinessApplicationAgentOutputArgs, opts?: InvokeOptions): Output<GetBusinessApplicationAgentResult>
Copy
def get_business_application_agent(agent_resource_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   workspace_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetBusinessApplicationAgentResult
def get_business_application_agent_output(agent_resource_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[GetBusinessApplicationAgentResult]
Copy
func LookupBusinessApplicationAgent(ctx *Context, args *LookupBusinessApplicationAgentArgs, opts ...InvokeOption) (*LookupBusinessApplicationAgentResult, error)
func LookupBusinessApplicationAgentOutput(ctx *Context, args *LookupBusinessApplicationAgentOutputArgs, opts ...InvokeOption) LookupBusinessApplicationAgentResultOutput
Copy

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

public static class GetBusinessApplicationAgent 
{
    public static Task<GetBusinessApplicationAgentResult> InvokeAsync(GetBusinessApplicationAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetBusinessApplicationAgentResult> Invoke(GetBusinessApplicationAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBusinessApplicationAgentResult> getBusinessApplicationAgent(GetBusinessApplicationAgentArgs args, InvokeOptions options)
public static Output<GetBusinessApplicationAgentResult> getBusinessApplicationAgent(GetBusinessApplicationAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getBusinessApplicationAgent
  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.
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.
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.
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.
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.
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.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getBusinessApplicationAgent Result

The following output properties are available:

AgentSystems List<Pulumi.AzureNative.SecurityInsights.Outputs.AgentSystemResponse>
Configuration Pulumi.AzureNative.SecurityInsights.Outputs.SapAgentConfigurationResponse
Describes the configuration of a Business Application Agent.
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
AgentSystems []AgentSystemResponse
Configuration SapAgentConfigurationResponse
Describes the configuration of a Business Application Agent.
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
agentSystems List<AgentSystemResponse>
configuration SapAgentConfigurationResponse
Describes the configuration of a Business Application Agent.
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
agentSystems AgentSystemResponse[]
configuration SapAgentConfigurationResponse
Describes the configuration of a Business Application Agent.
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
agent_systems Sequence[AgentSystemResponse]
configuration SapAgentConfigurationResponse
Describes the configuration of a Business Application Agent.
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
agentSystems List<Property Map>
configuration Property Map
Describes the configuration of a Business Application Agent.
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

Supporting Types

AgentSystemResponse

SapAgentConfigurationResponse

AgentContainerName string
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
KeyVaultAuthenticationMode string
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
KeyVaultResourceId string
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
SdkPath string
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
SecretSource string
The secret source of the agent. AzureKeyVault is the option
SncPath string
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
AgentContainerName string
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
KeyVaultAuthenticationMode string
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
KeyVaultResourceId string
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
SdkPath string
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
SecretSource string
The secret source of the agent. AzureKeyVault is the option
SncPath string
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
agentContainerName String
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
keyVaultAuthenticationMode String
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
keyVaultResourceId String
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
sdkPath String
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
secretSource String
The secret source of the agent. AzureKeyVault is the option
sncPath String
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
agentContainerName string
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
keyVaultAuthenticationMode string
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
keyVaultResourceId string
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
sdkPath string
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
secretSource string
The secret source of the agent. AzureKeyVault is the option
sncPath string
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
agent_container_name str
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
key_vault_authentication_mode str
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
key_vault_resource_id str
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
sdk_path str
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
secret_source str
The secret source of the agent. AzureKeyVault is the option
snc_path str
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
agentContainerName String
The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
keyVaultAuthenticationMode String
The key mode of the agent. ManagedIdentity|ApplicationIdentity are the options
keyVaultResourceId String
The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
sdkPath String
The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
secretSource String
The secret source of the agent. AzureKeyVault is the option
sncPath String
The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"

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
pulumi/pulumi-azure-native