1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. getUrlFilteringPolicyDefinition
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

sdwan.getUrlFilteringPolicyDefinition

Explore with Pulumi AI

This data source can read the URL Filtering Policy Definition .

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sdwan from "@pulumi/sdwan";

const example = sdwan.getUrlFilteringPolicyDefinition({
    id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
});
Copy
import pulumi
import pulumi_sdwan as sdwan

example = sdwan.get_url_filtering_policy_definition(id="f6b2c44c-693c-4763-b010-895aa3d236bd")
Copy
package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.LookupUrlFilteringPolicyDefinition(ctx, &sdwan.LookupUrlFilteringPolicyDefinitionArgs{
			Id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = Sdwan.GetUrlFilteringPolicyDefinition.Invoke(new()
    {
        Id = "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.SdwanFunctions;
import com.pulumi.sdwan.inputs.GetUrlFilteringPolicyDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = SdwanFunctions.getUrlFilteringPolicyDefinition(GetUrlFilteringPolicyDefinitionArgs.builder()
            .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: sdwan:getUrlFilteringPolicyDefinition
      arguments:
        id: f6b2c44c-693c-4763-b010-895aa3d236bd
Copy

Using getUrlFilteringPolicyDefinition

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 getUrlFilteringPolicyDefinition(args: GetUrlFilteringPolicyDefinitionArgs, opts?: InvokeOptions): Promise<GetUrlFilteringPolicyDefinitionResult>
function getUrlFilteringPolicyDefinitionOutput(args: GetUrlFilteringPolicyDefinitionOutputArgs, opts?: InvokeOptions): Output<GetUrlFilteringPolicyDefinitionResult>
Copy
def get_url_filtering_policy_definition(id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetUrlFilteringPolicyDefinitionResult
def get_url_filtering_policy_definition_output(id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetUrlFilteringPolicyDefinitionResult]
Copy
func LookupUrlFilteringPolicyDefinition(ctx *Context, args *LookupUrlFilteringPolicyDefinitionArgs, opts ...InvokeOption) (*LookupUrlFilteringPolicyDefinitionResult, error)
func LookupUrlFilteringPolicyDefinitionOutput(ctx *Context, args *LookupUrlFilteringPolicyDefinitionOutputArgs, opts ...InvokeOption) LookupUrlFilteringPolicyDefinitionResultOutput
Copy

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

public static class GetUrlFilteringPolicyDefinition 
{
    public static Task<GetUrlFilteringPolicyDefinitionResult> InvokeAsync(GetUrlFilteringPolicyDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetUrlFilteringPolicyDefinitionResult> Invoke(GetUrlFilteringPolicyDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUrlFilteringPolicyDefinitionResult> getUrlFilteringPolicyDefinition(GetUrlFilteringPolicyDefinitionArgs args, InvokeOptions options)
public static Output<GetUrlFilteringPolicyDefinitionResult> getUrlFilteringPolicyDefinition(GetUrlFilteringPolicyDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: sdwan:index/getUrlFilteringPolicyDefinition:getUrlFilteringPolicyDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The id of the object
Id This property is required. string
The id of the object
id This property is required. String
The id of the object
id This property is required. string
The id of the object
id This property is required. str
The id of the object
id This property is required. String
The id of the object

getUrlFilteringPolicyDefinition Result

The following output properties are available:

Alerts List<string>
List of alerts options that will be exported as syslog messages
AllowUrlListId string
Allow URL list ID
AllowUrlListVersion int
Allow URL list version
BlockPageAction string
Redirect to a URL or display a message when a blocked page is accessed.
BlockPageContents string
The message displayed or URL redirected to when a blocked page is accessed.
BlockUrlListId string
Block URL list ID
BlockUrlListVersion int
Block URL list version
Description string
The description of the policy definition.
Id string
The id of the object
Loggings List<GetUrlFilteringPolicyDefinitionLogging>
Mode string
The policy mode
Name string
The name of the policy definition.
TargetVpns List<string>
List of VPN IDs
Version int
The version of the object
WebCategories List<string>
List of categories to block or allow
WebCategoriesAction string
whether the selected web categories should be blocked or allowed.
WebReputation string
The web reputation of the policy definition
Alerts []string
List of alerts options that will be exported as syslog messages
AllowUrlListId string
Allow URL list ID
AllowUrlListVersion int
Allow URL list version
BlockPageAction string
Redirect to a URL or display a message when a blocked page is accessed.
BlockPageContents string
The message displayed or URL redirected to when a blocked page is accessed.
BlockUrlListId string
Block URL list ID
BlockUrlListVersion int
Block URL list version
Description string
The description of the policy definition.
Id string
The id of the object
Loggings []GetUrlFilteringPolicyDefinitionLogging
Mode string
The policy mode
Name string
The name of the policy definition.
TargetVpns []string
List of VPN IDs
Version int
The version of the object
WebCategories []string
List of categories to block or allow
WebCategoriesAction string
whether the selected web categories should be blocked or allowed.
WebReputation string
The web reputation of the policy definition
alerts List<String>
List of alerts options that will be exported as syslog messages
allowUrlListId String
Allow URL list ID
allowUrlListVersion Integer
Allow URL list version
blockPageAction String
Redirect to a URL or display a message when a blocked page is accessed.
blockPageContents String
The message displayed or URL redirected to when a blocked page is accessed.
blockUrlListId String
Block URL list ID
blockUrlListVersion Integer
Block URL list version
description String
The description of the policy definition.
id String
The id of the object
loggings List<GetUrlFilteringPolicyDefinitionLogging>
mode String
The policy mode
name String
The name of the policy definition.
targetVpns List<String>
List of VPN IDs
version Integer
The version of the object
webCategories List<String>
List of categories to block or allow
webCategoriesAction String
whether the selected web categories should be blocked or allowed.
webReputation String
The web reputation of the policy definition
alerts string[]
List of alerts options that will be exported as syslog messages
allowUrlListId string
Allow URL list ID
allowUrlListVersion number
Allow URL list version
blockPageAction string
Redirect to a URL or display a message when a blocked page is accessed.
blockPageContents string
The message displayed or URL redirected to when a blocked page is accessed.
blockUrlListId string
Block URL list ID
blockUrlListVersion number
Block URL list version
description string
The description of the policy definition.
id string
The id of the object
loggings GetUrlFilteringPolicyDefinitionLogging[]
mode string
The policy mode
name string
The name of the policy definition.
targetVpns string[]
List of VPN IDs
version number
The version of the object
webCategories string[]
List of categories to block or allow
webCategoriesAction string
whether the selected web categories should be blocked or allowed.
webReputation string
The web reputation of the policy definition
alerts Sequence[str]
List of alerts options that will be exported as syslog messages
allow_url_list_id str
Allow URL list ID
allow_url_list_version int
Allow URL list version
block_page_action str
Redirect to a URL or display a message when a blocked page is accessed.
block_page_contents str
The message displayed or URL redirected to when a blocked page is accessed.
block_url_list_id str
Block URL list ID
block_url_list_version int
Block URL list version
description str
The description of the policy definition.
id str
The id of the object
loggings Sequence[GetUrlFilteringPolicyDefinitionLogging]
mode str
The policy mode
name str
The name of the policy definition.
target_vpns Sequence[str]
List of VPN IDs
version int
The version of the object
web_categories Sequence[str]
List of categories to block or allow
web_categories_action str
whether the selected web categories should be blocked or allowed.
web_reputation str
The web reputation of the policy definition
alerts List<String>
List of alerts options that will be exported as syslog messages
allowUrlListId String
Allow URL list ID
allowUrlListVersion Number
Allow URL list version
blockPageAction String
Redirect to a URL or display a message when a blocked page is accessed.
blockPageContents String
The message displayed or URL redirected to when a blocked page is accessed.
blockUrlListId String
Block URL list ID
blockUrlListVersion Number
Block URL list version
description String
The description of the policy definition.
id String
The id of the object
loggings List<Property Map>
mode String
The policy mode
name String
The name of the policy definition.
targetVpns List<String>
List of VPN IDs
version Number
The version of the object
webCategories List<String>
List of categories to block or allow
webCategoriesAction String
whether the selected web categories should be blocked or allowed.
webReputation String
The web reputation of the policy definition

Supporting Types

GetUrlFilteringPolicyDefinitionLogging

ExternalSyslogServerIp This property is required. string
External Syslog Server IP
ExternalSyslogServerVpn This property is required. string
External Syslog Server VPN
ExternalSyslogServerIp This property is required. string
External Syslog Server IP
ExternalSyslogServerVpn This property is required. string
External Syslog Server VPN
externalSyslogServerIp This property is required. String
External Syslog Server IP
externalSyslogServerVpn This property is required. String
External Syslog Server VPN
externalSyslogServerIp This property is required. string
External Syslog Server IP
externalSyslogServerVpn This property is required. string
External Syslog Server VPN
external_syslog_server_ip This property is required. str
External Syslog Server IP
external_syslog_server_vpn This property is required. str
External Syslog Server VPN
externalSyslogServerIp This property is required. String
External Syslog Server IP
externalSyslogServerVpn This property is required. String
External Syslog Server VPN

Package Details

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