Juniper Mist v0.1.1, Nov 4 24

Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

junipermist.org.Webhook

Explore with Pulumi AI

Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  webhookOne:
    type: junipermist:org:Webhook
    name: webhook_one
    properties:
      siteId: ${terraformTest.id}
      name: webhook_one
      type: http-post
      url: https://myserver.com:4321/
      verifyCert: false
      enabled: true
      topics:
        - device-events
        - alarms
        - audits
        - client-join
        - client-info
        - client-sessions
        - device-updowns
        - mxedge-events
        - nac-events
        - nac-accounting

Create Webhook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);

@overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            org_id: Optional[str] = None,
            url: Optional[str] = None,
            topics: Optional[Sequence[str]] = None,
            oauth2_token_url: Optional[str] = None,
            oauth2_client_id: Optional[str] = None,
            oauth2_grant_type: Optional[str] = None,
            oauth2_password: Optional[str] = None,
            oauth2_scopes: Optional[Sequence[str]] = None,
            enabled: Optional[bool] = None,
            oauth2_username: Optional[str] = None,
            oauth2_client_secret: Optional[str] = None,
            secret: Optional[str] = None,
            splunk_token: Optional[str] = None,
            name: Optional[str] = None,
            type: Optional[str] = None,
            headers: Optional[Mapping[str, str]] = None,
            verify_cert: Optional[bool] = None)

func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)

public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)

public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

type: junipermist:org:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args WebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WebhookArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WebhookArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WebhookArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var webhookResource = new JuniperMist.Org.Webhook("webhookResource", new()
{
    OrgId = "string",
    Url = "string",
    Topics = new[]
    {
        "string",
    },
    Oauth2TokenUrl = "string",
    Oauth2ClientId = "string",
    Oauth2GrantType = "string",
    Oauth2Password = "string",
    Oauth2Scopes = new[]
    {
        "string",
    },
    Enabled = false,
    Oauth2Username = "string",
    Oauth2ClientSecret = "string",
    Secret = "string",
    SplunkToken = "string",
    Name = "string",
    Type = "string",
    Headers = 
    {
        { "string", "string" },
    },
    VerifyCert = false,
});

example, err := org.NewWebhook(ctx, "webhookResource", &org.WebhookArgs{
	OrgId: pulumi.String("string"),
	Url:   pulumi.String("string"),
	Topics: pulumi.StringArray{
		pulumi.String("string"),
	},
	Oauth2TokenUrl:  pulumi.String("string"),
	Oauth2ClientId:  pulumi.String("string"),
	Oauth2GrantType: pulumi.String("string"),
	Oauth2Password:  pulumi.String("string"),
	Oauth2Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Enabled:            pulumi.Bool(false),
	Oauth2Username:     pulumi.String("string"),
	Oauth2ClientSecret: pulumi.String("string"),
	Secret:             pulumi.String("string"),
	SplunkToken:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	Type:               pulumi.String("string"),
	Headers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VerifyCert: pulumi.Bool(false),
})

var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .orgId("string")
    .url("string")
    .topics("string")
    .oauth2TokenUrl("string")
    .oauth2ClientId("string")
    .oauth2GrantType("string")
    .oauth2Password("string")
    .oauth2Scopes("string")
    .enabled(false)
    .oauth2Username("string")
    .oauth2ClientSecret("string")
    .secret("string")
    .splunkToken("string")
    .name("string")
    .type("string")
    .headers(Map.of("string", "string"))
    .verifyCert(false)
    .build());

webhook_resource = junipermist.org.Webhook("webhookResource",
    org_id="string",
    url="string",
    topics=["string"],
    oauth2_token_url="string",
    oauth2_client_id="string",
    oauth2_grant_type="string",
    oauth2_password="string",
    oauth2_scopes=["string"],
    enabled=False,
    oauth2_username="string",
    oauth2_client_secret="string",
    secret="string",
    splunk_token="string",
    name="string",
    type="string",
    headers={
        "string": "string",
    },
    verify_cert=False)

const webhookResource = new junipermist.org.Webhook("webhookResource", {
    orgId: "string",
    url: "string",
    topics: ["string"],
    oauth2TokenUrl: "string",
    oauth2ClientId: "string",
    oauth2GrantType: "string",
    oauth2Password: "string",
    oauth2Scopes: ["string"],
    enabled: false,
    oauth2Username: "string",
    oauth2ClientSecret: "string",
    secret: "string",
    splunkToken: "string",
    name: "string",
    type: "string",
    headers: {
        string: "string",
    },
    verifyCert: false,
});

type: junipermist:org:Webhook
properties:
    enabled: false
    headers:
        string: string
    name: string
    oauth2ClientId: string
    oauth2ClientSecret: string
    oauth2GrantType: string
    oauth2Password: string
    oauth2Scopes:
        - string
    oauth2TokenUrl: string
    oauth2Username: string
    orgId: string
    secret: string
    splunkToken: string
    topics:
        - string
    type: string
    url: string
    verifyCert: false

Webhook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Webhook resource accepts the following input properties:

OrgId string
Topics List<string>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
Url string
Enabled bool: whether webhook is enabled
Headers Dictionary<string, string>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
Name string: name of the webhook
Oauth2ClientId string: required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: required when oauth2_grant_type==password
Oauth2Scopes List<string>: required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: required when type==oauth2
Oauth2Username string: required when oauth2_grant_type==password
Secret string: only if type=http-post
SplunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
VerifyCert bool: when url uses HTTPS, whether to verify the certificate

OrgId string
Topics []string: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
Url string
Enabled bool: whether webhook is enabled
Headers map[string]string: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
Name string: name of the webhook
Oauth2ClientId string: required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: required when oauth2_grant_type==password
Oauth2Scopes []string: required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: required when type==oauth2
Oauth2Username string: required when oauth2_grant_type==password
Secret string: only if type=http-post
SplunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
VerifyCert bool: when url uses HTTPS, whether to verify the certificate

orgId String
topics List<String>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
url String
enabled Boolean: whether webhook is enabled
headers Map<String,String>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name String: name of the webhook
oauth2ClientId String: required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: required when oauth2_grant_type==password
oauth2Scopes List<String>: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: required when type==oauth2
oauth2Username String: required when oauth2_grant_type==password
secret String: only if type=http-post
splunkToken String: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
verifyCert Boolean: when url uses HTTPS, whether to verify the certificate

orgId string
topics string[]: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
url string
enabled boolean: whether webhook is enabled
headers {[key: string]: string}: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name string: name of the webhook
oauth2ClientId string: required when oauth2_grant_type==client_credentials
oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
oauth2Password string: required when oauth2_grant_type==password
oauth2Scopes string[]: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl string: required when type==oauth2
oauth2Username string: required when oauth2_grant_type==password
secret string: only if type=http-post
splunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
verifyCert boolean: when url uses HTTPS, whether to verify the certificate

org_id str
topics Sequence[str]: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
url str
enabled bool: whether webhook is enabled
headers Mapping[str, str]: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name str: name of the webhook
oauth2_client_id str: required when oauth2_grant_type==client_credentials
oauth2_client_secret str: required when oauth2_grant_type==client_credentials
oauth2_grant_type str: required when type==oauth2. enum: client_credentials, password
oauth2_password str: required when oauth2_grant_type==password
oauth2_scopes Sequence[str]: required when type==oauth2, if provided, will be used in the token request
oauth2_token_url str: required when type==oauth2
oauth2_username str: required when oauth2_grant_type==password
secret str: only if type=http-post
splunk_token str: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
type str: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
verify_cert bool: when url uses HTTPS, whether to verify the certificate

orgId String
topics List<String>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
url String
enabled Boolean: whether webhook is enabled
headers Map<String>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name String: name of the webhook
oauth2ClientId String: required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: required when oauth2_grant_type==password
oauth2Scopes List<String>: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: required when type==oauth2
oauth2Username String: required when oauth2_grant_type==password
secret String: only if type=http-post
splunkToken String: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
verifyCert Boolean: when url uses HTTPS, whether to verify the certificate

Outputs

All input properties are implicitly available as output properties. Additionally, the Webhook resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Webhook Resource

Get an existing Webhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WebhookState, opts?: CustomResourceOptions): Webhook

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        headers: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        oauth2_client_id: Optional[str] = None,
        oauth2_client_secret: Optional[str] = None,
        oauth2_grant_type: Optional[str] = None,
        oauth2_password: Optional[str] = None,
        oauth2_scopes: Optional[Sequence[str]] = None,
        oauth2_token_url: Optional[str] = None,
        oauth2_username: Optional[str] = None,
        org_id: Optional[str] = None,
        secret: Optional[str] = None,
        splunk_token: Optional[str] = None,
        topics: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        url: Optional[str] = None,
        verify_cert: Optional[bool] = None) -> Webhook

func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)

public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)

public static Webhook get(String name, Output<String> id, WebhookState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Enabled bool: whether webhook is enabled
Headers Dictionary<string, string>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
Name string: name of the webhook
Oauth2ClientId string: required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: required when oauth2_grant_type==password
Oauth2Scopes List<string>: required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: required when type==oauth2
Oauth2Username string: required when oauth2_grant_type==password
OrgId string
Secret string: only if type=http-post
SplunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
Topics List<string>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
Url string
VerifyCert bool: when url uses HTTPS, whether to verify the certificate

Enabled bool: whether webhook is enabled
Headers map[string]string: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
Name string: name of the webhook
Oauth2ClientId string: required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: required when oauth2_grant_type==password
Oauth2Scopes []string: required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: required when type==oauth2
Oauth2Username string: required when oauth2_grant_type==password
OrgId string
Secret string: only if type=http-post
SplunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
Topics []string: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
Url string
VerifyCert bool: when url uses HTTPS, whether to verify the certificate

enabled Boolean: whether webhook is enabled
headers Map<String,String>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name String: name of the webhook
oauth2ClientId String: required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: required when oauth2_grant_type==password
oauth2Scopes List<String>: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: required when type==oauth2
oauth2Username String: required when oauth2_grant_type==password
orgId String
secret String: only if type=http-post
splunkToken String: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
topics List<String>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url String
verifyCert Boolean: when url uses HTTPS, whether to verify the certificate

enabled boolean: whether webhook is enabled
headers {[key: string]: string}: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name string: name of the webhook
oauth2ClientId string: required when oauth2_grant_type==client_credentials
oauth2ClientSecret string: required when oauth2_grant_type==client_credentials
oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
oauth2Password string: required when oauth2_grant_type==password
oauth2Scopes string[]: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl string: required when type==oauth2
oauth2Username string: required when oauth2_grant_type==password
orgId string
secret string: only if type=http-post
splunkToken string: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
topics string[]: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url string
verifyCert boolean: when url uses HTTPS, whether to verify the certificate

enabled bool: whether webhook is enabled
headers Mapping[str, str]: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name str: name of the webhook
oauth2_client_id str: required when oauth2_grant_type==client_credentials
oauth2_client_secret str: required when oauth2_grant_type==client_credentials
oauth2_grant_type str: required when type==oauth2. enum: client_credentials, password
oauth2_password str: required when oauth2_grant_type==password
oauth2_scopes Sequence[str]: required when type==oauth2, if provided, will be used in the token request
oauth2_token_url str: required when type==oauth2
oauth2_username str: required when oauth2_grant_type==password
org_id str
secret str: only if type=http-post
splunk_token str: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
topics Sequence[str]: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
type str: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url str
verify_cert bool: when url uses HTTPS, whether to verify the certificate

enabled Boolean: whether webhook is enabled
headers Map<String>: if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
name String: name of the webhook
oauth2ClientId String: required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: required when oauth2_grant_type==password
oauth2Scopes List<String>: required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: required when type==oauth2
oauth2Username String: required when oauth2_grant_type==password
orgId String
secret String: only if type=http-post
splunkToken String: required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
topics List<String>: enum: alarms, audits, client-info, client-join, client-sessions, device-updowns, device-events, mxedge-events, nac-accounting, nac_events
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url String
verifyCert Boolean: when url uses HTTPS, whether to verify the certificate

Import

Using pulumi import, import mist_org_webhook with:

Org Webhook can be imported by specifying the org_id and the webhook_id

$ pulumi import junipermist:org/webhook:Webhook webhook_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: junipermist pulumi/pulumi-junipermist
License: Apache-2.0
Notes: This Pulumi package is based on the mist Terraform Provider.

Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

pulumi/pulumi-junipermist

junipermist.org.Webhook

On this page

On this page

Example Usage

Create Webhook Resource

Constructor syntax

Parameters

Constructor example

Webhook Resource Properties

Inputs

Outputs

Look up Existing Webhook Resource

Import

Package Details

On this page

On this page