WebhookAuthenticationSettings Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.WebhookAuthenticationSettings

Implements

JsonSerializable<WebhookAuthenticationSettings>

public final class WebhookAuthenticationSettings
implements JsonSerializable<WebhookAuthenticationSettings>

Authentication settings for a webhook endpoint within a Namespace resource.

Constructor Summary

Constructor	Description
WebhookAuthenticationSettings()	Creates an instance of WebhookAuthenticationSettings class.

Method Summary

Modifier and Type	Method and Description
String	azureActiveDirectoryApplicationIdOrUri() Get the azureActiveDirectoryApplicationIdOrUri property: Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
String	azureActiveDirectoryTenantId() Get the azureActiveDirectoryTenantId property: Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.
String	endpointBaseUrl() Get the endpointBaseUrl property: The base URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.
String	endpointUrl() Get the endpointUrl property: The URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.
static WebhookAuthenticationSettings	fromJson(JsonReader jsonReader) Reads an instance of WebhookAuthenticationSettings from the JsonReader.
CustomWebhookAuthenticationManagedIdentity	identity() Get the identity property: The identity configuration required for authenticating a custom webhook.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
WebhookAuthenticationSettings	withAzureActiveDirectoryApplicationIdOrUri(String azureActiveDirectoryApplicationIdOrUri) Set the azureActiveDirectoryApplicationIdOrUri property: Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
WebhookAuthenticationSettings	withAzureActiveDirectoryTenantId(String azureActiveDirectoryTenantId) Set the azureActiveDirectoryTenantId property: Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.
WebhookAuthenticationSettings	withEndpointBaseUrl(String endpointBaseUrl) Set the endpointBaseUrl property: The base URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.
WebhookAuthenticationSettings	withEndpointUrl(String endpointUrl) Set the endpointUrl property: The URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.
WebhookAuthenticationSettings	withIdentity(CustomWebhookAuthenticationManagedIdentity identity) Set the identity property: The identity configuration required for authenticating a custom webhook.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

WebhookAuthenticationSettings

public WebhookAuthenticationSettings()

Creates an instance of WebhookAuthenticationSettings class.

Method Details

azureActiveDirectoryApplicationIdOrUri

public String azureActiveDirectoryApplicationIdOrUri()

Get the azureActiveDirectoryApplicationIdOrUri property: Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

Returns:

the azureActiveDirectoryApplicationIdOrUri value.

azureActiveDirectoryTenantId

public String azureActiveDirectoryTenantId()

Get the azureActiveDirectoryTenantId property: Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.

Returns:

the azureActiveDirectoryTenantId value.

endpointBaseUrl

public String endpointBaseUrl()

Get the endpointBaseUrl property: The base URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.

Returns:

the endpointBaseUrl value.

endpointUrl

public String endpointUrl()

Get the endpointUrl property: The URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.

Returns:

the endpointUrl value.

fromJson

public static WebhookAuthenticationSettings fromJson(JsonReader jsonReader)

Reads an instance of WebhookAuthenticationSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebhookAuthenticationSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

identity

public CustomWebhookAuthenticationManagedIdentity identity()

Get the identity property: The identity configuration required for authenticating a custom webhook.

Returns:

the identity value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAzureActiveDirectoryApplicationIdOrUri

public WebhookAuthenticationSettings withAzureActiveDirectoryApplicationIdOrUri(String azureActiveDirectoryApplicationIdOrUri)

Set the azureActiveDirectoryApplicationIdOrUri property: Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

Parameters:

azureActiveDirectoryApplicationIdOrUri - the azureActiveDirectoryApplicationIdOrUri value to set.

Returns:

the WebhookAuthenticationSettings object itself.

withAzureActiveDirectoryTenantId

public WebhookAuthenticationSettings withAzureActiveDirectoryTenantId(String azureActiveDirectoryTenantId)

Set the azureActiveDirectoryTenantId property: Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.

Parameters:

azureActiveDirectoryTenantId - the azureActiveDirectoryTenantId value to set.

Returns:

the WebhookAuthenticationSettings object itself.

withEndpointBaseUrl

public WebhookAuthenticationSettings withEndpointBaseUrl(String endpointBaseUrl)

Set the endpointBaseUrl property: The base URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.

Parameters:

endpointBaseUrl - the endpointBaseUrl value to set.

Returns:

the WebhookAuthenticationSettings object itself.

withEndpointUrl

public WebhookAuthenticationSettings withEndpointUrl(String endpointUrl)

Set the endpointUrl property: The URL endpoint where the Event Grid service sends authenticated webhook requests using the specified managed identity.

Parameters:

endpointUrl - the endpointUrl value to set.

Returns:

the WebhookAuthenticationSettings object itself.

withIdentity

public WebhookAuthenticationSettings withIdentity(CustomWebhookAuthenticationManagedIdentity identity)

Set the identity property: The identity configuration required for authenticating a custom webhook.

Parameters:

identity - the identity value to set.

Returns:

the WebhookAuthenticationSettings object itself.