AzureUserSecurityContext Class
- java.
lang. Object - com.
azure. ai. agents. models. AzureUserSecurityContext
- com.
Implements
public final class AzureUserSecurityContext
implements JsonSerializable<AzureUserSecurityContext>
User security context contains several parameters that describe the application itself, and the end user that interacts with the application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a comprehensive approach to protecting your AI applications. [Learn more](https://aka.ms/TP4AI/Documentation/EndUserContext) about protecting AI applications using Microsoft Defender for Cloud.
Constructor Summary
| Constructor | Description |
|---|---|
| AzureUserSecurityContext() |
Creates an instance of Azure |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Azure |
fromJson(JsonReader jsonReader)
Reads an instance of Azure |
| String |
getApplicationName()
Get the application |
| String |
getEndUserId()
Get the end |
| String |
getEndUserTenantId()
Get the end |
| String |
getSourceIp()
Get the source |
|
Azure |
setApplicationName(String applicationName)
Set the application |
|
Azure |
setEndUserId(String endUserId)
Set the end |
|
Azure |
setEndUserTenantId(String endUserTenantId)
Set the end |
|
Azure |
setSourceIp(String sourceIp)
Set the source |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Constructor Details
AzureUserSecurityContext
public AzureUserSecurityContext()
Creates an instance of AzureUserSecurityContext class.
Method Details
fromJson
public static AzureUserSecurityContext fromJson(JsonReader jsonReader)
Reads an instance of AzureUserSecurityContext from the JsonReader.
Parameters:
Returns:
Throws:
getApplicationName
public String getApplicationName()
Get the applicationName property: The name of the application. Sensitive personal information should not be included in this field.
Returns:
getEndUserId
public String getEndUserId()
Get the endUserId property: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field.
Returns:
getEndUserTenantId
public String getEndUserTenantId()
Get the endUserTenantId property: The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multitenant.
Returns:
getSourceIp
public String getSourceIp()
Get the sourceIp property: Captures the original client's IP address.
Returns:
setApplicationName
public AzureUserSecurityContext setApplicationName(String applicationName)
Set the applicationName property: The name of the application. Sensitive personal information should not be included in this field.
Parameters:
Returns:
setEndUserId
public AzureUserSecurityContext setEndUserId(String endUserId)
Set the endUserId property: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field.
Parameters:
Returns:
setEndUserTenantId
public AzureUserSecurityContext setEndUserTenantId(String endUserTenantId)
Set the endUserTenantId property: The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multitenant.
Parameters:
Returns:
setSourceIp
public AzureUserSecurityContext setSourceIp(String sourceIp)
Set the sourceIp property: Captures the original client's IP address.
Parameters:
Returns: