pulumi-azuread 5.48.0a1706744699__py3-none-any.whl → 6.8.0a1766208344__py3-none-any.whl

pulumi_azuread/get_service_principal.py

@@ -1,12 +1,17 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** 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 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
 
@@ -22,7 +27,7 @@ class GetServicePrincipalResult:
     """
     A collection of values returned by getServicePrincipal.
     """
-    def __init__(__self__, account_enabled=None, alternative_names=None, app_role_assignment_required=None, app_role_ids=None, app_roles=None, application_id=None, application_tenant_id=None, client_id=None, description=None, display_name=None, feature_tags=None, features=None, homepage_url=None, id=None, login_url=None, logout_url=None, notes=None, notification_email_addresses=None, oauth2_permission_scope_ids=None, oauth2_permission_scopes=None, object_id=None, preferred_single_sign_on_mode=None, redirect_uris=None, saml_metadata_url=None, saml_single_sign_ons=None, service_principal_names=None, sign_in_audience=None, tags=None, type=None):
+    def __init__(__self__, account_enabled=None, alternative_names=None, app_role_assignment_required=None, app_role_ids=None, app_roles=None, application_tenant_id=None, client_id=None, description=None, display_name=None, feature_tags=None, features=None, homepage_url=None, id=None, login_url=None, logout_url=None, notes=None, notification_email_addresses=None, oauth2_permission_scope_ids=None, oauth2_permission_scopes=None, object_id=None, preferred_single_sign_on_mode=None, redirect_uris=None, saml_metadata_url=None, saml_single_sign_ons=None, service_principal_names=None, sign_in_audience=None, tags=None, type=None):
         if account_enabled and not isinstance(account_enabled, bool):
             raise TypeError("Expected argument 'account_enabled' to be a bool")
         pulumi.set(__self__, "account_enabled", account_enabled)
@@ -38,9 +43,6 @@ class GetServicePrincipalResult:
         if app_roles and not isinstance(app_roles, list):
             raise TypeError("Expected argument 'app_roles' to be a list")
         pulumi.set(__self__, "app_roles", app_roles)
-        if application_id and not isinstance(application_id, str):
-            raise TypeError("Expected argument 'application_id' to be a str")
-        pulumi.set(__self__, "application_id", application_id)
         if application_tenant_id and not isinstance(application_tenant_id, str):
             raise TypeError("Expected argument 'application_tenant_id' to be a str")
         pulumi.set(__self__, "application_tenant_id", application_tenant_id)
@@ -111,39 +113,39 @@ class GetServicePrincipalResult:
             raise TypeError("Expected argument 'type' to be a str")
         pulumi.set(__self__, "type", type)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountEnabled")
-    def account_enabled(self) -> bool:
+    def account_enabled(self) -> _builtins.bool:
         """
         Whether the service principal account is enabled.
         """
         return pulumi.get(self, "account_enabled")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="alternativeNames")
-    def alternative_names(self) -> Sequence[str]:
+    def alternative_names(self) -> Sequence[_builtins.str]:
         """
         A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
         """
         return pulumi.get(self, "alternative_names")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="appRoleAssignmentRequired")
-    def app_role_assignment_required(self) -> bool:
+    def app_role_assignment_required(self) -> _builtins.bool:
         """
         Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application.
         """
         return pulumi.get(self, "app_role_assignment_required")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="appRoleIds")
-    def app_role_ids(self) -> Mapping[str, str]:
+    def app_role_ids(self) -> Mapping[str, _builtins.str]:
         """
         A mapping of app role values to app role IDs, as published by the associated application, intended to be useful when referencing app roles in other resources in your configuration.
         """
         return pulumi.get(self, "app_role_ids")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="appRoles")
     def app_roles(self) -> Sequence['outputs.GetServicePrincipalAppRoleResult']:
         """
@@ -151,119 +153,109 @@ class GetServicePrincipalResult:
         """
         return pulumi.get(self, "app_roles")
 
