pulumi-azure-native 2.60.0a1725532600__py3-none-any.whl → 2.60.0a1725868360__py3-none-any.whl

pulumi_azure_native/apimanagement/v20240501/get_workspace_api_release.py

@@ -0,0 +1,176 @@
+# 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
+
+__all__ = [
+    'GetWorkspaceApiReleaseResult',
+    'AwaitableGetWorkspaceApiReleaseResult',
+    'get_workspace_api_release',
+    'get_workspace_api_release_output',
+]
+
+@pulumi.output_type
+class GetWorkspaceApiReleaseResult:
+    """
+    ApiRelease details.
+    """
+    def __init__(__self__, api_id=None, created_date_time=None, id=None, name=None, notes=None, type=None, updated_date_time=None):
+        if api_id and not isinstance(api_id, str):
+            raise TypeError("Expected argument 'api_id' to be a str")
+        pulumi.set(__self__, "api_id", api_id)
+        if created_date_time and not isinstance(created_date_time, str):
+            raise TypeError("Expected argument 'created_date_time' to be a str")
+        pulumi.set(__self__, "created_date_time", created_date_time)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if notes and not isinstance(notes, str):
+            raise TypeError("Expected argument 'notes' to be a str")
+        pulumi.set(__self__, "notes", notes)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if updated_date_time and not isinstance(updated_date_time, str):
+            raise TypeError("Expected argument 'updated_date_time' to be a str")
+        pulumi.set(__self__, "updated_date_time", updated_date_time)
+
+    @property
+    @pulumi.getter(name="apiId")
+    def api_id(self) -> Optional[str]:
+        """
+        Identifier of the API the release belongs to.
+        """
+        return pulumi.get(self, "api_id")
+
+    @property
+    @pulumi.getter(name="createdDateTime")
+    def created_date_time(self) -> str:
+        """
+        The time the API was released. 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_time")
+
+    @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 name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def notes(self) -> Optional[str]:
+        """
+        Release Notes
+        """
+        return pulumi.get(self, "notes")
+
+    @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="updatedDateTime")
+    def updated_date_time(self) -> str:
+        """
+        The time the API release was updated.
+        """
+        return pulumi.get(self, "updated_date_time")
+
+
+class AwaitableGetWorkspaceApiReleaseResult(GetWorkspaceApiReleaseResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetWorkspaceApiReleaseResult(
+            api_id=self.api_id,
+            created_date_time=self.created_date_time,
+            id=self.id,
+            name=self.name,
+            notes=self.notes,
+            type=self.type,
+            updated_date_time=self.updated_date_time)
+
+
+def get_workspace_api_release(api_id: Optional[str] = None,
+                              release_id: Optional[str] = None,
+                              resource_group_name: Optional[str] = None,
+                              service_name: Optional[str] = None,
+                              workspace_id: Optional[str] = None,
+                              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetWorkspaceApiReleaseResult:
+    """
+    Returns the details of an API release.
+
+
+    :param str api_id: API identifier. Must be unique in the current API Management service instance.
+    :param str release_id: Release identifier within an API. Must be unique in the current API Management service instance.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of the API Management service.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    __args__ = dict()
+    __args__['apiId'] = api_id
+    __args__['releaseId'] = release_id
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['serviceName'] = service_name
+    __args__['workspaceId'] = workspace_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:apimanagement/v20240501:getWorkspaceApiRelease', __args__, opts=opts, typ=GetWorkspaceApiReleaseResult).value
+
+    return AwaitableGetWorkspaceApiReleaseResult(
+        api_id=pulumi.get(__ret__, 'api_id'),
+        created_date_time=pulumi.get(__ret__, 'created_date_time'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        notes=pulumi.get(__ret__, 'notes'),
+        type=pulumi.get(__ret__, 'type'),
+        updated_date_time=pulumi.get(__ret__, 'updated_date_time'))
+
+
+@_utilities.lift_output_func(get_workspace_api_release)
+def get_workspace_api_release_output(api_id: Optional[pulumi.Input[str]] = None,
+                                     release_id: Optional[pulumi.Input[str]] = None,
+                                     resource_group_name: Optional[pulumi.Input[str]] = None,
+                                     service_name: Optional[pulumi.Input[str]] = None,
+                                     workspace_id: Optional[pulumi.Input[str]] = None,
+                                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetWorkspaceApiReleaseResult]:
+    """
+    Returns the details of an API release.
+
+
+    :param str api_id: API identifier. Must be unique in the current API Management service instance.
+    :param str release_id: Release identifier within an API. Must be unique in the current API Management service instance.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of the API Management service.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    ...

pulumi_azure_native/apimanagement/v20240501/get_workspace_api_schema.py

@@ -0,0 +1,189 @@
+# 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
+
+__all__ = [
+    'GetWorkspaceApiSchemaResult',
+    'AwaitableGetWorkspaceApiSchemaResult',
+    'get_workspace_api_schema',
+    'get_workspace_api_schema_output',
+]
+
+@pulumi.output_type
+class GetWorkspaceApiSchemaResult:
+    """
+    API Schema Contract details.
+    """
+    def __init__(__self__, components=None, content_type=None, definitions=None, id=None, name=None, provisioning_state=None, type=None, value=None):
+        if components and not isinstance(components, dict):
+            raise TypeError("Expected argument 'components' to be a dict")
+        pulumi.set(__self__, "components", components)
+        if content_type and not isinstance(content_type, str):
+            raise TypeError("Expected argument 'content_type' to be a str")
+        pulumi.set(__self__, "content_type", content_type)
+        if definitions and not isinstance(definitions, dict):
+            raise TypeError("Expected argument 'definitions' to be a dict")
+        pulumi.set(__self__, "definitions", definitions)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if provisioning_state and not isinstance(provisioning_state, str):
+            raise TypeError("Expected argument 'provisioning_state' to be a str")
+        pulumi.set(__self__, "provisioning_state", provisioning_state)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if value and not isinstance(value, str):
+            raise TypeError("Expected argument 'value' to be a str")
+        pulumi.set(__self__, "value", value)
+
+    @property
+    @pulumi.getter
+    def components(self) -> Optional[Any]:
+        """
+        Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
+        """
+        return pulumi.get(self, "components")
+
+    @property
+    @pulumi.getter(name="contentType")
+    def content_type(self) -> str:
+        """
+        Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml` </br> - `OData Schema` use `application/vnd.ms-azure-apim.odata.schema` </br> - `gRPC Schema` use `text/protobuf`.
+        """
+        return pulumi.get(self, "content_type")
+
+    @property
+    @pulumi.getter
+    def definitions(self) -> Optional[Any]:
+        """
+        Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
+        """
+        return pulumi.get(self, "definitions")
+
+    @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 name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        The provisioning state
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @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
+    def value(self) -> Optional[str]:
+        """
+        Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
+        """
+        return pulumi.get(self, "value")
+
+
+class AwaitableGetWorkspaceApiSchemaResult(GetWorkspaceApiSchemaResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetWorkspaceApiSchemaResult(
+            components=self.components,
+            content_type=self.content_type,
+            definitions=self.definitions,
+            id=self.id,
+            name=self.name,
+            provisioning_state=self.provisioning_state,
+            type=self.type,
+            value=self.value)
+
+
+def get_workspace_api_schema(api_id: Optional[str] = None,
+                             resource_group_name: Optional[str] = None,
+                             schema_id: Optional[str] = None,
+                             service_name: Optional[str] = None,
+                             workspace_id: Optional[str] = None,
+                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetWorkspaceApiSchemaResult:
+    """
+    Get the schema configuration at the API level.
+
+
+    :param str api_id: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str schema_id: Schema id identifier. Must be unique in the current API Management service instance.
+    :param str service_name: The name of the API Management service.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    __args__ = dict()
+    __args__['apiId'] = api_id
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['schemaId'] = schema_id
+    __args__['serviceName'] = service_name
+    __args__['workspaceId'] = workspace_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:apimanagement/v20240501:getWorkspaceApiSchema', __args__, opts=opts, typ=GetWorkspaceApiSchemaResult).value
+
+    return AwaitableGetWorkspaceApiSchemaResult(
+        components=pulumi.get(__ret__, 'components'),
+        content_type=pulumi.get(__ret__, 'content_type'),
+        definitions=pulumi.get(__ret__, 'definitions'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        type=pulumi.get(__ret__, 'type'),
+        value=pulumi.get(__ret__, 'value'))
+
+
+@_utilities.lift_output_func(get_workspace_api_schema)
+def get_workspace_api_schema_output(api_id: Optional[pulumi.Input[str]] = None,
+                                    resource_group_name: Optional[pulumi.Input[str]] = None,
+                                    schema_id: Optional[pulumi.Input[str]] = None,
+                                    service_name: Optional[pulumi.Input[str]] = None,
+                                    workspace_id: Optional[pulumi.Input[str]] = None,
+                                    opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetWorkspaceApiSchemaResult]:
+    """
+    Get the schema configuration at the API level.
+
+
+    :param str api_id: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str schema_id: Schema id identifier. Must be unique in the current API Management service instance.
+    :param str service_name: The name of the API Management service.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    ...

pulumi_azure_native/apimanagement/v20240501/get_workspace_api_version_set.py

@@ -0,0 +1,184 @@
+# 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
+
+__all__ = [
+    'GetWorkspaceApiVersionSetResult',
+    'AwaitableGetWorkspaceApiVersionSetResult',
+    'get_workspace_api_version_set',
+    'get_workspace_api_version_set_output',
+]
+
+@pulumi.output_type
+class GetWorkspaceApiVersionSetResult:
+    """
+    API Version Set Contract details.
+    """
+    def __init__(__self__, description=None, display_name=None, id=None, name=None, type=None, version_header_name=None, version_query_name=None, versioning_scheme=None):
+        if description and not isinstance(description, str):
+            raise TypeError("Expected argument 'description' to be a str")
+        pulumi.set(__self__, "description", description)
+        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 id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if version_header_name and not isinstance(version_header_name, str):
+            raise TypeError("Expected argument 'version_header_name' to be a str")
+        pulumi.set(__self__, "version_header_name", version_header_name)
+        if version_query_name and not isinstance(version_query_name, str):
+            raise TypeError("Expected argument 'version_query_name' to be a str")
+        pulumi.set(__self__, "version_query_name", version_query_name)
+        if versioning_scheme and not isinstance(versioning_scheme, str):
+            raise TypeError("Expected argument 'versioning_scheme' to be a str")
+        pulumi.set(__self__, "versioning_scheme", versioning_scheme)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[str]:
+        """
+        Description of API Version Set.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> str:
+        """
+        Name of API Version Set
+        """
+        return pulumi.get(self, "display_name")
+
+    @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 name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @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="versionHeaderName")
+    def version_header_name(self) -> Optional[str]:
+        """
+        Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
+        """
+        return pulumi.get(self, "version_header_name")
+
+    @property
+    @pulumi.getter(name="versionQueryName")
+    def version_query_name(self) -> Optional[str]:
+        """
+        Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
+        """
+        return pulumi.get(self, "version_query_name")
+
+    @property
+    @pulumi.getter(name="versioningScheme")
+    def versioning_scheme(self) -> str:
+        """
+        An value that determines where the API Version identifier will be located in a HTTP request.
+        """
+        return pulumi.get(self, "versioning_scheme")
+
+
+class AwaitableGetWorkspaceApiVersionSetResult(GetWorkspaceApiVersionSetResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetWorkspaceApiVersionSetResult(
+            description=self.description,
+            display_name=self.display_name,
+            id=self.id,
+            name=self.name,
+            type=self.type,
+            version_header_name=self.version_header_name,
+            version_query_name=self.version_query_name,
+            versioning_scheme=self.versioning_scheme)
+
+
+def get_workspace_api_version_set(resource_group_name: Optional[str] = None,
+                                  service_name: Optional[str] = None,
+                                  version_set_id: Optional[str] = None,
+                                  workspace_id: Optional[str] = None,
+                                  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetWorkspaceApiVersionSetResult:
+    """
+    Gets the details of the Api Version Set specified by its identifier.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of the API Management service.
+    :param str version_set_id: Api Version Set identifier. Must be unique in the current API Management service instance.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    __args__ = dict()
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['serviceName'] = service_name
+    __args__['versionSetId'] = version_set_id
+    __args__['workspaceId'] = workspace_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:apimanagement/v20240501:getWorkspaceApiVersionSet', __args__, opts=opts, typ=GetWorkspaceApiVersionSetResult).value
+
+    return AwaitableGetWorkspaceApiVersionSetResult(
+        description=pulumi.get(__ret__, 'description'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        type=pulumi.get(__ret__, 'type'),
+        version_header_name=pulumi.get(__ret__, 'version_header_name'),
+        version_query_name=pulumi.get(__ret__, 'version_query_name'),
+        versioning_scheme=pulumi.get(__ret__, 'versioning_scheme'))
+
+
+@_utilities.lift_output_func(get_workspace_api_version_set)
+def get_workspace_api_version_set_output(resource_group_name: Optional[pulumi.Input[str]] = None,
+                                         service_name: Optional[pulumi.Input[str]] = None,
+                                         version_set_id: Optional[pulumi.Input[str]] = None,
+                                         workspace_id: Optional[pulumi.Input[str]] = None,
+                                         opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetWorkspaceApiVersionSetResult]:
+    """
+    Gets the details of the Api Version Set specified by its identifier.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str service_name: The name of the API Management service.
+    :param str version_set_id: Api Version Set identifier. Must be unique in the current API Management service instance.
+    :param str workspace_id: Workspace identifier. Must be unique in the current API Management service instance.
+    """
+    ...