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

pulumi_scm/get_vlan_interface.py

@@ -111,17 +111,26 @@ class GetVlanInterfaceResult:
     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(name="dhcpClient")
     def dhcp_client(self) -> 'outputs.GetVlanInterfaceDhcpClientResult':
+        """
+        Vlan interfaces DHCP Client Object
+        > ℹ️ **Note:** You must specify exactly one of `dhcp_client` and `ip`.
+        """
         return pulumi.get(self, "dhcp_client")
 
     @_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
@@ -135,16 +144,26 @@ class GetVlanInterfaceResult:
     @_builtins.property
     @pulumi.getter(name="interfaceManagementProfile")
     def interface_management_profile(self) -> _builtins.str:
+        """
+        Interface management profile
+        """
         return pulumi.get(self, "interface_management_profile")
 
     @_builtins.property
     @pulumi.getter
     def ips(self) -> Sequence['outputs.GetVlanInterfaceIpResult']:
+        """
+        VLAN Interface IP Parent
+        > ℹ️ **Note:** You must specify exactly one of `dhcp_client` and `ip`.
+        """
         return pulumi.get(self, "ips")
 
     @_builtins.property
     @pulumi.getter
     def mtu(self) -> _builtins.int:
+        """
+        MTU
+        """
         return pulumi.get(self, "mtu")
 
     @_builtins.property
@@ -158,6 +177,10 @@ class GetVlanInterfaceResult:
     @_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
@@ -168,6 +191,9 @@ class GetVlanInterfaceResult:
     @_builtins.property
     @pulumi.getter(name="vlanTag")
     def vlan_tag(self) -> _builtins.str:
+        """
+        VLAN tag
+        """
         return pulumi.get(self, "vlan_tag")
 
 
@@ -194,8 +220,11 @@ class AwaitableGetVlanInterfaceResult(GetVlanInterfaceResult):
             vlan_tag=self.vlan_tag)
 
 
-def get_vlan_interface(id: Optional[_builtins.str] = None,
+def get_vlan_interface(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) -> AwaitableGetVlanInterfaceResult:
     """
     VlanInterface data source
@@ -219,12 +248,21 @@ def get_vlan_interface(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: UUID of the resource
     :param _builtins.str name: L3 sub-interface name
+    :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/getVlanInterface:getVlanInterface', __args__, opts=opts, typ=GetVlanInterfaceResult).value
 
@@ -244,8 +282,11 @@ def get_vlan_interface(id: Optional[_builtins.str] = None,
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'),
         vlan_tag=pulumi.get(__ret__, 'vlan_tag'))
-def get_vlan_interface_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_vlan_interface_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[GetVlanInterfaceResult]:
     """
     VlanInterface data source
@@ -269,12 +310,21 @@ def get_vlan_interface_output(id: Optional[pulumi.Input[_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: UUID of the resource
     :param _builtins.str name: L3 sub-interface name
+    :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/getVlanInterface:getVlanInterface', __args__, opts=opts, typ=GetVlanInterfaceResult)
     return __ret__.apply(lambda __response__: GetVlanInterfaceResult(

pulumi_scm/get_vpn_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__ = [
+    'GetVpnSettingResult',
+    'AwaitableGetVpnSettingResult',
+    'get_vpn_setting',
+    'get_vpn_setting_output',
+]
+
+@pulumi.output_type
+class GetVpnSettingResult:
+    """
+    A collection of values returned by getVpnSetting.
+    """
+    def __init__(__self__, device=None, folder=None, id=None, snippet=None, tfid=None, vpn=None):
+        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)
+        if vpn and not isinstance(vpn, dict):
+            raise TypeError("Expected argument 'vpn' to be a dict")
+        pulumi.set(__self__, "vpn", vpn)
+
+    @_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")
+
+    @_builtins.property
+    @pulumi.getter
+    def vpn(self) -> 'outputs.GetVpnSettingVpnResult':
+        """
+        Vpn
+        """
+        return pulumi.get(self, "vpn")
+
+
+class AwaitableGetVpnSettingResult(GetVpnSettingResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVpnSettingResult(
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            snippet=self.snippet,
+            tfid=self.tfid,
+            vpn=self.vpn)
+
+
+def get_vpn_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) -> AwaitableGetVpnSettingResult:
+    """
+    VpnSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_vpn_setting(id="7e4287ab-dfec-48bc-866d-8fb2ae3e1c5f")
+    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/getVpnSetting:getVpnSetting', __args__, opts=opts, typ=GetVpnSettingResult).value
+
+    return AwaitableGetVpnSettingResult(
+        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'),
+        vpn=pulumi.get(__ret__, 'vpn'))
+def get_vpn_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[GetVpnSettingResult]:
+    """
+    VpnSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_vpn_setting(id="7e4287ab-dfec-48bc-866d-8fb2ae3e1c5f")
+    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/getVpnSetting:getVpnSetting', __args__, opts=opts, typ=GetVpnSettingResult)
+    return __ret__.apply(lambda __response__: GetVpnSettingResult(
+        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'),
+        vpn=pulumi.get(__response__, 'vpn')))

pulumi_scm/get_vpn_setting_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__ = [
+    'GetVpnSettingListResult',
+    'AwaitableGetVpnSettingListResult',
+    'get_vpn_setting_list',
+    'get_vpn_setting_list_output',
+]
+
+@pulumi.output_type
+class GetVpnSettingListResult:
+    """
+    A collection of values returned by getVpnSettingList.
+    """
+    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.GetVpnSettingListDataResult']:
+        """
+        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 AwaitableGetVpnSettingListResult(GetVpnSettingListResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVpnSettingListResult(
+            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_vpn_setting_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) -> AwaitableGetVpnSettingListResult:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_vpn_setting_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/getVpnSettingList:getVpnSettingList', __args__, opts=opts, typ=GetVpnSettingListResult).value
+
+    return AwaitableGetVpnSettingListResult(
+        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_vpn_setting_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[GetVpnSettingListResult]:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_vpn_setting_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/getVpnSettingList:getVpnSettingList', __args__, opts=opts, typ=GetVpnSettingListResult)
+    return __ret__.apply(lambda __response__: GetVpnSettingListResult(
+        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')))