-    @property
-    @pulumi.getter(name="applicationId")
-    def application_id(self) -> str:
-        warnings.warn("""The `application_id` property has been replaced with the `client_id` property and will be removed in version 3.0 of the AzureAD provider""", DeprecationWarning)
-        pulumi.log.warn("""application_id is deprecated: The `application_id` property has been replaced with the `client_id` property and will be removed in version 3.0 of the AzureAD provider""")
-
-        return pulumi.get(self, "application_id")
-
-    @property
+    @_builtins.property
     @pulumi.getter(name="applicationTenantId")
-    def application_tenant_id(self) -> str:
+    def application_tenant_id(self) -> _builtins.str:
         """
         The tenant ID where the associated application is registered.
         """
         return pulumi.get(self, "application_tenant_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="clientId")
-    def client_id(self) -> str:
+    def client_id(self) -> _builtins.str:
         """
         The client ID of the application associated with this service principal.
         """
         return pulumi.get(self, "client_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def description(self) -> str:
+    def description(self) -> _builtins.str:
         """
         Permission help text that appears in the admin app assignment and consent experiences.
         """
         return pulumi.get(self, "description")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="displayName")
-    def display_name(self) -> str:
+    def display_name(self) -> _builtins.str:
         """
         Display name for the permission that appears in the admin consent and app assignment experiences.
         """
         return pulumi.get(self, "display_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="featureTags")
     def feature_tags(self) -> Sequence['outputs.GetServicePrincipalFeatureTagResult']:
         return pulumi.get(self, "feature_tags")
 
-    @property
+    @_builtins.property
     @pulumi.getter
+    @_utilities.deprecated("""This block has been renamed to `feature_tags` and will be removed in version 3.0 of the provider""")
     def features(self) -> Sequence['outputs.GetServicePrincipalFeatureResult']:
         """
         A `features` block as described below.
         """
-        warnings.warn("""This block has been renamed to `feature_tags` and will be removed in version 3.0 of the provider""", DeprecationWarning)
-        pulumi.log.warn("""features is deprecated: This block has been renamed to `feature_tags` and will be removed in version 3.0 of the provider""")
-
         return pulumi.get(self, "features")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="homepageUrl")
-    def homepage_url(self) -> str:
+    def homepage_url(self) -> _builtins.str:
         """
         Home page or landing page of the associated application.
         """
         return pulumi.get(self, "homepage_url")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="loginUrl")
-    def login_url(self) -> str:
+    def login_url(self) -> _builtins.str:
         """
         The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps.
         """
         return pulumi.get(self, "login_url")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="logoutUrl")
-    def logout_url(self) -> str:
+    def logout_url(self) -> _builtins.str:
         """
         The URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols, taken from the associated application.
         """
         return pulumi.get(self, "logout_url")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def notes(self) -> str:
+    def notes(self) -> _builtins.str:
         """
         A free text field to capture information about the service principal, typically used for operational purposes.
         """
         return pulumi.get(self, "notes")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="notificationEmailAddresses")
-    def notification_email_addresses(self) -> Sequence[str]:
+    def notification_email_addresses(self) -> Sequence[_builtins.str]:
         """
         A list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
         """
         return pulumi.get(self, "notification_email_addresses")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="oauth2PermissionScopeIds")
-    def oauth2_permission_scope_ids(self) -> Mapping[str, str]:
+    def oauth2_permission_scope_ids(self) -> Mapping[str, _builtins.str]:
         """
         A mapping of OAuth2.0 permission scope values to scope IDs, as exposed by the associated application, intended to be useful when referencing permission scopes in other resources in your configuration.
         """
         return pulumi.get(self, "oauth2_permission_scope_ids")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="oauth2PermissionScopes")
     def oauth2_permission_scopes(self) -> Sequence['outputs.GetServicePrincipalOauth2PermissionScopeResult']:
         """
@@ -271,39 +263,39 @@ class GetServicePrincipalResult:
         """
         return pulumi.get(self, "oauth2_permission_scopes")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="objectId")
-    def object_id(self) -> str:
+    def object_id(self) -> _builtins.str:
         """
         The object ID of the service principal.
         """
         return pulumi.get(self, "object_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="preferredSingleSignOnMode")
-    def preferred_single_sign_on_mode(self) -> str:
+    def preferred_single_sign_on_mode(self) -> _builtins.str:
         """
         The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps.
         """
         return pulumi.get(self, "preferred_single_sign_on_mode")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="redirectUris")
-    def redirect_uris(self) -> Sequence[str]:
+    def redirect_uris(self) -> Sequence[_builtins.str]:
         """
         A list of URLs where user tokens are sent for sign-in with the associated application, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent for the associated application.
         """
         return pulumi.get(self, "redirect_uris")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="samlMetadataUrl")
-    def saml_metadata_url(self) -> str:
+    def saml_metadata_url(self) -> _builtins.str:
         """
         The URL where the service exposes SAML metadata for federation.
         """
         return pulumi.get(self, "saml_metadata_url")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="samlSingleSignOns")
     def saml_single_sign_ons(self) -> Sequence['outputs.GetServicePrincipalSamlSingleSignOnResult']:
         """
@@ -311,33 +303,33 @@ class GetServicePrincipalResult:
         """
         return pulumi.get(self, "saml_single_sign_ons")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="servicePrincipalNames")
-    def service_principal_names(self) -> Sequence[str]:
+    def service_principal_names(self) -> Sequence[_builtins.str]:
         """
         A list of identifier URI(s), copied over from the associated application.
         """
         return pulumi.get(self, "service_principal_names")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="signInAudience")
-    def sign_in_audience(self) -> str:
+    def sign_in_audience(self) -> _builtins.str:
         """
         The Microsoft account types that are supported for the associated application. Possible values include `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`.
         """
         return pulumi.get(self, "sign_in_audience")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def tags(self) -> Sequence[str]:
+    def tags(self) -> Sequence[_builtins.str]:
         """
         A list of tags applied to the service principal.
         """
         return pulumi.get(self, "tags")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def type(self) -> str:
+    def type(self) -> _builtins.str:
         """
         Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions. Possible values are `User` or `Admin`.
         """
@@ -355,7 +347,6 @@ class AwaitableGetServicePrincipalResult(GetServicePrincipalResult):
             app_role_assignment_required=self.app_role_assignment_required,
             app_role_ids=self.app_role_ids,
             app_roles=self.app_roles,
-            application_id=self.application_id,
             application_tenant_id=self.application_tenant_id,
             client_id=self.client_id,
             description=self.description,
@@ -381,10 +372,9 @@ class AwaitableGetServicePrincipalResult(GetServicePrincipalResult):
             type=self.type)
 
 
-def get_service_principal(application_id: Optional[str] = None,
-                          client_id: Optional[str] = None,
-                          display_name: Optional[str] = None,
-                          object_id: Optional[str] = None,
+def get_service_principal(client_id: Optional[_builtins.str] = None,
+                          display_name: Optional[_builtins.str] = None,
+                          object_id: Optional[_builtins.str] = None,
                           opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetServicePrincipalResult:
     """
     Gets information about an existing service principal associated with an application within Azure Active Directory.
@@ -427,14 +417,13 @@ def get_service_principal(application_id: Optional[str] = None,
     ```
 
 
-    :param str client_id: The client ID of the application associated with this service principal.
-    :param str display_name: The display name of the application associated with this service principal.
-    :param str object_id: The object ID of the service principal.
+    :param _builtins.str client_id: The client ID of the application associated with this service principal.
+    :param _builtins.str display_name: The display name of the application associated with this service principal.
+    :param _builtins.str object_id: The object ID of the service principal.
            
            > One of `client_id`, `display_name` or `object_id` must be specified.
     """
     __args__ = dict()
-    __args__['applicationId'] = application_id
     __args__['clientId'] = client_id
     __args__['displayName'] = display_name
     __args__['objectId'] = object_id
@@ -447,7 +436,6 @@ def get_service_principal(application_id: Optional[str] = None,
         app_role_assignment_required=pulumi.get(__ret__, 'app_role_assignment_required'),
         app_role_ids=pulumi.get(__ret__, 'app_role_ids'),
         app_roles=pulumi.get(__ret__, 'app_roles'),
-        application_id=pulumi.get(__ret__, 'application_id'),
         application_tenant_id=pulumi.get(__ret__, 'application_tenant_id'),
         client_id=pulumi.get(__ret__, 'client_id'),
         description=pulumi.get(__ret__, 'description'),
@@ -471,14 +459,10 @@ def get_service_principal(application_id: Optional[str] = None,
         sign_in_audience=pulumi.get(__ret__, 'sign_in_audience'),
         tags=pulumi.get(__ret__, 'tags'),
         type=pulumi.get(__ret__, 'type'))
-
-
-@_utilities.lift_output_func(get_service_principal)
-def get_service_principal_output(application_id: Optional[pulumi.Input[Optional[str]]] = None,
-                                 client_id: Optional[pulumi.Input[Optional[str]]] = None,
-                                 display_name: Optional[pulumi.Input[Optional[str]]] = None,
-                                 object_id: Optional[pulumi.Input[Optional[str]]] = None,
-                                 opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetServicePrincipalResult]:
+def get_service_principal_output(client_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                 display_name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                 object_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                 opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetServicePrincipalResult]:
     """
     Gets information about an existing service principal associated with an application within Azure Active Directory.
 
@@ -520,10 +504,44 @@ def get_service_principal_output(application_id: Optional[pulumi.Input[Optional[
     ```
 
 
-    :param str client_id: The client ID of the application associated with this service principal.
-    :param str display_name: The display name of the application associated with this service principal.
-    :param str object_id: The object ID of the service principal.
+    :param _builtins.str client_id: The client ID of the application associated with this service principal.
+    :param _builtins.str display_name: The display name of the application associated with this service principal.
+    :param _builtins.str object_id: The object ID of the service principal.
            
            > One of `client_id`, `display_name` or `object_id` must be specified.
     """
-    ...
+    __args__ = dict()
+    __args__['clientId'] = client_id
+    __args__['displayName'] = display_name
+    __args__['objectId'] = object_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azuread:index/getServicePrincipal:getServicePrincipal', __args__, opts=opts, typ=GetServicePrincipalResult)
+    return __ret__.apply(lambda __response__: GetServicePrincipalResult(
+        account_enabled=pulumi.get(__response__, 'account_enabled'),
+        alternative_names=pulumi.get(__response__, 'alternative_names'),
+        app_role_assignment_required=pulumi.get(__response__, 'app_role_assignment_required'),
+        app_role_ids=pulumi.get(__response__, 'app_role_ids'),
+        app_roles=pulumi.get(__response__, 'app_roles'),
+        application_tenant_id=pulumi.get(__response__, 'application_tenant_id'),
+        client_id=pulumi.get(__response__, 'client_id'),
+        description=pulumi.get(__response__, 'description'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        feature_tags=pulumi.get(__response__, 'feature_tags'),
+        features=pulumi.get(__response__, 'features'),
+        homepage_url=pulumi.get(__response__, 'homepage_url'),
+        id=pulumi.get(__response__, 'id'),
+        login_url=pulumi.get(__response__, 'login_url'),
+        logout_url=pulumi.get(__response__, 'logout_url'),
+        notes=pulumi.get(__response__, 'notes'),
+        notification_email_addresses=pulumi.get(__response__, 'notification_email_addresses'),
+        oauth2_permission_scope_ids=pulumi.get(__response__, 'oauth2_permission_scope_ids'),
+        oauth2_permission_scopes=pulumi.get(__response__, 'oauth2_permission_scopes'),
+        object_id=pulumi.get(__response__, 'object_id'),
+        preferred_single_sign_on_mode=pulumi.get(__response__, 'preferred_single_sign_on_mode'),
+        redirect_uris=pulumi.get(__response__, 'redirect_uris'),
+        saml_metadata_url=pulumi.get(__response__, 'saml_metadata_url'),
+        saml_single_sign_ons=pulumi.get(__response__, 'saml_single_sign_ons'),
+        service_principal_names=pulumi.get(__response__, 'service_principal_names'),
+        sign_in_audience=pulumi.get(__response__, 'sign_in_audience'),
+        tags=pulumi.get(__response__, 'tags'),
+        type=pulumi.get(__response__, 'type')))