1. Packages
  2. Scm Provider
  3. API Docs
  4. getAuthenticationRule
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

scm.getAuthenticationRule

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getAuthenticationRule({
        id: "1234-56-789",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_authentication_rule(id="1234-56-789")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scm.LookupAuthenticationRule(ctx, &scm.LookupAuthenticationRuleArgs{
    			Id: "1234-56-789",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetAuthenticationRule.Invoke(new()
        {
            Id = "1234-56-789",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetAuthenticationRuleArgs;
    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 = ScmFunctions.getAuthenticationRule(GetAuthenticationRuleArgs.builder()
                .id("1234-56-789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getAuthenticationRule
          Arguments:
            id: 1234-56-789
    

    Using getAuthenticationRule

    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 getAuthenticationRule(args: GetAuthenticationRuleArgs, opts?: InvokeOptions): Promise<GetAuthenticationRuleResult>
    function getAuthenticationRuleOutput(args: GetAuthenticationRuleOutputArgs, opts?: InvokeOptions): Output<GetAuthenticationRuleResult>
    def get_authentication_rule(id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAuthenticationRuleResult
    def get_authentication_rule_output(id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAuthenticationRuleResult]
    func LookupAuthenticationRule(ctx *Context, args *LookupAuthenticationRuleArgs, opts ...InvokeOption) (*LookupAuthenticationRuleResult, error)
    func LookupAuthenticationRuleOutput(ctx *Context, args *LookupAuthenticationRuleOutputArgs, opts ...InvokeOption) LookupAuthenticationRuleResultOutput

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

    public static class GetAuthenticationRule 
    {
        public static Task<GetAuthenticationRuleResult> InvokeAsync(GetAuthenticationRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthenticationRuleResult> Invoke(GetAuthenticationRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthenticationRuleResult> getAuthenticationRule(GetAuthenticationRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getAuthenticationRule:getAuthenticationRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The Id param.
    Id string
    The Id param.
    id String
    The Id param.
    id string
    The Id param.
    id str
    The Id param.
    id String
    The Id param.

    getAuthenticationRule Result

    The following output properties are available:

    AuthenticationEnforcement string
    the authentication profile name to apply to authentication rule.
    Categories List<string>
    The Categories param.
    Description string
    The Description param.
    DestinationHips List<string>
    The DestinationHips param.
    Destinations List<string>
    The Destinations param.
    Disabled bool
    The Disabled param. Default: false.
    Froms List<string>
    The Froms param.
    GroupTag string
    The GroupTag param.
    HipProfiles List<string>
    The HipProfiles param.
    Id string
    The Id param.
    LogAuthenticationTimeout bool
    The LogAuthenticationTimeout param. Default: false.
    LogSetting string
    The LogSetting param.
    Name string
    The Name param.
    NegateDestination bool
    The NegateDestination param. Default: false.
    NegateSource bool
    The NegateSource param. Default: false.
    Services List<string>
    The Services param.
    SourceHips List<string>
    The SourceHips param.
    SourceUsers List<string>
    The SourceUsers param.
    Sources List<string>
    The Sources param.
    Tags List<string>
    The Tags param.
    Tfid string
    Timeout int
    The Timeout param. Value must be between 1 and 1440.
    Tos List<string>
    The Tos param.
    AuthenticationEnforcement string
    the authentication profile name to apply to authentication rule.
    Categories []string
    The Categories param.
    Description string
    The Description param.
    DestinationHips []string
    The DestinationHips param.
    Destinations []string
    The Destinations param.
    Disabled bool
    The Disabled param. Default: false.
    Froms []string
    The Froms param.
    GroupTag string
    The GroupTag param.
    HipProfiles []string
    The HipProfiles param.
    Id string
    The Id param.
    LogAuthenticationTimeout bool
    The LogAuthenticationTimeout param. Default: false.
    LogSetting string
    The LogSetting param.
    Name string
    The Name param.
    NegateDestination bool
    The NegateDestination param. Default: false.
    NegateSource bool
    The NegateSource param. Default: false.
    Services []string
    The Services param.
    SourceHips []string
    The SourceHips param.
    SourceUsers []string
    The SourceUsers param.
    Sources []string
    The Sources param.
    Tags []string
    The Tags param.
    Tfid string
    Timeout int
    The Timeout param. Value must be between 1 and 1440.
    Tos []string
    The Tos param.
    authenticationEnforcement String
    the authentication profile name to apply to authentication rule.
    categories List<String>
    The Categories param.
    description String
    The Description param.
    destinationHips List<String>
    The DestinationHips param.
    destinations List<String>
    The Destinations param.
    disabled Boolean
    The Disabled param. Default: false.
    froms List<String>
    The Froms param.
    groupTag String
    The GroupTag param.
    hipProfiles List<String>
    The HipProfiles param.
    id String
    The Id param.
    logAuthenticationTimeout Boolean
    The LogAuthenticationTimeout param. Default: false.
    logSetting String
    The LogSetting param.
    name String
    The Name param.
    negateDestination Boolean
    The NegateDestination param. Default: false.
    negateSource Boolean
    The NegateSource param. Default: false.
    services List<String>
    The Services param.
    sourceHips List<String>
    The SourceHips param.
    sourceUsers List<String>
    The SourceUsers param.
    sources List<String>
    The Sources param.
    tags List<String>
    The Tags param.
    tfid String
    timeout Integer
    The Timeout param. Value must be between 1 and 1440.
    tos List<String>
    The Tos param.
    authenticationEnforcement string
    the authentication profile name to apply to authentication rule.
    categories string[]
    The Categories param.
    description string
    The Description param.
    destinationHips string[]
    The DestinationHips param.
    destinations string[]
    The Destinations param.
    disabled boolean
    The Disabled param. Default: false.
    froms string[]
    The Froms param.
    groupTag string
    The GroupTag param.
    hipProfiles string[]
    The HipProfiles param.
    id string
    The Id param.
    logAuthenticationTimeout boolean
    The LogAuthenticationTimeout param. Default: false.
    logSetting string
    The LogSetting param.
    name string
    The Name param.
    negateDestination boolean
    The NegateDestination param. Default: false.
    negateSource boolean
    The NegateSource param. Default: false.
    services string[]
    The Services param.
    sourceHips string[]
    The SourceHips param.
    sourceUsers string[]
    The SourceUsers param.
    sources string[]
    The Sources param.
    tags string[]
    The Tags param.
    tfid string
    timeout number
    The Timeout param. Value must be between 1 and 1440.
    tos string[]
    The Tos param.
    authentication_enforcement str
    the authentication profile name to apply to authentication rule.
    categories Sequence[str]
    The Categories param.
    description str
    The Description param.
    destination_hips Sequence[str]
    The DestinationHips param.
    destinations Sequence[str]
    The Destinations param.
    disabled bool
    The Disabled param. Default: false.
    froms Sequence[str]
    The Froms param.
    group_tag str
    The GroupTag param.
    hip_profiles Sequence[str]
    The HipProfiles param.
    id str
    The Id param.
    log_authentication_timeout bool
    The LogAuthenticationTimeout param. Default: false.
    log_setting str
    The LogSetting param.
    name str
    The Name param.
    negate_destination bool
    The NegateDestination param. Default: false.
    negate_source bool
    The NegateSource param. Default: false.
    services Sequence[str]
    The Services param.
    source_hips Sequence[str]
    The SourceHips param.
    source_users Sequence[str]
    The SourceUsers param.
    sources Sequence[str]
    The Sources param.
    tags Sequence[str]
    The Tags param.
    tfid str
    timeout int
    The Timeout param. Value must be between 1 and 1440.
    tos Sequence[str]
    The Tos param.
    authenticationEnforcement String
    the authentication profile name to apply to authentication rule.
    categories List<String>
    The Categories param.
    description String
    The Description param.
    destinationHips List<String>
    The DestinationHips param.
    destinations List<String>
    The Destinations param.
    disabled Boolean
    The Disabled param. Default: false.
    froms List<String>
    The Froms param.
    groupTag String
    The GroupTag param.
    hipProfiles List<String>
    The HipProfiles param.
    id String
    The Id param.
    logAuthenticationTimeout Boolean
    The LogAuthenticationTimeout param. Default: false.
    logSetting String
    The LogSetting param.
    name String
    The Name param.
    negateDestination Boolean
    The NegateDestination param. Default: false.
    negateSource Boolean
    The NegateSource param. Default: false.
    services List<String>
    The Services param.
    sourceHips List<String>
    The SourceHips param.
    sourceUsers List<String>
    The SourceUsers param.
    sources List<String>
    The Sources param.
    tags List<String>
    The Tags param.
    tfid String
    timeout Number
    The Timeout param. Value must be between 1 and 1440.
    tos List<String>
    The Tos param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi