1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getWebhook
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.4.0 published on Wednesday, May 7, 2025 by Pulumi

azure-native.automation.getWebhook

Explore with Pulumi AI

azure-native logo
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.4.0 published on Wednesday, May 7, 2025 by Pulumi

    Retrieve the webhook identified by webhook name.

    Uses Azure REST API version 2023-05-15-preview.

    Other available API versions: 2015-10-31, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [ApiVersion]. See the version guide for details.

    Using getWebhook

    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 getWebhook(args: GetWebhookArgs, opts?: InvokeOptions): Promise<GetWebhookResult>
    function getWebhookOutput(args: GetWebhookOutputArgs, opts?: InvokeOptions): Output<GetWebhookResult>
    def get_webhook(automation_account_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    webhook_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWebhookResult
    def get_webhook_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    webhook_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWebhookResult]
    func LookupWebhook(ctx *Context, args *LookupWebhookArgs, opts ...InvokeOption) (*LookupWebhookResult, error)
    func LookupWebhookOutput(ctx *Context, args *LookupWebhookOutputArgs, opts ...InvokeOption) LookupWebhookResultOutput

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

    public static class GetWebhook 
    {
        public static Task<GetWebhookResult> InvokeAsync(GetWebhookArgs args, InvokeOptions? opts = null)
        public static Output<GetWebhookResult> Invoke(GetWebhookInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
    public static Output<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:automation:getWebhook
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    WebhookName string
    The webhook name.
    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    WebhookName string
    The webhook name.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    webhookName String
    The webhook name.
    automationAccountName string
    The name of the automation account.
    resourceGroupName string
    Name of an Azure Resource group.
    webhookName string
    The webhook name.
    automation_account_name str
    The name of the automation account.
    resource_group_name str
    Name of an Azure Resource group.
    webhook_name str
    The webhook name.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    webhookName String
    The webhook name.

    getWebhook Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Automation.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"
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    ExpiryTime string
    Gets or sets the expiry time.
    IsEnabled bool
    Gets or sets the value of the enabled flag of the webhook.
    LastInvokedTime string
    Gets or sets the last invoked time.
    LastModifiedBy string
    Details of the user who last modified the Webhook
    LastModifiedTime string
    Gets or sets the last modified time.
    Parameters Dictionary<string, string>
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    RunOn string
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    Runbook Pulumi.AzureNative.Automation.Outputs.RunbookAssociationPropertyResponse
    Gets or sets the runbook the webhook is associated with.
    Uri string
    Gets or sets the webhook uri.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    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"
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    ExpiryTime string
    Gets or sets the expiry time.
    IsEnabled bool
    Gets or sets the value of the enabled flag of the webhook.
    LastInvokedTime string
    Gets or sets the last invoked time.
    LastModifiedBy string
    Details of the user who last modified the Webhook
    LastModifiedTime string
    Gets or sets the last modified time.
    Parameters map[string]string
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    RunOn string
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    Runbook RunbookAssociationPropertyResponse
    Gets or sets the runbook the webhook is associated with.
    Uri string
    Gets or sets the webhook uri.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    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"
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    expiryTime String
    Gets or sets the expiry time.
    isEnabled Boolean
    Gets or sets the value of the enabled flag of the webhook.
    lastInvokedTime String
    Gets or sets the last invoked time.
    lastModifiedBy String
    Details of the user who last modified the Webhook
    lastModifiedTime String
    Gets or sets the last modified time.
    parameters Map<String,String>
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    runOn String
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    runbook RunbookAssociationPropertyResponse
    Gets or sets the runbook the webhook is associated with.
    uri String
    Gets or sets the webhook uri.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    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"
    creationTime string
    Gets or sets the creation time.
    description string
    Gets or sets the description.
    expiryTime string
    Gets or sets the expiry time.
    isEnabled boolean
    Gets or sets the value of the enabled flag of the webhook.
    lastInvokedTime string
    Gets or sets the last invoked time.
    lastModifiedBy string
    Details of the user who last modified the Webhook
    lastModifiedTime string
    Gets or sets the last modified time.
    parameters {[key: string]: string}
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    runOn string
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    runbook RunbookAssociationPropertyResponse
    Gets or sets the runbook the webhook is associated with.
    uri string
    Gets or sets the webhook uri.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    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"
    creation_time str
    Gets or sets the creation time.
    description str
    Gets or sets the description.
    expiry_time str
    Gets or sets the expiry time.
    is_enabled bool
    Gets or sets the value of the enabled flag of the webhook.
    last_invoked_time str
    Gets or sets the last invoked time.
    last_modified_by str
    Details of the user who last modified the Webhook
    last_modified_time str
    Gets or sets the last modified time.
    parameters Mapping[str, str]
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    run_on str
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    runbook RunbookAssociationPropertyResponse
    Gets or sets the runbook the webhook is associated with.
    uri str
    Gets or sets the webhook uri.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    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"
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    expiryTime String
    Gets or sets the expiry time.
    isEnabled Boolean
    Gets or sets the value of the enabled flag of the webhook.
    lastInvokedTime String
    Gets or sets the last invoked time.
    lastModifiedBy String
    Details of the user who last modified the Webhook
    lastModifiedTime String
    Gets or sets the last modified time.
    parameters Map<String>
    Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
    runOn String
    Gets or sets the name of the hybrid worker group the webhook job will run on.
    runbook Property Map
    Gets or sets the runbook the webhook is associated with.
    uri String
    Gets or sets the webhook uri.

    Supporting Types

    RunbookAssociationPropertyResponse

    Name string
    Gets or sets the name of the runbook.
    Name string
    Gets or sets the name of the runbook.
    name String
    Gets or sets the name of the runbook.
    name string
    Gets or sets the name of the runbook.
    name str
    Gets or sets the name of the runbook.
    name String
    Gets or sets the name of the runbook.

    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
    azure-native logo
    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.4.0 published on Wednesday, May 7, 2025 by Pulumi