@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWebhook(args: GetWebhookArgs, opts?: pulumi.InvokeOptions): Promise<GetWebhookResult>;
export interface GetWebhookArgs {
/**
* The name of the automation account.
*/
automationAccountName: string;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: string;
/**
* The webhook name.
*/
webhookName: string;
}
/**
* Definition of the webhook type.
*/
export interface GetWebhookResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Gets or sets the creation time.
*/
readonly creationTime?: string;
/**
* Gets or sets the description.
*/
readonly description?: string;
/**
* Gets or sets the expiry time.
*/
readonly expiryTime?: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* Gets or sets the value of the enabled flag of the webhook.
*/
readonly isEnabled?: boolean;
/**
* Gets or sets the last invoked time.
*/
readonly lastInvokedTime?: string;
/**
* Details of the user who last modified the Webhook
*/
readonly lastModifiedBy?: string;
/**
* Gets or sets the last modified time.
*/
readonly lastModifiedTime?: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
*/
readonly parameters?: {
[key: string]: string;
};
/**
* Gets or sets the name of the hybrid worker group the webhook job will run on.
*/
readonly runOn?: string;
/**
* Gets or sets the runbook the webhook is associated with.
*/
readonly runbook?: outputs.automation.RunbookAssociationPropertyResponse;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.automation.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Gets or sets the webhook uri.
*/
readonly uri?: string;
}
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWebhookOutput(args: GetWebhookOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWebhookResult>;
export interface GetWebhookOutputArgs {
/**
* The name of the automation account.
*/
automationAccountName: pulumi.Input<string>;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The webhook name.
*/
webhookName: pulumi.Input<string>;
}