pulumi-scm 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

pulumi_scm/get_authentication_rule.py

@@ -160,32 +160,49 @@ class GetAuthenticationRuleResult:
     def device(self) -> _builtins.str:
         """
         Device
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
         """
         return pulumi.get(self, "device")
 
     @_builtins.property
     @pulumi.getter
     def disabled(self) -> _builtins.bool:
+        """
+        Is the authentication rule disabled?
+        """
         return pulumi.get(self, "disabled")
 
     @_builtins.property
     @pulumi.getter
     def folder(self) -> _builtins.str:
+        """
+        Folder
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
         return pulumi.get(self, "folder")
 
     @_builtins.property
     @pulumi.getter
     def froms(self) -> Sequence[_builtins.str]:
+        """
+        The source security zones
+        """
         return pulumi.get(self, "froms")
 
     @_builtins.property
     @pulumi.getter(name="groupTag")
     def group_tag(self) -> _builtins.str:
+        """
+        Group tag
+        """
         return pulumi.get(self, "group_tag")
 
     @_builtins.property
     @pulumi.getter(name="hipProfiles")
     def hip_profiles(self) -> Sequence[_builtins.str]:
+        """
+        The source Host Integrity Profile (HIP)
+        """
         return pulumi.get(self, "hip_profiles")
 
     @_builtins.property
@@ -199,11 +216,17 @@ class GetAuthenticationRuleResult:
     @_builtins.property
     @pulumi.getter(name="logAuthenticationTimeout")
     def log_authentication_timeout(self) -> _builtins.bool:
+        """
+        Log authentication timeouts?
+        """
         return pulumi.get(self, "log_authentication_timeout")
 
     @_builtins.property
     @pulumi.getter(name="logSetting")
     def log_setting(self) -> _builtins.str:
+        """
+        The log forwarding profile name
+        """
         return pulumi.get(self, "log_setting")
 
     @_builtins.property
@@ -217,56 +240,90 @@ class GetAuthenticationRuleResult:
     @_builtins.property
     @pulumi.getter(name="negateDestination")
     def negate_destination(self) -> _builtins.bool:
+        """
+        Are the destination addresses negated?
+        """
         return pulumi.get(self, "negate_destination")
 
     @_builtins.property
     @pulumi.getter(name="negateSource")
     def negate_source(self) -> _builtins.bool:
+        """
+        Are the source addresses negated?
+        """
         return pulumi.get(self, "negate_source")
 
     @_builtins.property
     @pulumi.getter
     def position(self) -> _builtins.str:
+        """
+        The relative position of the rule
+        """
         return pulumi.get(self, "position")
 
     @_builtins.property
     @pulumi.getter(name="relativePosition")
     def relative_position(self) -> _builtins.str:
+        """
+        Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset.
+        """
         return pulumi.get(self, "relative_position")
 
     @_builtins.property
     @pulumi.getter
     def services(self) -> Sequence[_builtins.str]:
+        """
+        The destination ports
+        """
         return pulumi.get(self, "services")
 
     @_builtins.property
     @pulumi.getter
     def snippet(self) -> _builtins.str:
+        """
+        Snippet
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
         return pulumi.get(self, "snippet")
 
     @_builtins.property
     @pulumi.getter(name="sourceHips")
     def source_hips(self) -> Sequence[_builtins.str]:
+        """
+        The source Host Integrity Profile (HIP)
+        """
         return pulumi.get(self, "source_hips")
 
     @_builtins.property
     @pulumi.getter(name="sourceUsers")
     def source_users(self) -> Sequence[_builtins.str]:
+        """
+        The source users
+        """
         return pulumi.get(self, "source_users")
 
     @_builtins.property
     @pulumi.getter
     def sources(self) -> Sequence[_builtins.str]:
+        """
+        The source addresses
+        """
         return pulumi.get(self, "sources")
 
     @_builtins.property
     @pulumi.getter
     def tags(self) -> Sequence[_builtins.str]:
+        """
+        The authentication rule tags
+        """
         return pulumi.get(self, "tags")
 
     @_builtins.property
     @pulumi.getter(name="targetRule")
     def target_rule(self) -> _builtins.str:
+        """
+        The name or UUID of the rule to position this rule relative to. Required when `relative_position` is `"before"` or `"after"`.
+        """
         return pulumi.get(self, "target_rule")
 
     @_builtins.property
@@ -277,11 +334,17 @@ class GetAuthenticationRuleResult:
     @_builtins.property
     @pulumi.getter
     def timeout(self) -> _builtins.int:
+        """
+        The authentication session timeout (seconds)
+        """
         return pulumi.get(self, "timeout")
 
     @_builtins.property
     @pulumi.getter
     def tos(self) -> Sequence[_builtins.str]:
+        """
+        The destination security zones
+        """
         return pulumi.get(self, "tos")
 
 
@@ -322,8 +385,11 @@ class AwaitableGetAuthenticationRuleResult(GetAuthenticationRuleResult):
             tos=self.tos)
 
 
-def get_authentication_rule(id: Optional[_builtins.str] = None,
+def get_authentication_rule(device: Optional[_builtins.str] = None,
+                            folder: Optional[_builtins.str] = None,
+                            id: Optional[_builtins.str] = None,
                             name: Optional[_builtins.str] = None,
+                            snippet: Optional[_builtins.str] = None,
                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAuthenticationRuleResult:
     """
     AuthenticationRule data source
@@ -340,12 +406,21 @@ def get_authentication_rule(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str device: Device
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: Folder
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the authentication rule
     :param _builtins.str name: The name of the authentication rule
+    :param _builtins.str snippet: Snippet
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('scm:index/getAuthenticationRule:getAuthenticationRule', __args__, opts=opts, typ=GetAuthenticationRuleResult).value
 
@@ -379,8 +454,11 @@ def get_authentication_rule(id: Optional[_builtins.str] = None,
         tfid=pulumi.get(__ret__, 'tfid'),
         timeout=pulumi.get(__ret__, 'timeout'),
         tos=pulumi.get(__ret__, 'tos'))
-def get_authentication_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_authentication_rule_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                   folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                   id: Optional[pulumi.Input[_builtins.str]] = None,
                                    name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                   snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAuthenticationRuleResult]:
     """
     AuthenticationRule data source
@@ -397,12 +475,21 @@ def get_authentication_rule_output(id: Optional[pulumi.Input[_builtins.str]] = N
     ```
 
 
+    :param _builtins.str device: Device
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: Folder
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the authentication rule
     :param _builtins.str name: The name of the authentication rule
+    :param _builtins.str snippet: Snippet
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('scm:index/getAuthenticationRule:getAuthenticationRule', __args__, opts=opts, typ=GetAuthenticationRuleResult)
     return __ret__.apply(lambda __response__: GetAuthenticationRuleResult(

pulumi_scm/get_authentication_sequence.py

@@ -65,12 +65,17 @@ class GetAuthenticationSequenceResult:
     def device(self) -> _builtins.str:
         """
         The device in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
         """
         return pulumi.get(self, "device")
 
     @_builtins.property
     @pulumi.getter
     def folder(self) -> _builtins.str:
+        """
+        The folder in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
         return pulumi.get(self, "folder")
 
     @_builtins.property
@@ -92,6 +97,10 @@ class GetAuthenticationSequenceResult:
     @_builtins.property
     @pulumi.getter
     def snippet(self) -> _builtins.str:
+        """
+        The snippet in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
         return pulumi.get(self, "snippet")
 
     @_builtins.property
@@ -102,6 +111,9 @@ class GetAuthenticationSequenceResult:
     @_builtins.property
     @pulumi.getter(name="useDomainFindProfile")
     def use_domain_find_profile(self) -> _builtins.bool:
+        """
+        Use domain to determine authentication profile?
+        """
         return pulumi.get(self, "use_domain_find_profile")
 
 
@@ -121,8 +133,11 @@ class AwaitableGetAuthenticationSequenceResult(GetAuthenticationSequenceResult):
             use_domain_find_profile=self.use_domain_find_profile)
 
 
-def get_authentication_sequence(id: Optional[_builtins.str] = None,
+def get_authentication_sequence(device: Optional[_builtins.str] = None,
+                                folder: Optional[_builtins.str] = None,
+                                id: Optional[_builtins.str] = None,
                                 name: Optional[_builtins.str] = None,
+                                snippet: Optional[_builtins.str] = None,
                                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAuthenticationSequenceResult:
     """
     AuthenticationSequence data source
@@ -139,12 +154,21 @@ def get_authentication_sequence(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the authentication sequence
     :param _builtins.str name: The name of the authentication sequence
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('scm:index/getAuthenticationSequence:getAuthenticationSequence', __args__, opts=opts, typ=GetAuthenticationSequenceResult).value
 
@@ -157,8 +181,11 @@ def get_authentication_sequence(id: Optional[_builtins.str] = None,
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'),
         use_domain_find_profile=pulumi.get(__ret__, 'use_domain_find_profile'))
-def get_authentication_sequence_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_authentication_sequence_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                       folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                       id: Optional[pulumi.Input[_builtins.str]] = None,
                                        name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                       snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                        opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAuthenticationSequenceResult]:
     """
     AuthenticationSequence data source
@@ -175,12 +202,21 @@ def get_authentication_sequence_output(id: Optional[pulumi.Input[_builtins.str]]
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the authentication sequence
     :param _builtins.str name: The name of the authentication sequence
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('scm:index/getAuthenticationSequence:getAuthenticationSequence', __args__, opts=opts, typ=GetAuthenticationSequenceResult)
     return __ret__.apply(lambda __response__: GetAuthenticationSequenceResult(

pulumi_scm/get_authentication_setting.py

@@ -0,0 +1,195 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetAuthenticationSettingResult',
+    'AwaitableGetAuthenticationSettingResult',
+    'get_authentication_setting',
+    'get_authentication_setting_output',
+]
+
+@pulumi.output_type
+class GetAuthenticationSettingResult:
+    """
+    A collection of values returned by getAuthenticationSetting.
+    """
+    def __init__(__self__, authentication=None, device=None, folder=None, id=None, snippet=None, tfid=None):
+        if authentication and not isinstance(authentication, dict):
+            raise TypeError("Expected argument 'authentication' to be a dict")
+        pulumi.set(__self__, "authentication", authentication)
+        if device and not isinstance(device, str):
+            raise TypeError("Expected argument 'device' to be a str")
+        pulumi.set(__self__, "device", device)
+        if folder and not isinstance(folder, str):
+            raise TypeError("Expected argument 'folder' to be a str")
+        pulumi.set(__self__, "folder", folder)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if snippet and not isinstance(snippet, str):
+            raise TypeError("Expected argument 'snippet' to be a str")
+        pulumi.set(__self__, "snippet", snippet)
+        if tfid and not isinstance(tfid, str):
+            raise TypeError("Expected argument 'tfid' to be a str")
+        pulumi.set(__self__, "tfid", tfid)
+
+    @_builtins.property
+    @pulumi.getter
+    def authentication(self) -> 'outputs.GetAuthenticationSettingAuthenticationResult':
+        """
+        Authentication
+        """
+        return pulumi.get(self, "authentication")
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> _builtins.str:
+        """
+        The device in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "device")
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> _builtins.str:
+        """
+        The folder in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "folder")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        UUID of the resource
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> _builtins.str:
+        """
+        The snippet in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "snippet")
+
+    @_builtins.property
+    @pulumi.getter
+    def tfid(self) -> _builtins.str:
+        return pulumi.get(self, "tfid")
+
+
+class AwaitableGetAuthenticationSettingResult(GetAuthenticationSettingResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAuthenticationSettingResult(
+            authentication=self.authentication,
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            snippet=self.snippet,
+            tfid=self.tfid)
+
+
+def get_authentication_setting(device: Optional[_builtins.str] = None,
+                               folder: Optional[_builtins.str] = None,
+                               id: Optional[_builtins.str] = None,
+                               snippet: Optional[_builtins.str] = None,
+                               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAuthenticationSettingResult:
+    """
+    AuthenticationSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_authentication_setting(id="f4e09263-f8bf-4a4d-a37d-b54d6530810a")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str id: UUID of the resource
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scm:index/getAuthenticationSetting:getAuthenticationSetting', __args__, opts=opts, typ=GetAuthenticationSettingResult).value
+
+    return AwaitableGetAuthenticationSettingResult(
+        authentication=pulumi.get(__ret__, 'authentication'),
+        device=pulumi.get(__ret__, 'device'),
+        folder=pulumi.get(__ret__, 'folder'),
+        id=pulumi.get(__ret__, 'id'),
+        snippet=pulumi.get(__ret__, 'snippet'),
+        tfid=pulumi.get(__ret__, 'tfid'))
+def get_authentication_setting_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      id: Optional[pulumi.Input[_builtins.str]] = None,
+                                      snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAuthenticationSettingResult]:
+    """
+    AuthenticationSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_authentication_setting(id="f4e09263-f8bf-4a4d-a37d-b54d6530810a")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str id: UUID of the resource
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scm:index/getAuthenticationSetting:getAuthenticationSetting', __args__, opts=opts, typ=GetAuthenticationSettingResult)
+    return __ret__.apply(lambda __response__: GetAuthenticationSettingResult(
+        authentication=pulumi.get(__response__, 'authentication'),
+        device=pulumi.get(__response__, 'device'),
+        folder=pulumi.get(__response__, 'folder'),
+        id=pulumi.get(__response__, 'id'),
+        snippet=pulumi.get(__response__, 'snippet'),
+        tfid=pulumi.get(__response__, 'tfid')))