Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. network
  5. getDdosCustomPolicy
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getDdosCustomPolicy

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets information about the specified DDoS custom policy. API Version: 2020-11-01.

    Using getDdosCustomPolicy

    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 getDdosCustomPolicy(args: GetDdosCustomPolicyArgs, opts?: InvokeOptions): Promise<GetDdosCustomPolicyResult>
function getDdosCustomPolicyOutput(args: GetDdosCustomPolicyOutputArgs, opts?: InvokeOptions): Output<GetDdosCustomPolicyResult>
    def get_ddos_custom_policy(ddos_custom_policy_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDdosCustomPolicyResult
def get_ddos_custom_policy_output(ddos_custom_policy_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDdosCustomPolicyResult]
    func LookupDdosCustomPolicy(ctx *Context, args *LookupDdosCustomPolicyArgs, opts ...InvokeOption) (*LookupDdosCustomPolicyResult, error)
func LookupDdosCustomPolicyOutput(ctx *Context, args *LookupDdosCustomPolicyOutputArgs, opts ...InvokeOption) LookupDdosCustomPolicyResultOutput

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

    public static class GetDdosCustomPolicy 
{
    public static Task<GetDdosCustomPolicyResult> InvokeAsync(GetDdosCustomPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetDdosCustomPolicyResult> Invoke(GetDdosCustomPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDdosCustomPolicyResult> getDdosCustomPolicy(GetDdosCustomPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:network:getDdosCustomPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DdosCustomPolicyName string
    The name of the DDoS custom policy.
    ResourceGroupName string
    The name of the resource group.
    DdosCustomPolicyName string
    The name of the DDoS custom policy.
    ResourceGroupName string
    The name of the resource group.
    ddosCustomPolicyName String
    The name of the DDoS custom policy.
    resourceGroupName String
    The name of the resource group.
    ddosCustomPolicyName string
    The name of the DDoS custom policy.
    resourceGroupName string
    The name of the resource group.
    ddos_custom_policy_name str
    The name of the DDoS custom policy.
    resource_group_name str
    The name of the resource group.
    ddosCustomPolicyName String
    The name of the DDoS custom policy.
    resourceGroupName String
    The name of the resource group.

    getDdosCustomPolicy Result

    The following output properties are available:

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the DDoS custom policy resource.
    PublicIPAddresses List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    ResourceGuid string
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    Type string
    Resource type.
    Id string
    Resource ID.
    Location string
    Resource location.
    ProtocolCustomSettings List<Pulumi.AzureNative.Network.Outputs.ProtocolCustomSettingsFormatResponse>
    The protocol-specific DDoS policy customization parameters.
    Tags Dictionary<string, string>
    Resource tags.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the DDoS custom policy resource.
    PublicIPAddresses []SubResourceResponse
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    ResourceGuid string
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    Type string
    Resource type.
    Id string
    Resource ID.
    Location string
    Resource location.
    ProtocolCustomSettings []ProtocolCustomSettingsFormatResponse
    The protocol-specific DDoS policy customization parameters.
    Tags map[string]string
    Resource tags.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the DDoS custom policy resource.
    publicIPAddresses List<SubResourceResponse>
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    resourceGuid String
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    type String
    Resource type.
    id String
    Resource ID.
    location String
    Resource location.
    protocolCustomSettings List<ProtocolCustomSettingsFormatResponse>
    The protocol-specific DDoS policy customization parameters.
    tags Map<String,String>
    Resource tags.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the DDoS custom policy resource.
    publicIPAddresses SubResourceResponse[]
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    resourceGuid string
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    type string
    Resource type.
    id string
    Resource ID.
    location string
    Resource location.
    protocolCustomSettings ProtocolCustomSettingsFormatResponse[]
    The protocol-specific DDoS policy customization parameters.
    tags {[key: string]: string}
    Resource tags.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the DDoS custom policy resource.
    public_ip_addresses Sequence[SubResourceResponse]
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    resource_guid str
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    type str
    Resource type.
    id str
    Resource ID.
    location str
    Resource location.
    protocol_custom_settings Sequence[ProtocolCustomSettingsFormatResponse]
    The protocol-specific DDoS policy customization parameters.
    tags Mapping[str, str]
    Resource tags.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the DDoS custom policy resource.
    publicIPAddresses List<Property Map>
    The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
    resourceGuid String
    The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    type String
    Resource type.
    id String
    Resource ID.
    location String
    Resource location.
    protocolCustomSettings List<Property Map>
    The protocol-specific DDoS policy customization parameters.
    tags Map<String>
    Resource tags.

    Supporting Types

    ProtocolCustomSettingsFormatResponse

    Protocol string
    The protocol for which the DDoS protection policy is being customized.
    SourceRateOverride string
    The customized DDoS protection source rate.
    TriggerRateOverride string
    The customized DDoS protection trigger rate.
    TriggerSensitivityOverride string
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.
    Protocol string
    The protocol for which the DDoS protection policy is being customized.
    SourceRateOverride string
    The customized DDoS protection source rate.
    TriggerRateOverride string
    The customized DDoS protection trigger rate.
    TriggerSensitivityOverride string
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.
    protocol String
    The protocol for which the DDoS protection policy is being customized.
    sourceRateOverride String
    The customized DDoS protection source rate.
    triggerRateOverride String
    The customized DDoS protection trigger rate.
    triggerSensitivityOverride String
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.
    protocol string
    The protocol for which the DDoS protection policy is being customized.
    sourceRateOverride string
    The customized DDoS protection source rate.
    triggerRateOverride string
    The customized DDoS protection trigger rate.
    triggerSensitivityOverride string
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.
    protocol str
    The protocol for which the DDoS protection policy is being customized.
    source_rate_override str
    The customized DDoS protection source rate.
    trigger_rate_override str
    The customized DDoS protection trigger rate.
    trigger_sensitivity_override str
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.
    protocol String
    The protocol for which the DDoS protection policy is being customized.
    sourceRateOverride String
    The customized DDoS protection source rate.
    triggerRateOverride String
    The customized DDoS protection trigger rate.
    triggerSensitivityOverride String
    The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native