pulumi-azure-native 2.59.0a1725270690__py3-none-any.whl → 2.60.0__py3-none-any.whl

pulumi_azure_native/apimanagement/v20240501/subscription.py

@@ -0,0 +1,491 @@
+# 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 copy
+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 ._enums import *
+
+__all__ = ['SubscriptionArgs', 'Subscription']
+
+@pulumi.input_type
+class SubscriptionArgs:
+    def __init__(__self__, *,
+                 display_name: pulumi.Input[str],
+                 resource_group_name: pulumi.Input[str],
+                 scope: pulumi.Input[str],
+                 service_name: pulumi.Input[str],
+                 allow_tracing: Optional[pulumi.Input[bool]] = None,
+                 app_type: Optional[pulumi.Input[str]] = None,
+                 notify: Optional[pulumi.Input[bool]] = None,
+                 owner_id: Optional[pulumi.Input[str]] = None,
+                 primary_key: Optional[pulumi.Input[str]] = None,
+                 secondary_key: Optional[pulumi.Input[str]] = None,
+                 sid: Optional[pulumi.Input[str]] = None,
+                 state: Optional[pulumi.Input['SubscriptionState']] = None):
+        """
+        The set of arguments for constructing a Subscription resource.
+        :param pulumi.Input[str] display_name: Subscription name.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[str] scope: Scope like /products/{productId} or /apis or /apis/{apiId}.
+        :param pulumi.Input[str] service_name: The name of the API Management service.
+        :param pulumi.Input[bool] allow_tracing: Determines whether tracing can be enabled
+        :param pulumi.Input[str] app_type: Determines the type of application which send the create user request. Default is legacy publisher portal.
+        :param pulumi.Input[bool] notify: Notify change in Subscription State. 
+                - If false, do not send any email notification for change of state of subscription 
+                - If true, send email notification of change of state of subscription 
+        :param pulumi.Input[str] owner_id: User (user id path) for whom subscription is being created in form /users/{userId}
+        :param pulumi.Input[str] primary_key: Primary subscription key. If not specified during request key will be generated automatically.
+        :param pulumi.Input[str] secondary_key: Secondary subscription key. If not specified during request key will be generated automatically.
+        :param pulumi.Input[str] sid: Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
+        :param pulumi.Input['SubscriptionState'] state: Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
+        """
+        pulumi.set(__self__, "display_name", display_name)
+        pulumi.set(__self__, "resource_group_name", resource_group_name)
+        pulumi.set(__self__, "scope", scope)
+        pulumi.set(__self__, "service_name", service_name)
+        if allow_tracing is not None:
+            pulumi.set(__self__, "allow_tracing", allow_tracing)
+        if app_type is not None:
+            pulumi.set(__self__, "app_type", app_type)
+        if notify is not None:
+            pulumi.set(__self__, "notify", notify)
+        if owner_id is not None:
+            pulumi.set(__self__, "owner_id", owner_id)
+        if primary_key is not None:
+            pulumi.set(__self__, "primary_key", primary_key)
+        if secondary_key is not None:
+            pulumi.set(__self__, "secondary_key", secondary_key)
+        if sid is not None:
+            pulumi.set(__self__, "sid", sid)
+        if state is not None:
+            pulumi.set(__self__, "state", state)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> pulumi.Input[str]:
+        """
+        Subscription name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @display_name.setter
+    def display_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "display_name", value)
+
+    @property
+    @pulumi.getter(name="resourceGroupName")
+    def resource_group_name(self) -> pulumi.Input[str]:
+        """
+        The name of the resource group. The name is case insensitive.
+        """
+        return pulumi.get(self, "resource_group_name")
+
+    @resource_group_name.setter
+    def resource_group_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "resource_group_name", value)
+
+    @property
+    @pulumi.getter
+    def scope(self) -> pulumi.Input[str]:
+        """
+        Scope like /products/{productId} or /apis or /apis/{apiId}.
+        """
+        return pulumi.get(self, "scope")
+
+    @scope.setter
+    def scope(self, value: pulumi.Input[str]):
+        pulumi.set(self, "scope", value)
+
+    @property
+    @pulumi.getter(name="serviceName")
+    def service_name(self) -> pulumi.Input[str]:
+        """
+        The name of the API Management service.
+        """
+        return pulumi.get(self, "service_name")
+
+    @service_name.setter
+    def service_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "service_name", value)
+
+    @property
+    @pulumi.getter(name="allowTracing")
+    def allow_tracing(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Determines whether tracing can be enabled
+        """
+        return pulumi.get(self, "allow_tracing")
+
+    @allow_tracing.setter
+    def allow_tracing(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "allow_tracing", value)
+
+    @property
+    @pulumi.getter(name="appType")
+    def app_type(self) -> Optional[pulumi.Input[str]]:
+        """
+        Determines the type of application which send the create user request. Default is legacy publisher portal.
+        """
+        return pulumi.get(self, "app_type")
+
+    @app_type.setter
+    def app_type(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "app_type", value)
+
+    @property
+    @pulumi.getter
+    def notify(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Notify change in Subscription State. 
+         - If false, do not send any email notification for change of state of subscription 
+         - If true, send email notification of change of state of subscription 
+        """
+        return pulumi.get(self, "notify")
+
+    @notify.setter
+    def notify(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "notify", value)
+
+    @property
+    @pulumi.getter(name="ownerId")
+    def owner_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        User (user id path) for whom subscription is being created in form /users/{userId}
+        """
+        return pulumi.get(self, "owner_id")
+
+    @owner_id.setter
+    def owner_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "owner_id", value)
+
+    @property
+    @pulumi.getter(name="primaryKey")
+    def primary_key(self) -> Optional[pulumi.Input[str]]:
+        """
+        Primary subscription key. If not specified during request key will be generated automatically.
+        """
+        return pulumi.get(self, "primary_key")
+
+    @primary_key.setter
+    def primary_key(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "primary_key", value)
+
+    @property
+    @pulumi.getter(name="secondaryKey")
+    def secondary_key(self) -> Optional[pulumi.Input[str]]:
+        """
+        Secondary subscription key. If not specified during request key will be generated automatically.
+        """
+        return pulumi.get(self, "secondary_key")
+
+    @secondary_key.setter
+    def secondary_key(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "secondary_key", value)
+
+    @property
+    @pulumi.getter
+    def sid(self) -> Optional[pulumi.Input[str]]:
+        """
+        Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
+        """
+        return pulumi.get(self, "sid")
+
+    @sid.setter
+    def sid(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "sid", value)
+
+    @property
+    @pulumi.getter
+    def state(self) -> Optional[pulumi.Input['SubscriptionState']]:
+        """
+        Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
+        """
+        return pulumi.get(self, "state")
+
+    @state.setter
+    def state(self, value: Optional[pulumi.Input['SubscriptionState']]):
+        pulumi.set(self, "state", value)
+
+
+class Subscription(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 allow_tracing: Optional[pulumi.Input[bool]] = None,
+                 app_type: Optional[pulumi.Input[str]] = None,
+                 display_name: Optional[pulumi.Input[str]] = None,
+                 notify: Optional[pulumi.Input[bool]] = None,
+                 owner_id: Optional[pulumi.Input[str]] = None,
+                 primary_key: Optional[pulumi.Input[str]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 scope: Optional[pulumi.Input[str]] = None,
+                 secondary_key: Optional[pulumi.Input[str]] = None,
+                 service_name: Optional[pulumi.Input[str]] = None,
+                 sid: Optional[pulumi.Input[str]] = None,
+                 state: Optional[pulumi.Input['SubscriptionState']] = None,
+                 __props__=None):
+        """
+        Subscription details.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[bool] allow_tracing: Determines whether tracing can be enabled
+        :param pulumi.Input[str] app_type: Determines the type of application which send the create user request. Default is legacy publisher portal.
+        :param pulumi.Input[str] display_name: Subscription name.
+        :param pulumi.Input[bool] notify: Notify change in Subscription State. 
+                - If false, do not send any email notification for change of state of subscription 
+                - If true, send email notification of change of state of subscription 
+        :param pulumi.Input[str] owner_id: User (user id path) for whom subscription is being created in form /users/{userId}
+        :param pulumi.Input[str] primary_key: Primary subscription key. If not specified during request key will be generated automatically.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[str] scope: Scope like /products/{productId} or /apis or /apis/{apiId}.
+        :param pulumi.Input[str] secondary_key: Secondary subscription key. If not specified during request key will be generated automatically.
+        :param pulumi.Input[str] service_name: The name of the API Management service.
+        :param pulumi.Input[str] sid: Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
+        :param pulumi.Input['SubscriptionState'] state: Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: SubscriptionArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Subscription details.
+
+        :param str resource_name: The name of the resource.
+        :param SubscriptionArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(SubscriptionArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 allow_tracing: Optional[pulumi.Input[bool]] = None,
+                 app_type: Optional[pulumi.Input[str]] = None,
+                 display_name: Optional[pulumi.Input[str]] = None,
+                 notify: Optional[pulumi.Input[bool]] = None,
+                 owner_id: Optional[pulumi.Input[str]] = None,
+                 primary_key: Optional[pulumi.Input[str]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 scope: Optional[pulumi.Input[str]] = None,
+                 secondary_key: Optional[pulumi.Input[str]] = None,
+                 service_name: Optional[pulumi.Input[str]] = None,
+                 sid: Optional[pulumi.Input[str]] = None,
+                 state: Optional[pulumi.Input['SubscriptionState']] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = SubscriptionArgs.__new__(SubscriptionArgs)
+
+            __props__.__dict__["allow_tracing"] = allow_tracing
+            __props__.__dict__["app_type"] = app_type
+            if display_name is None and not opts.urn:
+                raise TypeError("Missing required property 'display_name'")
+            __props__.__dict__["display_name"] = display_name
+            __props__.__dict__["notify"] = notify
+            __props__.__dict__["owner_id"] = owner_id
+            __props__.__dict__["primary_key"] = primary_key
+            if resource_group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'resource_group_name'")
+            __props__.__dict__["resource_group_name"] = resource_group_name
+            if scope is None and not opts.urn:
+                raise TypeError("Missing required property 'scope'")
+            __props__.__dict__["scope"] = scope
+            __props__.__dict__["secondary_key"] = secondary_key
+            if service_name is None and not opts.urn:
+                raise TypeError("Missing required property 'service_name'")
+            __props__.__dict__["service_name"] = service_name
+            __props__.__dict__["sid"] = sid
+            __props__.__dict__["state"] = state
+            __props__.__dict__["created_date"] = None
+            __props__.__dict__["end_date"] = None
+            __props__.__dict__["expiration_date"] = None
+            __props__.__dict__["name"] = None
+            __props__.__dict__["notification_date"] = None
+            __props__.__dict__["start_date"] = None
+            __props__.__dict__["state_comment"] = None
+            __props__.__dict__["type"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="azure-native:apimanagement:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20160707:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20161010:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20170301:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20180101:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20180601preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20190101:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20191201:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20191201preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20200601preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20201201:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20210101preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20210401preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20210801:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20211201preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20220401preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20220801:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20220901preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20230301preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20230501preview:Subscription"), pulumi.Alias(type_="azure-native:apimanagement/v20230901preview:Subscription")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(Subscription, __self__).__init__(
+            'azure-native:apimanagement/v20240501:Subscription',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'Subscription':
+        """
+        Get an existing Subscription resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = SubscriptionArgs.__new__(SubscriptionArgs)
+
+        __props__.__dict__["allow_tracing"] = None
+        __props__.__dict__["created_date"] = None
+        __props__.__dict__["display_name"] = None
+        __props__.__dict__["end_date"] = None
+        __props__.__dict__["expiration_date"] = None
+        __props__.__dict__["name"] = None
+        __props__.__dict__["notification_date"] = None
+        __props__.__dict__["owner_id"] = None
+        __props__.__dict__["primary_key"] = None
+        __props__.__dict__["scope"] = None
+        __props__.__dict__["secondary_key"] = None
+        __props__.__dict__["start_date"] = None
+        __props__.__dict__["state"] = None
+        __props__.__dict__["state_comment"] = None
+        __props__.__dict__["type"] = None
+        return Subscription(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="allowTracing")
+    def allow_tracing(self) -> pulumi.Output[Optional[bool]]:
+        """
+        Determines whether tracing is enabled
+        """
+        return pulumi.get(self, "allow_tracing")
+
+    @property
+    @pulumi.getter(name="createdDate")
+    def created_date(self) -> pulumi.Output[str]:
+        """
+        Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
+        """
+        return pulumi.get(self, "created_date")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> pulumi.Output[Optional[str]]:
+        """
+        The name of the subscription, or null if the subscription has no name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter(name="endDate")
+    def end_date(self) -> pulumi.Output[Optional[str]]:
+        """
+        Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
+        """
+        return pulumi.get(self, "end_date")
+
+    @property
+    @pulumi.getter(name="expirationDate")
+    def expiration_date(self) -> pulumi.Output[Optional[str]]:
+        """
+        Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
+        """
+        return pulumi.get(self, "expiration_date")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="notificationDate")
+    def notification_date(self) -> pulumi.Output[Optional[str]]:
+        """
+        Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
+        """
+        return pulumi.get(self, "notification_date")
+
+    @property
+    @pulumi.getter(name="ownerId")
+    def owner_id(self) -> pulumi.Output[Optional[str]]:
+        """
+        The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
+        """
+        return pulumi.get(self, "owner_id")
+
+    @property
+    @pulumi.getter(name="primaryKey")
+    def primary_key(self) -> pulumi.Output[Optional[str]]:
+        """
+        Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
+        """
+        return pulumi.get(self, "primary_key")
+
+    @property
+    @pulumi.getter
+    def scope(self) -> pulumi.Output[str]:
+        """
+        Scope like /products/{productId} or /apis or /apis/{apiId}.
+        """
+        return pulumi.get(self, "scope")
+
+    @property
+    @pulumi.getter(name="secondaryKey")
+    def secondary_key(self) -> pulumi.Output[Optional[str]]:
+        """
+        Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
+        """
+        return pulumi.get(self, "secondary_key")
+
+    @property
+    @pulumi.getter(name="startDate")
+    def start_date(self) -> pulumi.Output[Optional[str]]:
+        """
+        Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
+        """
+        return pulumi.get(self, "start_date")
+
+    @property
+    @pulumi.getter
+    def state(self) -> pulumi.Output[str]:
+        """
+        Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
+        """
+        return pulumi.get(self, "state")
+
+    @property
+    @pulumi.getter(name="stateComment")
+    def state_comment(self) -> pulumi.Output[Optional[str]]:
+        """
+        Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
+        """
+        return pulumi.get(self, "state_comment")
+
+    @property
+    @pulumi.getter
+    def type(self) -> pulumi.Output[str]:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+