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

pulumi_scm/get_tls_service_profile.py

@@ -66,12 +66,17 @@ class GetTlsServiceProfileResult:
     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
@@ -93,11 +98,18 @@ class GetTlsServiceProfileResult:
     @_builtins.property
     @pulumi.getter(name="protocolSettings")
     def protocol_settings(self) -> 'outputs.GetTlsServiceProfileProtocolSettingsResult':
+        """
+        Protocol settings
+        """
         return pulumi.get(self, "protocol_settings")
 
     @_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
@@ -122,19 +134,49 @@ class AwaitableGetTlsServiceProfileResult(GetTlsServiceProfileResult):
             tfid=self.tfid)
 
 
-def get_tls_service_profile(id: Optional[_builtins.str] = None,
+def get_tls_service_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) -> AwaitableGetTlsServiceProfileResult:
     """
     TlsServiceProfile data source
 
-
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM TLS Service Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the SCM TLS Service Profile you want to find.
+    scm_tls_service_prof = scm.get_tls_service_profile(id="b4d70015-5b0e-4491-a2a9-4305b01397d5")
+    pulumi.export("scmTlsServiceProfileDetails", {
+        "profileId": scm_tls_service_prof.id,
+        "folder": scm_tls_service_prof.folder,
+        "name": scm_tls_service_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 TLS service profile
     :param _builtins.str name: TLS service profile name. The value is `muCustomDomainSSLProfile` when it is used on mobile-agent infra settings.
+    :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/getTlsServiceProfile:getTlsServiceProfile', __args__, opts=opts, typ=GetTlsServiceProfileResult).value
 
@@ -147,19 +189,49 @@ def get_tls_service_profile(id: Optional[_builtins.str] = None,
         protocol_settings=pulumi.get(__ret__, 'protocol_settings'),
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_tls_service_profile_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_tls_service_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[GetTlsServiceProfileResult]:
     """
     TlsServiceProfile data source
 
