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

pulumi_scm/get_ospf_auth_profile.py

@@ -61,25 +61,17 @@ 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
@@ -93,36 +85,21 @@ 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
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        Profile name
-        """
         return pulumi.get(self, "name")
 
     @_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
@@ -159,13 +136,7 @@ def get_ospf_auth_profile(device: 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: 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
@@ -197,13 +168,7 @@ def get_ospf_auth_profile_output(device: Optional[pulumi.Input[Optional[_builtin
 
 
     :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

pulumi_scm/get_pbf_rule.py

@@ -83,33 +83,21 @@ class GetPbfRuleResult:
     @_builtins.property
     @pulumi.getter
     def action(self) -> 'outputs.GetPbfRuleActionResult':
-        """
-        Action
-        """
         return pulumi.get(self, "action")
 
     @_builtins.property
     @pulumi.getter
     def applications(self) -> Sequence[_builtins.str]:
-        """
-        Applications
-        """
         return pulumi.get(self, "applications")
 
     @_builtins.property
     @pulumi.getter
     def description(self) -> _builtins.str:
-        """
-        Description
-        """
         return pulumi.get(self, "description")
 
     @_builtins.property
     @pulumi.getter
     def destinations(self) -> Sequence[_builtins.str]:
-        """
-        Destination addresses
-        """
         return pulumi.get(self, "destinations")
 
     @_builtins.property
@@ -117,33 +105,22 @@ 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
@@ -157,58 +134,36 @@ class GetPbfRuleResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        PBF rule name
-        """
         return pulumi.get(self, "name")
 
     @_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
