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

pulumi_scm/get_motd_banner_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__ = [
+    'GetMotdBannerSettingListResult',
+    'AwaitableGetMotdBannerSettingListResult',
+    'get_motd_banner_setting_list',
+    'get_motd_banner_setting_list_output',
+]
+
+@pulumi.output_type
+class GetMotdBannerSettingListResult:
+    """
+    A collection of values returned by getMotdBannerSettingList.
+    """
+    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.GetMotdBannerSettingListDataResult']:
+        """
+        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 AwaitableGetMotdBannerSettingListResult(GetMotdBannerSettingListResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetMotdBannerSettingListResult(
+            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_motd_banner_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) -> AwaitableGetMotdBannerSettingListResult:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_motd_banner_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/getMotdBannerSettingList:getMotdBannerSettingList', __args__, opts=opts, typ=GetMotdBannerSettingListResult).value
+
+    return AwaitableGetMotdBannerSettingListResult(
+        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_motd_banner_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[GetMotdBannerSettingListResult]:
+    """
+    Retrieves a listing of config items.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    all_settings = scm.get_motd_banner_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/getMotdBannerSettingList:getMotdBannerSettingList', __args__, opts=opts, typ=GetMotdBannerSettingListResult)
+    return __ret__.apply(lambda __response__: GetMotdBannerSettingListResult(
+        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_nat_rule.py

@@ -287,8 +287,11 @@ class AwaitableGetNatRuleResult(GetNatRuleResult):
             tos=self.tos)
 
 
-def get_nat_rule(id: Optional[_builtins.str] = None,
+def get_nat_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) -> AwaitableGetNatRuleResult:
     """
     NatRule data source
@@ -310,12 +313,18 @@ def get_nat_rule(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+    :param _builtins.str folder: The folder in which the resource is defined
     :param _builtins.str id: UUID of the resource
     :param _builtins.str name: NAT rule name
+    :param _builtins.str snippet: The snippet in which the resource is defined
     """
     __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/getNatRule:getNatRule', __args__, opts=opts, typ=GetNatRuleResult).value
 
@@ -341,8 +350,11 @@ def get_nat_rule(id: Optional[_builtins.str] = None,
         tfid=pulumi.get(__ret__, 'tfid'),
         to_interface=pulumi.get(__ret__, 'to_interface'),
         tos=pulumi.get(__ret__, 'tos'))
-def get_nat_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_nat_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[GetNatRuleResult]:
     """
     NatRule data source
@@ -364,12 +376,18 @@ def get_nat_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+    :param _builtins.str folder: The folder in which the resource is defined
     :param _builtins.str id: UUID of the resource
     :param _builtins.str name: NAT rule name
+    :param _builtins.str snippet: The snippet in which the resource is defined
     """
     __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/getNatRule:getNatRule', __args__, opts=opts, typ=GetNatRuleResult)
     return __ret__.apply(lambda __response__: GetNatRuleResult(

pulumi_scm/get_ospf_auth_profile.py

@@ -61,17 +61,25 @@ class GetOspfAuthProfileResult:
     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="encryptedValues")
     def encrypted_values(self) -> Mapping[str, _builtins.str]:
+        """
+        Map of sensitive values returned from the API.
+        """
         return pulumi.get(self, "encrypted_values")
 
     @_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
@@ -85,6 +93,10 @@ class GetOspfAuthProfileResult:
     @_builtins.property
     @pulumi.getter
     def md5s(self) -> Sequence['outputs.GetOspfAuthProfileMd5Result']:
+        """
+        MD5s
+        > ℹ️ **Note:** You must specify exactly one of `md5` and `password`.
+        """
         return pulumi.get(self, "md5s")
 
     @_builtins.property
@@ -98,11 +110,19 @@ class GetOspfAuthProfileResult:
     @_builtins.property
     @pulumi.getter
     def password(self) -> _builtins.str:
+        """
+        Password
+        > ℹ️ **Note:** You must specify exactly one of `md5` and `password`.
+        """
         return pulumi.get(self, "password")
 
     @_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
@@ -128,19 +148,31 @@ class AwaitableGetOspfAuthProfileResult(GetOspfAuthProfileResult):
             tfid=self.tfid)
 
 
-def get_ospf_auth_profile(id: Optional[_builtins.str] = None,
+def get_ospf_auth_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) -> AwaitableGetOspfAuthProfileResult:
     """
     OspfAuthProfile data source
 
 
+    :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: Profile 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/getOspfAuthProfile:getOspfAuthProfile', __args__, opts=opts, typ=GetOspfAuthProfileResult).value
 
@@ -154,19 +186,31 @@ def get_ospf_auth_profile(id: Optional[_builtins.str] = None,
         password=pulumi.get(__ret__, 'password'),
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_ospf_auth_profile_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_ospf_auth_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[GetOspfAuthProfileResult]:
     """
     OspfAuthProfile data source
 
 
+    :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: Profile 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/getOspfAuthProfile:getOspfAuthProfile', __args__, opts=opts, typ=GetOspfAuthProfileResult)
     return __ret__.apply(lambda __response__: GetOspfAuthProfileResult(

pulumi_scm/get_pbf_rule.py

@@ -117,22 +117,33 @@ class GetPbfRuleResult:
     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="enforceSymmetricReturn")
     def enforce_symmetric_return(self) -> 'outputs.GetPbfRuleEnforceSymmetricReturnResult':
+        """
+        Enforce symmetric return
+        """
         return pulumi.get(self, "enforce_symmetric_return")
 
     @_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(name="from")
     def from_(self) -> 'outputs.GetPbfRuleFromResult':
+        """
+        From
+        """
         return pulumi.get(self, "from_")
 
     @_builtins.property
@@ -154,31 +165,50 @@ class GetPbfRuleResult:
     @_builtins.property
     @pulumi.getter
     def schedule(self) -> _builtins.str:
+        """
+        Schedule
+        """
         return pulumi.get(self, "schedule")
 
     @_builtins.property
     @pulumi.getter
     def services(self) -> Sequence[_builtins.str]:
+        """
+        Services
+        """
         return pulumi.get(self, "services")
 
     @_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(name="sourceUsers")
     def source_users(self) -> Sequence[_builtins.str]:
+        """
+        Source users
+        """
         return pulumi.get(self, "source_users")
 
     @_builtins.property
     @pulumi.getter
     def sources(self) -> Sequence[_builtins.str]:
+        """
+        Source addresses
+        """
         return pulumi.get(self, "sources")
 
     @_builtins.property
     @pulumi.getter
     def tags(self) -> Sequence[_builtins.str]:
+        """
+        Tags
+        """
         return pulumi.get(self, "tags")
 
     @_builtins.property
@@ -212,8 +242,11 @@ class AwaitableGetPbfRuleResult(GetPbfRuleResult):
             tfid=self.tfid)
 
 
-def get_pbf_rule(id: Optional[_builtins.str] = None,
+def get_pbf_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) -> AwaitableGetPbfRuleResult:
     """
     PbfRule data source
@@ -234,12 +267,21 @@ def get_pbf_rule(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: PBF rule 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/getPbfRule:getPbfRule', __args__, opts=opts, typ=GetPbfRuleResult).value
 
@@ -261,8 +303,11 @@ def get_pbf_rule(id: Optional[_builtins.str] = None,
         sources=pulumi.get(__ret__, 'sources'),
         tags=pulumi.get(__ret__, 'tags'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_pbf_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_pbf_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[GetPbfRuleResult]:
     """
     PbfRule data source
@@ -283,12 +328,21 @@ def get_pbf_rule_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: PBF rule 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/getPbfRule:getPbfRule', __args__, opts=opts, typ=GetPbfRuleResult)
     return __ret__.apply(lambda __response__: GetPbfRuleResult(