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

pulumi_scm/get_session_timeout_list.py

@@ -0,0 +1,260 @@
+# 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__ = [
+    'GetSessionTimeoutListResult',
+    'AwaitableGetSessionTimeoutListResult',
+    'get_session_timeout_list',
+    'get_session_timeout_list_output',
+]
+
+@pulumi.output_type
+class GetSessionTimeoutListResult:
+    """
+    A collection of values returned by getSessionTimeoutList.
+    """
+    def __init__(__self__, datas=None, device=None, folder=None, id=None, limit=None, name=None, offset=None, snippet=None, tfid=None, total=None):
+        if datas and not isinstance(datas, list):
+            raise TypeError("Expected argument 'datas' to be a list")
+        pulumi.set(__self__, "datas", datas)
+        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 limit and not isinstance(limit, int):
+            raise TypeError("Expected argument 'limit' to be a int")
+        pulumi.set(__self__, "limit", limit)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if offset and not isinstance(offset, int):
+            raise TypeError("Expected argument 'offset' to be a int")
+        pulumi.set(__self__, "offset", offset)
+        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)
+        if total and not isinstance(total, int):
+            raise TypeError("Expected argument 'total' to be a int")
+        pulumi.set(__self__, "total", total)
+
+    @_builtins.property
+    @pulumi.getter
+    def datas(self) -> Sequence['outputs.GetSessionTimeoutListDataResult']:
+        """
+        The data.
+        """
+        return pulumi.get(self, "datas")
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> Optional[_builtins.str]:
+        """
+        The device of the item.
+        """
+        return pulumi.get(self, "device")
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> Optional[_builtins.str]:
+        """
+        The folder of the item. Default: Shared.
+        """
+        return pulumi.get(self, "folder")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def limit(self) -> Optional[_builtins.int]:
+        """
+        The max number of items to return. Default: 200.
+        """
+        return pulumi.get(self, "limit")
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[_builtins.str]:
+        """
+        The name of the item.
+        """
+        return pulumi.get(self, "name")
+
+    @_builtins.property
+    @pulumi.getter
+    def offset(self) -> Optional[_builtins.int]:
+        """
+        The offset of the first item to return.
+        """
+        return pulumi.get(self, "offset")
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> Optional[_builtins.str]:
+        """
+        The snippet of the item.
+        """
+        return pulumi.get(self, "snippet")
+
+    @_builtins.property
+    @pulumi.getter
+    def tfid(self) -> _builtins.str:
+        return pulumi.get(self, "tfid")
+
+    @_builtins.property
+    @pulumi.getter
+    def total(self) -> _builtins.int:
+        """
+        The total number of items.
+        """
+        return pulumi.get(self, "total")
+
+
+class AwaitableGetSessionTimeoutListResult(GetSessionTimeoutListResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSessionTimeoutListResult(
+            datas=self.datas,
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            limit=self.limit,
+            name=self.name,
+            offset=self.offset,
+            snippet=self.snippet,
+            tfid=self.tfid,
+            total=self.total)
+
+
+def get_session_timeout_list(device: Optional[_builtins.str] = None,
+                             folder: Optional[_builtins.str] = None,
+                             limit: Optional[_builtins.int] = None,
+                             name: Optional[_builtins.str] = None,
+                             offset: Optional[_builtins.int] = None,
+                             snippet: Optional[_builtins.str] = None,
+                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSessionTimeoutListResult:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_session_timeout_list(folder="All")
+    pulumi.export("fetchedSettingListSummary", {
+        "countOfSettingsFetched": all_settings.total,
+        "value": all_settings.datas[0],
+    })
+    ```
+
+
+    :param _builtins.str device: The device of the item.
+    :param _builtins.str folder: The folder of the item. Default: Shared.
+    :param _builtins.int limit: The max number of items to return. Default: 200.
+    :param _builtins.str name: The name of the item.
+    :param _builtins.int offset: The offset of the first item to return.
+    :param _builtins.str snippet: The snippet of the item.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['limit'] = limit
+    __args__['name'] = name
+    __args__['offset'] = offset
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scm:index/getSessionTimeoutList:getSessionTimeoutList', __args__, opts=opts, typ=GetSessionTimeoutListResult).value
+
+    return AwaitableGetSessionTimeoutListResult(
+        datas=pulumi.get(__ret__, 'datas'),
+        device=pulumi.get(__ret__, 'device'),
+        folder=pulumi.get(__ret__, 'folder'),
+        id=pulumi.get(__ret__, 'id'),
+        limit=pulumi.get(__ret__, 'limit'),
+        name=pulumi.get(__ret__, 'name'),
+        offset=pulumi.get(__ret__, 'offset'),
+        snippet=pulumi.get(__ret__, 'snippet'),
+        tfid=pulumi.get(__ret__, 'tfid'),
+        total=pulumi.get(__ret__, 'total'))
+def get_session_timeout_list_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                    folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                    limit: Optional[pulumi.Input[Optional[_builtins.int]]] = None,
+                                    name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                    offset: Optional[pulumi.Input[Optional[_builtins.int]]] = None,
+                                    snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSessionTimeoutListResult]:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_session_timeout_list(folder="All")
+    pulumi.export("fetchedSettingListSummary", {
+        "countOfSettingsFetched": all_settings.total,
+        "value": all_settings.datas[0],
+    })
+    ```
+
+
+    :param _builtins.str device: The device of the item.
+    :param _builtins.str folder: The folder of the item. Default: Shared.
+    :param _builtins.int limit: The max number of items to return. Default: 200.
+    :param _builtins.str name: The name of the item.
+    :param _builtins.int offset: The offset of the first item to return.
+    :param _builtins.str snippet: The snippet of the item.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['limit'] = limit
+    __args__['name'] = name
+    __args__['offset'] = offset
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scm:index/getSessionTimeoutList:getSessionTimeoutList', __args__, opts=opts, typ=GetSessionTimeoutListResult)
+    return __ret__.apply(lambda __response__: GetSessionTimeoutListResult(
+        datas=pulumi.get(__response__, 'datas'),
+        device=pulumi.get(__response__, 'device'),
+        folder=pulumi.get(__response__, 'folder'),
+        id=pulumi.get(__response__, 'id'),
+        limit=pulumi.get(__response__, 'limit'),
+        name=pulumi.get(__response__, 'name'),
+        offset=pulumi.get(__response__, 'offset'),
+        snippet=pulumi.get(__response__, 'snippet'),
+        tfid=pulumi.get(__response__, 'tfid'),
+        total=pulumi.get(__response__, 'total')))

pulumi_scm/get_site.py

@@ -27,7 +27,7 @@ class GetSiteResult:
     """
     A collection of values returned by getSite.
     """
-    def __init__(__self__, address_line1=None, address_line2=None, city=None, country=None, id=None, latitude=None, license_type=None, longitude=None, members=None, name=None, qos=None, state=None, tfid=None, type=None, zip_code=None):
+    def __init__(__self__, address_line1=None, address_line2=None, city=None, country=None, folder=None, id=None, latitude=None, license_type=None, longitude=None, members=None, name=None, qos=None, state=None, tfid=None, type=None, zip_code=None):
         if address_line1 and not isinstance(address_line1, str):
             raise TypeError("Expected argument 'address_line1' to be a str")
         pulumi.set(__self__, "address_line1", address_line1)
@@ -40,6 +40,9 @@ class GetSiteResult:
         if country and not isinstance(country, str):
             raise TypeError("Expected argument 'country' to be a str")
         pulumi.set(__self__, "country", country)
+        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)
@@ -106,6 +109,14 @@ class GetSiteResult:
         """
         return pulumi.get(self, "country")
 
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> _builtins.str:
+        """
+        The folder in which the resource is defined
+        """
+        return pulumi.get(self, "folder")
+
     @_builtins.property
     @pulumi.getter
     def id(self) -> _builtins.str:
@@ -202,6 +213,7 @@ class AwaitableGetSiteResult(GetSiteResult):
             address_line2=self.address_line2,
             city=self.city,
             country=self.country,
+            folder=self.folder,
             id=self.id,
             latitude=self.latitude,
             license_type=self.license_type,
@@ -215,7 +227,8 @@ class AwaitableGetSiteResult(GetSiteResult):
             zip_code=self.zip_code)
 
 
-def get_site(id: Optional[_builtins.str] = None,
+def get_site(folder: Optional[_builtins.str] = None,
+             id: Optional[_builtins.str] = None,
              name: Optional[_builtins.str] = None,
              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSiteResult:
     """
@@ -232,10 +245,12 @@ def get_site(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str folder: The folder in which the resource is defined
     :param _builtins.str id: The UUID of the site
     :param _builtins.str name: The name of the site
     """
     __args__ = dict()
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -246,6 +261,7 @@ def get_site(id: Optional[_builtins.str] = None,
         address_line2=pulumi.get(__ret__, 'address_line2'),
         city=pulumi.get(__ret__, 'city'),
         country=pulumi.get(__ret__, 'country'),
+        folder=pulumi.get(__ret__, 'folder'),
         id=pulumi.get(__ret__, 'id'),
         latitude=pulumi.get(__ret__, 'latitude'),
         license_type=pulumi.get(__ret__, 'license_type'),
@@ -257,7 +273,8 @@ def get_site(id: Optional[_builtins.str] = None,
         tfid=pulumi.get(__ret__, 'tfid'),
         type=pulumi.get(__ret__, 'type'),
         zip_code=pulumi.get(__ret__, 'zip_code'))
-def get_site_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_site_output(folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                    id: Optional[pulumi.Input[_builtins.str]] = None,
                     name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSiteResult]:
     """
@@ -274,10 +291,12 @@ def get_site_output(id: Optional[pulumi.Input[_builtins.str]] = None,
     ```
 
 
+    :param _builtins.str folder: The folder in which the resource is defined
     :param _builtins.str id: The UUID of the site
     :param _builtins.str name: The name of the site
     """
     __args__ = dict()
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -287,6 +306,7 @@ def get_site_output(id: Optional[pulumi.Input[_builtins.str]] = None,
         address_line2=pulumi.get(__response__, 'address_line2'),
         city=pulumi.get(__response__, 'city'),
         country=pulumi.get(__response__, 'country'),
+        folder=pulumi.get(__response__, 'folder'),
         id=pulumi.get(__response__, 'id'),
         latitude=pulumi.get(__response__, 'latitude'),
         license_type=pulumi.get(__response__, 'license_type'),

pulumi_scm/get_syslog_server_profile.py

@@ -43,8 +43,8 @@ class GetSyslogServerProfileResult:
         if name and not isinstance(name, str):
             raise TypeError("Expected argument 'name' to be a str")
         pulumi.set(__self__, "name", name)
-        if servers and not isinstance(servers, dict):
-            raise TypeError("Expected argument 'servers' to be a dict")
+        if servers and not isinstance(servers, list):
+            raise TypeError("Expected argument 'servers' to be a list")
         pulumi.set(__self__, "servers", servers)
         if snippet and not isinstance(snippet, str):
             raise TypeError("Expected argument 'snippet' to be a str")
@@ -58,17 +58,25 @@ class GetSyslogServerProfileResult:
     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 format(self) -> 'outputs.GetSyslogServerProfileFormatResult':
+        """
+        Format
+        """
         return pulumi.get(self, "format")
 
     @_builtins.property
@@ -89,12 +97,19 @@ class GetSyslogServerProfileResult:
 
     @_builtins.property
     @pulumi.getter
-    def servers(self) -> 'outputs.GetSyslogServerProfileServersResult':
+    def servers(self) -> Sequence['outputs.GetSyslogServerProfileServerResult']:
+        """
+        A list of syslog server configurations. At least one server is required.
+        """
         return pulumi.get(self, "servers")
 
     @_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
@@ -119,19 +134,49 @@ class AwaitableGetSyslogServerProfileResult(GetSyslogServerProfileResult):
             tfid=self.tfid)
 
 
-def get_syslog_server_profile(id: Optional[_builtins.str] = None,
+def get_syslog_server_profile(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) -> AwaitableGetSyslogServerProfileResult:
     """
     SyslogServerProfile data source
 
-
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM Syslog Server Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the SCM Syslog Server Profile you want to find.
+    scm_syslog_server_prof = scm.get_syslog_server_profile(id="69f7ee97-7c0a-416d-a28d-d45929851f6e")
+    pulumi.export("scmSyslogServerProfileDetails", {
+        "profileId": scm_syslog_server_prof.id,
+        "folder": scm_syslog_server_prof.folder,
+        "name": scm_syslog_server_prof.name,
+    })
+    ```
+
+
+    :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 syslog server profile
     :param _builtins.str name: The name of the syslog server profile
+    :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/getSyslogServerProfile:getSyslogServerProfile', __args__, opts=opts, typ=GetSyslogServerProfileResult).value
 
@@ -144,19 +189,49 @@ def get_syslog_server_profile(id: Optional[_builtins.str] = None,
         servers=pulumi.get(__ret__, 'servers'),
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_syslog_server_profile_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_syslog_server_profile_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[GetSyslogServerProfileResult]:
     """
     SyslogServerProfile data source
 
-
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM Syslog Server Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the SCM Syslog Server Profile you want to find.
+    scm_syslog_server_prof = scm.get_syslog_server_profile(id="69f7ee97-7c0a-416d-a28d-d45929851f6e")
+    pulumi.export("scmSyslogServerProfileDetails", {
+        "profileId": scm_syslog_server_prof.id,
+        "folder": scm_syslog_server_prof.folder,
+        "name": scm_syslog_server_prof.name,
+    })
+    ```
+
+
+    :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 syslog server profile
     :param _builtins.str name: The name of the syslog server profile
+    :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/getSyslogServerProfile:getSyslogServerProfile', __args__, opts=opts, typ=GetSyslogServerProfileResult)
     return __ret__.apply(lambda __response__: GetSyslogServerProfileResult(

pulumi_scm/get_syslog_server_profile_list.py

@@ -165,6 +165,20 @@ def get_syslog_server_profile_list(device: Optional[_builtins.str] = None,
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a list of SCM Syslog Server Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM Syslog Server Profile in the "Shared" folder.
+    all_shared = scm.get_syslog_server_profile_list(folder="All")
+    pulumi.export("scmSyslogServerProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.
@@ -204,6 +218,20 @@ def get_syslog_server_profile_list_output(device: Optional[pulumi.Input[Optional
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a list of SCM Syslog Server Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM Syslog Server Profile in the "Shared" folder.
+    all_shared = scm.get_syslog_server_profile_list(folder="All")
+    pulumi.export("scmSyslogServerProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.