Interface Webhooks
public interface Webhooks
Resource collection API of Webhooks.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Webhook resource.void
Delete the webhook by name.void
deleteById
(String id) Delete the webhook by name.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete the webhook by name.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String automationAccountName, String webhookName, com.azure.core.util.Context context) Delete the webhook by name.generateUri
(String resourceGroupName, String automationAccountName) Generates a Uri for use in creating a webhook.com.azure.core.http.rest.Response<String>
generateUriWithResponse
(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Generates a Uri for use in creating a webhook.Retrieve the webhook identified by webhook name.Retrieve the webhook identified by webhook name.com.azure.core.http.rest.Response<Webhook>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Retrieve the webhook identified by webhook name.com.azure.core.http.rest.Response<Webhook>
getWithResponse
(String resourceGroupName, String automationAccountName, String webhookName, com.azure.core.util.Context context) Retrieve the webhook identified by webhook name.com.azure.core.http.rest.PagedIterable<Webhook>
listByAutomationAccount
(String resourceGroupName, String automationAccountName) Retrieve a list of webhooks.com.azure.core.http.rest.PagedIterable<Webhook>
listByAutomationAccount
(String resourceGroupName, String automationAccountName, String filter, com.azure.core.util.Context context) Retrieve a list of webhooks.
-
Method Details
-
generateUri
Generates a Uri for use in creating a webhook.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.- Returns:
- the response.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
generateUriWithResponse
com.azure.core.http.rest.Response<String> generateUriWithResponse(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Generates a Uri for use in creating a webhook.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.context
- The context to associate with this operation.- Returns:
- the response body along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Delete the webhook by name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.webhookName
- The webhook name.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String automationAccountName, String webhookName, com.azure.core.util.Context context) Delete the webhook by name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.webhookName
- The webhook name.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
get
Retrieve the webhook identified by webhook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.webhookName
- The webhook name.- Returns:
- definition of the webhook type.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getWithResponse
com.azure.core.http.rest.Response<Webhook> getWithResponse(String resourceGroupName, String automationAccountName, String webhookName, com.azure.core.util.Context context) Retrieve the webhook identified by webhook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.webhookName
- The webhook name.context
- The context to associate with this operation.- Returns:
- definition of the webhook type along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<Webhook> listByAutomationAccount(String resourceGroupName, String automationAccountName) Retrieve a list of webhooks.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.- Returns:
- the response model for the list webhook operation as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<Webhook> listByAutomationAccount(String resourceGroupName, String automationAccountName, String filter, com.azure.core.util.Context context) Retrieve a list of webhooks.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.filter
- The filter to apply on the operation.context
- The context to associate with this operation.- Returns:
- the response model for the list webhook operation as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
Retrieve the webhook identified by webhook name.- Parameters:
id
- the resource ID.- Returns:
- definition of the webhook type along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByIdWithResponse
com.azure.core.http.rest.Response<Webhook> getByIdWithResponse(String id, com.azure.core.util.Context context) Retrieve the webhook identified by webhook name.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- definition of the webhook type along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
Delete the webhook by name.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context) Delete the webhook by name.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
define
Begins definition for a new Webhook resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Webhook definition.
-