-
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a single SCM TLS Service Profile object by its ID.
+    #
+    # Replace the ID with the UUID of the SCM TLS Service Profile you want to find.
+    scm_tls_service_prof = scm.get_tls_service_profile(id="b4d70015-5b0e-4491-a2a9-4305b01397d5")
+    pulumi.export("scmTlsServiceProfileDetails", {
+        "profileId": scm_tls_service_prof.id,
+        "folder": scm_tls_service_prof.folder,
+        "name": scm_tls_service_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 TLS service profile
     :param _builtins.str name: TLS service profile name. The value is `muCustomDomainSSLProfile` when it is used on mobile-agent infra settings.
+    :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/getTlsServiceProfile:getTlsServiceProfile', __args__, opts=opts, typ=GetTlsServiceProfileResult)
     return __ret__.apply(lambda __response__: GetTlsServiceProfileResult(

pulumi_scm/get_tls_service_profile_list.py

@@ -165,6 +165,20 @@ def get_tls_service_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 TLS Service Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM TLS Service Profile in the "Shared" folder.
+    all_shared = scm.get_tls_service_profile_list(folder="All")
+    pulumi.export("scmTlsServiceProfileListAllShared", 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_tls_service_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 TLS Service Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM TLS Service Profile in the "Shared" folder.
+    all_shared = scm.get_tls_service_profile_list(folder="All")
+    pulumi.export("scmTlsServiceProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.

pulumi_scm/get_traffic_steering_rule.py

@@ -155,17 +155,20 @@ class AwaitableGetTrafficSteeringRuleResult(GetTrafficSteeringRuleResult):
             tfid=self.tfid)
 
 
-def get_traffic_steering_rule(id: Optional[_builtins.str] = None,
+def get_traffic_steering_rule(folder: Optional[_builtins.str] = None,
+                              id: Optional[_builtins.str] = None,
                               name: Optional[_builtins.str] = None,
                               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficSteeringRuleResult:
     """
     TrafficSteeringRule data source
 
 
+    :param _builtins.str folder: The folder containing the traffic steering rule
     :param _builtins.str id: The UUID of the traffic steering rule
     :param _builtins.str name: Name
     """
     __args__ = dict()
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -182,17 +185,20 @@ def get_traffic_steering_rule(id: Optional[_builtins.str] = None,
         source_users=pulumi.get(__ret__, 'source_users'),
         sources=pulumi.get(__ret__, 'sources'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_traffic_steering_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_traffic_steering_rule_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[GetTrafficSteeringRuleResult]:
     """
     TrafficSteeringRule data source
 
 
+    :param _builtins.str folder: The folder containing the traffic steering rule
     :param _builtins.str id: The UUID of the traffic steering rule
     :param _builtins.str name: Name
     """
     __args__ = dict()
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)

pulumi_scm/get_tunnel_interface.py

@@ -83,12 +83,17 @@ class GetTunnelInterfaceResult:
     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
@@ -102,16 +107,25 @@ class GetTunnelInterfaceResult:
     @_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.GetTunnelInterfaceIpResult']:
+        """
+        Tunnel Interface IP Parent
+        """
         return pulumi.get(self, "ips")
 
     @_builtins.property
     @pulumi.getter
     def mtu(self) -> _builtins.int:
+        """
+        MTU
+        """
         return pulumi.get(self, "mtu")
 
     @_builtins.property
@@ -125,6 +139,10 @@ class GetTunnelInterfaceResult:
     @_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
@@ -152,8 +170,11 @@ class AwaitableGetTunnelInterfaceResult(GetTunnelInterfaceResult):
             tfid=self.tfid)
 
 
-def get_tunnel_interface(id: Optional[_builtins.str] = None,
+def get_tunnel_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) -> AwaitableGetTunnelInterfaceResult:
     """
     TunnelInterface data source
@@ -176,12 +197,21 @@ def get_tunnel_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/getTunnelInterface:getTunnelInterface', __args__, opts=opts, typ=GetTunnelInterfaceResult).value
 
@@ -197,8 +227,11 @@ def get_tunnel_interface(id: Optional[_builtins.str] = None,
         name=pulumi.get(__ret__, 'name'),
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_tunnel_interface_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_tunnel_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[GetTunnelInterfaceResult]:
     """
     TunnelInterface data source
@@ -221,12 +254,21 @@ def get_tunnel_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/getTunnelInterface:getTunnelInterface', __args__, opts=opts, typ=GetTunnelInterfaceResult)
     return __ret__.apply(lambda __response__: GetTunnelInterfaceResult(

pulumi_scm/get_update_schedule.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__ = [
+    'GetUpdateScheduleResult',
+    'AwaitableGetUpdateScheduleResult',
+    'get_update_schedule',
+    'get_update_schedule_output',
+]
+
+@pulumi.output_type
+class GetUpdateScheduleResult:
+    """
+    A collection of values returned by getUpdateSchedule.
+    """
+    def __init__(__self__, device=None, folder=None, id=None, snippet=None, tfid=None, update_schedule=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 update_schedule and not isinstance(update_schedule, dict):
+            raise TypeError("Expected argument 'update_schedule' to be a dict")
+        pulumi.set(__self__, "update_schedule", update_schedule)
+
+    @_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(name="updateSchedule")
+    def update_schedule(self) -> 'outputs.GetUpdateScheduleUpdateScheduleResult':
+        """
+        Update schedule
+        """
+        return pulumi.get(self, "update_schedule")
+
+
+class AwaitableGetUpdateScheduleResult(GetUpdateScheduleResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetUpdateScheduleResult(
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            snippet=self.snippet,
+            tfid=self.tfid,
+            update_schedule=self.update_schedule)
+
+
+def get_update_schedule(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) -> AwaitableGetUpdateScheduleResult:
+    """
+    UpdateSchedule data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_update_schedule(id="4bde6878-8709-4231-a7b4-c51d8fb4008a")
+    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/getUpdateSchedule:getUpdateSchedule', __args__, opts=opts, typ=GetUpdateScheduleResult).value
+
+    return AwaitableGetUpdateScheduleResult(
+        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'),
+        update_schedule=pulumi.get(__ret__, 'update_schedule'))
+def get_update_schedule_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[GetUpdateScheduleResult]:
+    """
+    UpdateSchedule data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_update_schedule(id="4bde6878-8709-4231-a7b4-c51d8fb4008a")
+    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/getUpdateSchedule:getUpdateSchedule', __args__, opts=opts, typ=GetUpdateScheduleResult)
+    return __ret__.apply(lambda __response__: GetUpdateScheduleResult(
+        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'),
+        update_schedule=pulumi.get(__response__, 'update_schedule')))