pulumi-azure-native 2.38.0__py3-none-any.whl → 2.38.1a1714382243__py3-none-any.whl

pulumi_azure_native/costmanagement/v20230701preview/get_export.py

@@ -0,0 +1,292 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetExportResult',
+    'AwaitableGetExportResult',
+    'get_export',
+    'get_export_output',
+]
+
+@pulumi.output_type
+class GetExportResult:
+    """
+    An export resource.
+    """
+    def __init__(__self__, compression_mode=None, data_overwrite_behavior=None, definition=None, delivery_info=None, e_tag=None, export_description=None, format=None, id=None, identity=None, location=None, name=None, next_run_time_estimate=None, partition_data=None, run_history=None, schedule=None, system_suspension_context=None, type=None):
+        if compression_mode and not isinstance(compression_mode, str):
+            raise TypeError("Expected argument 'compression_mode' to be a str")
+        pulumi.set(__self__, "compression_mode", compression_mode)
+        if data_overwrite_behavior and not isinstance(data_overwrite_behavior, str):
+            raise TypeError("Expected argument 'data_overwrite_behavior' to be a str")
+        pulumi.set(__self__, "data_overwrite_behavior", data_overwrite_behavior)
+        if definition and not isinstance(definition, dict):
+            raise TypeError("Expected argument 'definition' to be a dict")
+        pulumi.set(__self__, "definition", definition)
+        if delivery_info and not isinstance(delivery_info, dict):
+            raise TypeError("Expected argument 'delivery_info' to be a dict")
+        pulumi.set(__self__, "delivery_info", delivery_info)
+        if e_tag and not isinstance(e_tag, str):
+            raise TypeError("Expected argument 'e_tag' to be a str")
+        pulumi.set(__self__, "e_tag", e_tag)
+        if export_description and not isinstance(export_description, str):
+            raise TypeError("Expected argument 'export_description' to be a str")
+        pulumi.set(__self__, "export_description", export_description)
+        if format and not isinstance(format, str):
+            raise TypeError("Expected argument 'format' to be a str")
+        pulumi.set(__self__, "format", format)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        if location and not isinstance(location, str):
+            raise TypeError("Expected argument 'location' to be a str")
+        pulumi.set(__self__, "location", location)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if next_run_time_estimate and not isinstance(next_run_time_estimate, str):
+            raise TypeError("Expected argument 'next_run_time_estimate' to be a str")
+        pulumi.set(__self__, "next_run_time_estimate", next_run_time_estimate)
+        if partition_data and not isinstance(partition_data, bool):
+            raise TypeError("Expected argument 'partition_data' to be a bool")
+        pulumi.set(__self__, "partition_data", partition_data)
+        if run_history and not isinstance(run_history, dict):
+            raise TypeError("Expected argument 'run_history' to be a dict")
+        pulumi.set(__self__, "run_history", run_history)
+        if schedule and not isinstance(schedule, dict):
+            raise TypeError("Expected argument 'schedule' to be a dict")
+        pulumi.set(__self__, "schedule", schedule)
+        if system_suspension_context and not isinstance(system_suspension_context, dict):
+            raise TypeError("Expected argument 'system_suspension_context' to be a dict")
+        pulumi.set(__self__, "system_suspension_context", system_suspension_context)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="compressionMode")
+    def compression_mode(self) -> Optional[str]:
+        """
+        Allow customers to select compress data(gzip) for exports. This setting will enable destination file compression scheme at runtime. By default set to None.
+        """
+        return pulumi.get(self, "compression_mode")
+
+    @property
+    @pulumi.getter(name="dataOverwriteBehavior")
+    def data_overwrite_behavior(self) -> Optional[str]:
+        """
+        Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.
+        """
+        return pulumi.get(self, "data_overwrite_behavior")
+
+    @property
+    @pulumi.getter
+    def definition(self) -> 'outputs.ExportDefinitionResponse':
+        """
+        Has the definition for the export.
+        """
+        return pulumi.get(self, "definition")
+
+    @property
+    @pulumi.getter(name="deliveryInfo")
+    def delivery_info(self) -> 'outputs.ExportDeliveryInfoResponse':
+        """
+        Has delivery information for the export.
+        """
+        return pulumi.get(self, "delivery_info")
+
+    @property
+    @pulumi.getter(name="eTag")
+    def e_tag(self) -> Optional[str]:
+        """
+        eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
+        """
+        return pulumi.get(self, "e_tag")
+
+    @property
+    @pulumi.getter(name="exportDescription")
+    def export_description(self) -> Optional[str]:
+        """
+        The export description set by customer at time of export creation/update.
+        """
+        return pulumi.get(self, "export_description")
+
+    @property
+    @pulumi.getter
+    def format(self) -> Optional[str]:
+        """
+        The format of the export being delivered. Currently only 'Csv' is supported.
+        """
+        return pulumi.get(self, "format")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource Id.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.SystemAssignedServiceIdentityResponse']:
+        """
+        The managed identity associated with Export
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter
+    def location(self) -> Optional[str]:
+        """
+        The location of the Export's managed identity. Only required when utilizing managed identity.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        Resource name.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="nextRunTimeEstimate")
+    def next_run_time_estimate(self) -> str:
+        """
+        If the export has an active schedule, provides an estimate of the next run time.
+        """
+        return pulumi.get(self, "next_run_time_estimate")
+
+    @property
+    @pulumi.getter(name="partitionData")
+    def partition_data(self) -> Optional[bool]:
+        """
+        If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes.
+        """
+        return pulumi.get(self, "partition_data")
+
+    @property
+    @pulumi.getter(name="runHistory")
+    def run_history(self) -> Optional['outputs.ExportExecutionListResultResponse']:
+        """
+        If requested, has the most recent run history for the export.
+        """
+        return pulumi.get(self, "run_history")
+
+    @property
+    @pulumi.getter
+    def schedule(self) -> Optional['outputs.ExportScheduleResponse']:
+        """
+        Has schedule information for the export.
+        """
+        return pulumi.get(self, "schedule")
+
+    @property
+    @pulumi.getter(name="systemSuspensionContext")
+    def system_suspension_context(self) -> 'outputs.ExportSuspensionContextResponse':
+        """
+        The export suspension reason if export is in SystemSuspended state.
+        """
+        return pulumi.get(self, "system_suspension_context")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetExportResult(GetExportResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetExportResult(
+            compression_mode=self.compression_mode,
+            data_overwrite_behavior=self.data_overwrite_behavior,
+            definition=self.definition,
+            delivery_info=self.delivery_info,
+            e_tag=self.e_tag,
+            export_description=self.export_description,
+            format=self.format,
+            id=self.id,
+            identity=self.identity,
+            location=self.location,
+            name=self.name,
+            next_run_time_estimate=self.next_run_time_estimate,
+            partition_data=self.partition_data,
+            run_history=self.run_history,
+            schedule=self.schedule,
+            system_suspension_context=self.system_suspension_context,
+            type=self.type)
+
+
+def get_export(expand: Optional[str] = None,
+               export_name: Optional[str] = None,
+               scope: Optional[str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetExportResult:
+    """
+    The operation to get the export for the defined scope by export name.
+
+
+    :param str expand: May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export.
+    :param str export_name: Export Name.
+    :param str scope: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
+    """
+    __args__ = dict()
+    __args__['expand'] = expand
+    __args__['exportName'] = export_name
+    __args__['scope'] = scope
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:costmanagement/v20230701preview:getExport', __args__, opts=opts, typ=GetExportResult).value
+
+    return AwaitableGetExportResult(
+        compression_mode=pulumi.get(__ret__, 'compression_mode'),
+        data_overwrite_behavior=pulumi.get(__ret__, 'data_overwrite_behavior'),
+        definition=pulumi.get(__ret__, 'definition'),
+        delivery_info=pulumi.get(__ret__, 'delivery_info'),
+        e_tag=pulumi.get(__ret__, 'e_tag'),
+        export_description=pulumi.get(__ret__, 'export_description'),
+        format=pulumi.get(__ret__, 'format'),
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        next_run_time_estimate=pulumi.get(__ret__, 'next_run_time_estimate'),
+        partition_data=pulumi.get(__ret__, 'partition_data'),
+        run_history=pulumi.get(__ret__, 'run_history'),
+        schedule=pulumi.get(__ret__, 'schedule'),
+        system_suspension_context=pulumi.get(__ret__, 'system_suspension_context'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_export)
+def get_export_output(expand: Optional[pulumi.Input[Optional[str]]] = None,
+                      export_name: Optional[pulumi.Input[str]] = None,
+                      scope: Optional[pulumi.Input[str]] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetExportResult]:
+    """
+    The operation to get the export for the defined scope by export name.
+
+
+    :param str expand: May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export.
+    :param str export_name: Export Name.
+    :param str scope: The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
+    """
+    ...

pulumi_azure_native/costmanagement/v20230701preview/get_scheduled_action.py

@@ -0,0 +1,243 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetScheduledActionResult',
+    'AwaitableGetScheduledActionResult',
+    'get_scheduled_action',
+    'get_scheduled_action_output',
+]
+
+@pulumi.output_type
+class GetScheduledActionResult:
+    """
+    Scheduled action definition.
+    """
+    def __init__(__self__, display_name=None, e_tag=None, file_destination=None, id=None, kind=None, name=None, notification=None, notification_email=None, schedule=None, scope=None, status=None, system_data=None, type=None, view_id=None):
+        if display_name and not isinstance(display_name, str):
+            raise TypeError("Expected argument 'display_name' to be a str")
+        pulumi.set(__self__, "display_name", display_name)
+        if e_tag and not isinstance(e_tag, str):
+            raise TypeError("Expected argument 'e_tag' to be a str")
+        pulumi.set(__self__, "e_tag", e_tag)
+        if file_destination and not isinstance(file_destination, dict):
+            raise TypeError("Expected argument 'file_destination' to be a dict")
+        pulumi.set(__self__, "file_destination", file_destination)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if kind and not isinstance(kind, str):
+            raise TypeError("Expected argument 'kind' to be a str")
+        pulumi.set(__self__, "kind", kind)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if notification and not isinstance(notification, dict):
+            raise TypeError("Expected argument 'notification' to be a dict")
+        pulumi.set(__self__, "notification", notification)
+        if notification_email and not isinstance(notification_email, str):
+            raise TypeError("Expected argument 'notification_email' to be a str")
+        pulumi.set(__self__, "notification_email", notification_email)
+        if schedule and not isinstance(schedule, dict):
+            raise TypeError("Expected argument 'schedule' to be a dict")
+        pulumi.set(__self__, "schedule", schedule)
+        if scope and not isinstance(scope, str):
+            raise TypeError("Expected argument 'scope' to be a str")
+        pulumi.set(__self__, "scope", scope)
+        if status and not isinstance(status, str):
+            raise TypeError("Expected argument 'status' to be a str")
+        pulumi.set(__self__, "status", status)
+        if system_data and not isinstance(system_data, dict):
+            raise TypeError("Expected argument 'system_data' to be a dict")
+        pulumi.set(__self__, "system_data", system_data)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if view_id and not isinstance(view_id, str):
+            raise TypeError("Expected argument 'view_id' to be a str")
+        pulumi.set(__self__, "view_id", view_id)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> str:
+        """
+        Scheduled action name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter(name="eTag")
+    def e_tag(self) -> str:
+        """
+        Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required.
+        """
+        return pulumi.get(self, "e_tag")
+
+    @property
+    @pulumi.getter(name="fileDestination")
+    def file_destination(self) -> Optional['outputs.FileDestinationResponse']:
+        """
+        Destination format of the view data. This is optional.
+        """
+        return pulumi.get(self, "file_destination")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def kind(self) -> Optional[str]:
+        """
+        Kind of the scheduled action.
+        """
+        return pulumi.get(self, "kind")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def notification(self) -> 'outputs.NotificationPropertiesResponse':
+        """
+        Notification properties based on scheduled action kind.
+        """
+        return pulumi.get(self, "notification")
+
+    @property
+    @pulumi.getter(name="notificationEmail")
+    def notification_email(self) -> Optional[str]:
+        """
+        Email address of the point of contact that should get the unsubscribe requests and notification emails.
+        """
+        return pulumi.get(self, "notification_email")
+
+    @property
+    @pulumi.getter
+    def schedule(self) -> 'outputs.SchedulePropertiesResponse':
+        """
+        Schedule of the scheduled action.
+        """
+        return pulumi.get(self, "schedule")
+
+    @property
+    @pulumi.getter
+    def scope(self) -> Optional[str]:
+        """
+        For private scheduled action(Create or Update), scope will be empty.<br /> For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
+        """
+        return pulumi.get(self, "scope")
+
+    @property
+    @pulumi.getter
+    def status(self) -> str:
+        """
+        Status of the scheduled action.
+        """
+        return pulumi.get(self, "status")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Kind of the scheduled action.
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter(name="viewId")
+    def view_id(self) -> str:
+        """
+        Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'
+        """
+        return pulumi.get(self, "view_id")
+
+
+class AwaitableGetScheduledActionResult(GetScheduledActionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetScheduledActionResult(
+            display_name=self.display_name,
+            e_tag=self.e_tag,
+            file_destination=self.file_destination,
+            id=self.id,
+            kind=self.kind,
+            name=self.name,
+            notification=self.notification,
+            notification_email=self.notification_email,
+            schedule=self.schedule,
+            scope=self.scope,
+            status=self.status,
+            system_data=self.system_data,
+            type=self.type,
+            view_id=self.view_id)
+
+
+def get_scheduled_action(name: Optional[str] = None,
+                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetScheduledActionResult:
+    """
+    Get the private scheduled action by name.
+
+
+    :param str name: Scheduled action name.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:costmanagement/v20230701preview:getScheduledAction', __args__, opts=opts, typ=GetScheduledActionResult).value
+
+    return AwaitableGetScheduledActionResult(
+        display_name=pulumi.get(__ret__, 'display_name'),
+        e_tag=pulumi.get(__ret__, 'e_tag'),
+        file_destination=pulumi.get(__ret__, 'file_destination'),
+        id=pulumi.get(__ret__, 'id'),
+        kind=pulumi.get(__ret__, 'kind'),
+        name=pulumi.get(__ret__, 'name'),
+        notification=pulumi.get(__ret__, 'notification'),
+        notification_email=pulumi.get(__ret__, 'notification_email'),
+        schedule=pulumi.get(__ret__, 'schedule'),
+        scope=pulumi.get(__ret__, 'scope'),
+        status=pulumi.get(__ret__, 'status'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        type=pulumi.get(__ret__, 'type'),
+        view_id=pulumi.get(__ret__, 'view_id'))
+
+
+@_utilities.lift_output_func(get_scheduled_action)
+def get_scheduled_action_output(name: Optional[pulumi.Input[str]] = None,
+                                opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetScheduledActionResult]:
+    """
+    Get the private scheduled action by name.
+
+
+    :param str name: Scheduled action name.
+    """
+    ...