@@ -268,13 +223,7 @@ def get_pbf_rule(device: 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
@@ -329,13 +278,7 @@ def get_pbf_rule_output(device: Optional[pulumi.Input[Optional[_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: 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

pulumi_scm/get_profile_group.py

@@ -76,17 +76,11 @@ class GetProfileGroupResult:
     @_builtins.property
     @pulumi.getter(name="aiSecurities")
     def ai_securities(self) -> Sequence[_builtins.str]:
-        """
-        Ai security
-        """
         return pulumi.get(self, "ai_securities")
 
     @_builtins.property
     @pulumi.getter(name="dataFilterings")
     def data_filterings(self) -> Sequence[_builtins.str]:
-        """
-        Data filtering
-        """
         return pulumi.get(self, "data_filterings")
 
     @_builtins.property
@@ -94,33 +88,22 @@ class GetProfileGroupResult:
     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="dnsSecurities")
     def dns_securities(self) -> Sequence[_builtins.str]:
-        """
-        Dns security
-        """
         return pulumi.get(self, "dns_securities")
 
     @_builtins.property
     @pulumi.getter(name="fileBlockings")
     def file_blockings(self) -> Sequence[_builtins.str]:
-        """
-        File blocking
-        """
         return pulumi.get(self, "file_blockings")
 
     @_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
@@ -134,34 +117,21 @@ class GetProfileGroupResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        The name of the profile group
-        """
         return pulumi.get(self, "name")
 
     @_builtins.property
     @pulumi.getter(name="saasSecurities")
     def saas_securities(self) -> Sequence[_builtins.str]:
-        """
-        Saas security
-        """
         return pulumi.get(self, "saas_securities")
 
     @_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 spywares(self) -> Sequence[_builtins.str]:
-        """
-        Spyware
-        """
         return pulumi.get(self, "spywares")
 
     @_builtins.property
@@ -172,25 +142,16 @@ class GetProfileGroupResult:
     @_builtins.property
     @pulumi.getter(name="urlFilterings")
     def url_filterings(self) -> Sequence[_builtins.str]:
-        """
-        Url filtering
-        """
         return pulumi.get(self, "url_filterings")
 
     @_builtins.property
     @pulumi.getter(name="virusAndWildfireAnalyses")
     def virus_and_wildfire_analyses(self) -> Sequence[_builtins.str]:
-        """
-        Virus and wildfire analysis
-        """
         return pulumi.get(self, "virus_and_wildfire_analyses")
 
     @_builtins.property
     @pulumi.getter
     def vulnerabilities(self) -> Sequence[_builtins.str]:
-        """
-        Vulnerability
-        """
         return pulumi.get(self, "vulnerabilities")
 
 
@@ -228,13 +189,7 @@ def get_profile_group(device: 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 profile group
-    :param _builtins.str name: The name of the profile group
-    :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
@@ -272,13 +227,7 @@ def get_profile_group_output(device: Optional[pulumi.Input[Optional[_builtins.st
 
 
     :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 profile group
-    :param _builtins.str name: The name of the profile group
-    :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

pulumi_scm/get_qos_policy_rule.py

@@ -71,17 +71,11 @@ class GetQosPolicyRuleResult:
     @_builtins.property
     @pulumi.getter
     def action(self) -> 'outputs.GetQosPolicyRuleActionResult':
-        """
-        Action
-        """
         return pulumi.get(self, "action")
 
     @_builtins.property
     @pulumi.getter
     def description(self) -> _builtins.str:
-        """
-        Description
-        """
         return pulumi.get(self, "description")
 
     @_builtins.property
@@ -89,25 +83,17 @@ class GetQosPolicyRuleResult:
     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="dscpTos")
     def dscp_tos(self) -> 'outputs.GetQosPolicyRuleDscpTosResult':
-        """
-        Dscp tos
-        """
         return pulumi.get(self, "dscp_tos")
 
     @_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
@@ -121,50 +107,31 @@ class GetQosPolicyRuleResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        Name
-        """
         return pulumi.get(self, "name")
 
     @_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 schedule(self) -> _builtins.str:
-        """
-        Schedule
-        """
         return pulumi.get(self, "schedule")
 
     @_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="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
@@ -215,13 +182,7 @@ def get_qos_policy_rule(device: 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: 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
@@ -267,13 +228,7 @@ def get_qos_policy_rule_output(device: Optional[pulumi.Input[Optional[_builtins.
 
 
     :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: 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

pulumi_scm/get_qos_profile.py

@@ -56,17 +56,11 @@ class GetQosProfileResult:
     @_builtins.property
     @pulumi.getter(name="aggregateBandwidth")
     def aggregate_bandwidth(self) -> 'outputs.GetQosProfileAggregateBandwidthResult':
-        """
-        Aggregate bandwidth
-        """
         return pulumi.get(self, "aggregate_bandwidth")
 
     @_builtins.property
     @pulumi.getter(name="classBandwidthType")
     def class_bandwidth_type(self) -> 'outputs.GetQosProfileClassBandwidthTypeResult':
-        """
-        Class bandwidth type
-        """
         return pulumi.get(self, "class_bandwidth_type")
 
     @_builtins.property
@@ -74,17 +68,12 @@ class GetQosProfileResult:
     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
@@ -98,18 +87,11 @@ class GetQosProfileResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        Alphanumeric string begin with letter: [0-9a-zA-Z._-]
-        """
         return pulumi.get(self, "name")
 
     @_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
@@ -143,15 +125,27 @@ def get_qos_profile(device: Optional[_builtins.str] = None,
     """
     QosProfile data source
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM QoS Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the QoS Profile you want to find.
+    scm_qos_prof = scm.get_qos_profile(id="cffecf78-b3b1-4b01-ad31-c69bf839850b")
+    pulumi.export("scmQosProfileDetails", {
+        "id": scm_qos_prof.id,
+        "folder": scm_qos_prof.folder,
+        "name": scm_qos_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: UUID of the resource
-    :param _builtins.str name: Alphanumeric string begin with letter: [0-9a-zA-Z._-]
-    :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
@@ -180,15 +174,27 @@ def get_qos_profile_output(device: Optional[pulumi.Input[Optional[_builtins.str]
     """
     QosProfile data source
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM QoS Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the QoS Profile you want to find.
+    scm_qos_prof = scm.get_qos_profile(id="cffecf78-b3b1-4b01-ad31-c69bf839850b")
+    pulumi.export("scmQosProfileDetails", {
+        "id": scm_qos_prof.id,
+        "folder": scm_qos_prof.folder,
+        "name": scm_qos_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: UUID of the resource
-    :param _builtins.str name: Alphanumeric string begin with letter: [0-9a-zA-Z._-]
-    :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

pulumi_scm/get_qos_profile_list.py

@@ -165,6 +165,21 @@ def get_qos_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 QoS Profile Signature objects.
+    #
+    # Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
+    # Folder must be one of [Remote Networks, Service Connections]"
+    all_shared = scm.get_qos_profile_list(folder="Service Connections")
+    pulumi.export("scmQosProfileListAllShared", 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 +219,21 @@ def get_qos_profile_list_output(device: Optional[pulumi.Input[Optional[_builtins
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a list of SCM QoS Profile Signature objects.
+    #
+    # Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
+    # Folder must be one of [Remote Networks, Service Connections]"
+    all_shared = scm.get_qos_profile_list(folder="Service Connections")
+    pulumi.export("scmQosProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.