pulumi-azuread 5.48.0a1706744699__py3-none-any.whl → 6.8.0a1766208344__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of pulumi-azuread might be problematic. Click here for more details.
- pulumi_azuread/__init__.py +48 -1
- pulumi_azuread/_inputs.py +3803 -919
- pulumi_azuread/_utilities.py +52 -12
- pulumi_azuread/access_package.py +84 -78
- pulumi_azuread/access_package_assignment_policy.py +202 -196
- pulumi_azuread/access_package_catalog.py +82 -76
- pulumi_azuread/access_package_catalog_role_assignment.py +73 -67
- pulumi_azuread/access_package_resource_catalog_association.py +73 -67
- pulumi_azuread/access_package_resource_package_association.py +79 -73
- pulumi_azuread/administrative_unit.py +120 -100
- pulumi_azuread/administrative_unit_member.py +66 -50
- pulumi_azuread/administrative_unit_role_member.py +75 -69
- pulumi_azuread/app_role_assignment.py +164 -264
- pulumi_azuread/application.py +766 -692
- pulumi_azuread/application_api_access.py +84 -80
- pulumi_azuread/application_app_role.py +120 -116
- pulumi_azuread/application_certificate.py +349 -211
- pulumi_azuread/application_fallback_public_client.py +50 -44
- pulumi_azuread/application_federated_identity_credential.py +142 -197
- pulumi_azuread/application_from_template.py +90 -84
- pulumi_azuread/application_identifier_uri.py +56 -52
- pulumi_azuread/application_known_clients.py +50 -44
- pulumi_azuread/application_optional_claims.py +87 -81
- pulumi_azuread/application_owner.py +76 -42
- pulumi_azuread/application_password.py +159 -205
- pulumi_azuread/application_permission_scope.py +160 -156
- pulumi_azuread/application_pre_authorized.py +120 -236
- pulumi_azuread/application_redirect_uris.py +75 -69
- pulumi_azuread/application_registration.py +315 -309
- pulumi_azuread/authentication_strength_policy.py +73 -67
- pulumi_azuread/claims_mapping_policy.py +48 -42
- pulumi_azuread/conditional_access_policy.py +248 -232
- pulumi_azuread/config/__init__.py +2 -1
- pulumi_azuread/config/__init__.pyi +23 -17
- pulumi_azuread/config/vars.py +47 -37
- pulumi_azuread/custom_directory_role.py +128 -122
- pulumi_azuread/directory_role.py +60 -54
- pulumi_azuread/directory_role_assignment.py +194 -181
- pulumi_azuread/directory_role_eligibility_schedule_request.py +86 -80
- pulumi_azuread/directory_role_member.py +54 -48
- pulumi_azuread/get_access_package.py +45 -31
- pulumi_azuread/get_access_package_catalog.py +40 -27
- pulumi_azuread/get_access_package_catalog_role.py +39 -25
- pulumi_azuread/get_administrative_unit.py +42 -27
- pulumi_azuread/get_application.py +135 -94
- pulumi_azuread/get_application_published_app_ids.py +42 -47
- pulumi_azuread/get_application_template.py +49 -33
- pulumi_azuread/get_client_config.py +24 -15
- pulumi_azuread/get_directory_object.py +32 -21
- pulumi_azuread/get_directory_role_templates.py +20 -12
- pulumi_azuread/get_directory_roles.py +23 -14
- pulumi_azuread/get_domains.py +65 -46
- pulumi_azuread/get_group.py +147 -88
- pulumi_azuread/get_group_role_management_policy.py +178 -0
- pulumi_azuread/get_groups.py +71 -51
- pulumi_azuread/get_named_location.py +47 -22
- pulumi_azuread/get_service_principal.py +108 -90
- pulumi_azuread/get_service_principals.py +60 -64
- pulumi_azuread/get_user.py +186 -118
- pulumi_azuread/get_users.py +96 -53
- pulumi_azuread/group.py +622 -464
- pulumi_azuread/group_member.py +56 -50
- pulumi_azuread/group_role_management_policy.py +544 -0
- pulumi_azuread/group_without_members.py +1610 -0
- pulumi_azuread/invitation.py +126 -120
- pulumi_azuread/named_location.py +90 -76
- pulumi_azuread/outputs.py +2844 -1308
- pulumi_azuread/privileged_access_group_assignment_schedule.py +695 -0
- pulumi_azuread/privileged_access_group_eligibility_schedule.py +695 -0
- pulumi_azuread/provider.py +292 -246
- pulumi_azuread/pulumi-plugin.json +2 -1
- pulumi_azuread/service_principal.py +400 -461
- pulumi_azuread/service_principal_certificate.py +230 -145
- pulumi_azuread/service_principal_claims_mapping_policy_assignment.py +53 -47
- pulumi_azuread/service_principal_delegated_permission_grant.py +146 -140
- pulumi_azuread/service_principal_password.py +156 -141
- pulumi_azuread/service_principal_token_signing_certificate.py +119 -124
- pulumi_azuread/synchronization_job.py +105 -111
- pulumi_azuread/synchronization_job_provision_on_demand.py +396 -0
- pulumi_azuread/synchronization_secret.py +64 -70
- pulumi_azuread/user.py +776 -730
- pulumi_azuread/user_flow_attribute.py +76 -70
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/METADATA +21 -20
- pulumi_azuread-6.8.0a1766208344.dist-info/RECORD +87 -0
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/WHEEL +1 -1
- pulumi_azuread-5.48.0a1706744699.dist-info/RECORD +0 -81
- {pulumi_azuread-5.48.0a1706744699.dist-info → pulumi_azuread-6.8.0a1766208344.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# coding=utf-8
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
|
+
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
|
+
|
|
5
|
+
import builtins as _builtins
|
|
6
|
+
import warnings
|
|
7
|
+
import sys
|
|
8
|
+
import pulumi
|
|
9
|
+
import pulumi.runtime
|
|
10
|
+
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
15
|
+
from . import _utilities
|
|
16
|
+
|
|
17
|
+
__all__ = [
|
|
18
|
+
'GetGroupRoleManagementPolicyResult',
|
|
19
|
+
'AwaitableGetGroupRoleManagementPolicyResult',
|
|
20
|
+
'get_group_role_management_policy',
|
|
21
|
+
'get_group_role_management_policy_output',
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
@pulumi.output_type
|
|
25
|
+
class GetGroupRoleManagementPolicyResult:
|
|
26
|
+
"""
|
|
27
|
+
A collection of values returned by getGroupRoleManagementPolicy.
|
|
28
|
+
"""
|
|
29
|
+
def __init__(__self__, description=None, display_name=None, group_id=None, id=None, role_id=None):
|
|
30
|
+
if description and not isinstance(description, str):
|
|
31
|
+
raise TypeError("Expected argument 'description' to be a str")
|
|
32
|
+
pulumi.set(__self__, "description", description)
|
|
33
|
+
if display_name and not isinstance(display_name, str):
|
|
34
|
+
raise TypeError("Expected argument 'display_name' to be a str")
|
|
35
|
+
pulumi.set(__self__, "display_name", display_name)
|
|
36
|
+
if group_id and not isinstance(group_id, str):
|
|
37
|
+
raise TypeError("Expected argument 'group_id' to be a str")
|
|
38
|
+
pulumi.set(__self__, "group_id", group_id)
|
|
39
|
+
if id and not isinstance(id, str):
|
|
40
|
+
raise TypeError("Expected argument 'id' to be a str")
|
|
41
|
+
pulumi.set(__self__, "id", id)
|
|
42
|
+
if role_id and not isinstance(role_id, str):
|
|
43
|
+
raise TypeError("Expected argument 'role_id' to be a str")
|
|
44
|
+
pulumi.set(__self__, "role_id", role_id)
|
|
45
|
+
|
|
46
|
+
@_builtins.property
|
|
47
|
+
@pulumi.getter
|
|
48
|
+
def description(self) -> _builtins.str:
|
|
49
|
+
"""
|
|
50
|
+
(String) The description of this policy.
|
|
51
|
+
"""
|
|
52
|
+
return pulumi.get(self, "description")
|
|
53
|
+
|
|
54
|
+
@_builtins.property
|
|
55
|
+
@pulumi.getter(name="displayName")
|
|
56
|
+
def display_name(self) -> _builtins.str:
|
|
57
|
+
"""
|
|
58
|
+
(String) The display name of this policy.
|
|
59
|
+
"""
|
|
60
|
+
return pulumi.get(self, "display_name")
|
|
61
|
+
|
|
62
|
+
@_builtins.property
|
|
63
|
+
@pulumi.getter(name="groupId")
|
|
64
|
+
def group_id(self) -> _builtins.str:
|
|
65
|
+
return pulumi.get(self, "group_id")
|
|
66
|
+
|
|
67
|
+
@_builtins.property
|
|
68
|
+
@pulumi.getter
|
|
69
|
+
def id(self) -> _builtins.str:
|
|
70
|
+
"""
|
|
71
|
+
The provider-assigned unique ID for this managed resource.
|
|
72
|
+
"""
|
|
73
|
+
return pulumi.get(self, "id")
|
|
74
|
+
|
|
75
|
+
@_builtins.property
|
|
76
|
+
@pulumi.getter(name="roleId")
|
|
77
|
+
def role_id(self) -> _builtins.str:
|
|
78
|
+
return pulumi.get(self, "role_id")
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
class AwaitableGetGroupRoleManagementPolicyResult(GetGroupRoleManagementPolicyResult):
|
|
82
|
+
# pylint: disable=using-constant-test
|
|
83
|
+
def __await__(self):
|
|
84
|
+
if False:
|
|
85
|
+
yield self
|
|
86
|
+
return GetGroupRoleManagementPolicyResult(
|
|
87
|
+
description=self.description,
|
|
88
|
+
display_name=self.display_name,
|
|
89
|
+
group_id=self.group_id,
|
|
90
|
+
id=self.id,
|
|
91
|
+
role_id=self.role_id)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
def get_group_role_management_policy(group_id: Optional[_builtins.str] = None,
|
|
95
|
+
role_id: Optional[_builtins.str] = None,
|
|
96
|
+
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetGroupRoleManagementPolicyResult:
|
|
97
|
+
"""
|
|
98
|
+
Use this data source to retrieve a role policy for an Azure AD group.
|
|
99
|
+
|
|
100
|
+
## API Permissions
|
|
101
|
+
|
|
102
|
+
The following API permissions are required in order to use this resource.
|
|
103
|
+
|
|
104
|
+
When authenticated with a service principal, this resource requires the `RoleManagementPolicy.Read.AzureADGroup` Microsoft Graph API permissions.
|
|
105
|
+
|
|
106
|
+
When authenticated with a user principal, this resource requires `Global Administrator` directory role, or the `Privileged Role Administrator` role in Identity Governance.
|
|
107
|
+
|
|
108
|
+
## Example Usage
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
import pulumi
|
|
112
|
+
import pulumi_azuread as azuread
|
|
113
|
+
|
|
114
|
+
example = azuread.Group("example",
|
|
115
|
+
display_name="group-name",
|
|
116
|
+
security_enabled=True)
|
|
117
|
+
owners_policy = azuread.get_group_role_management_policy_output(group_id=example.id,
|
|
118
|
+
role_id="owner")
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
:param _builtins.str group_id: The ID of the Azure AD group for which the policy applies.
|
|
123
|
+
:param _builtins.str role_id: The type of assignment this policy coveres. Can be either `member` or `owner`.
|
|
124
|
+
"""
|
|
125
|
+
__args__ = dict()
|
|
126
|
+
__args__['groupId'] = group_id
|
|
127
|
+
__args__['roleId'] = role_id
|
|
128
|
+
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
|
|
129
|
+
__ret__ = pulumi.runtime.invoke('azuread:index/getGroupRoleManagementPolicy:getGroupRoleManagementPolicy', __args__, opts=opts, typ=GetGroupRoleManagementPolicyResult).value
|
|
130
|
+
|
|
131
|
+
return AwaitableGetGroupRoleManagementPolicyResult(
|
|
132
|
+
description=pulumi.get(__ret__, 'description'),
|
|
133
|
+
display_name=pulumi.get(__ret__, 'display_name'),
|
|
134
|
+
group_id=pulumi.get(__ret__, 'group_id'),
|
|
135
|
+
id=pulumi.get(__ret__, 'id'),
|
|
136
|
+
role_id=pulumi.get(__ret__, 'role_id'))
|
|
137
|
+
def get_group_role_management_policy_output(group_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
138
|
+
role_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
139
|
+
opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetGroupRoleManagementPolicyResult]:
|
|
140
|
+
"""
|
|
141
|
+
Use this data source to retrieve a role policy for an Azure AD group.
|
|
142
|
+
|
|
143
|
+
## API Permissions
|
|
144
|
+
|
|
145
|
+
The following API permissions are required in order to use this resource.
|
|
146
|
+
|
|
147
|
+
When authenticated with a service principal, this resource requires the `RoleManagementPolicy.Read.AzureADGroup` Microsoft Graph API permissions.
|
|
148
|
+
|
|
149
|
+
When authenticated with a user principal, this resource requires `Global Administrator` directory role, or the `Privileged Role Administrator` role in Identity Governance.
|
|
150
|
+
|
|
151
|
+
## Example Usage
|
|
152
|
+
|
|
153
|
+
```python
|
|
154
|
+
import pulumi
|
|
155
|
+
import pulumi_azuread as azuread
|
|
156
|
+
|
|
157
|
+
example = azuread.Group("example",
|
|
158
|
+
display_name="group-name",
|
|
159
|
+
security_enabled=True)
|
|
160
|
+
owners_policy = azuread.get_group_role_management_policy_output(group_id=example.id,
|
|
161
|
+
role_id="owner")
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
:param _builtins.str group_id: The ID of the Azure AD group for which the policy applies.
|
|
166
|
+
:param _builtins.str role_id: The type of assignment this policy coveres. Can be either `member` or `owner`.
|
|
167
|
+
"""
|
|
168
|
+
__args__ = dict()
|
|
169
|
+
__args__['groupId'] = group_id
|
|
170
|
+
__args__['roleId'] = role_id
|
|
171
|
+
opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
|
|
172
|
+
__ret__ = pulumi.runtime.invoke_output('azuread:index/getGroupRoleManagementPolicy:getGroupRoleManagementPolicy', __args__, opts=opts, typ=GetGroupRoleManagementPolicyResult)
|
|
173
|
+
return __ret__.apply(lambda __response__: GetGroupRoleManagementPolicyResult(
|
|
174
|
+
description=pulumi.get(__response__, 'description'),
|
|
175
|
+
display_name=pulumi.get(__response__, 'display_name'),
|
|
176
|
+
group_id=pulumi.get(__response__, 'group_id'),
|
|
177
|
+
id=pulumi.get(__response__, 'id'),
|
|
178
|
+
role_id=pulumi.get(__response__, 'role_id')))
|
pulumi_azuread/get_groups.py
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
# coding=utf-8
|
|
2
|
-
# *** WARNING: this file was generated by
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
|
|
12
17
|
__all__ = [
|
|
@@ -47,53 +52,53 @@ class GetGroupsResult:
|
|
|
47
52
|
raise TypeError("Expected argument 'security_enabled' to be a bool")
|
|
48
53
|
pulumi.set(__self__, "security_enabled", security_enabled)
|
|
49
54
|
|
|
50
|
-
@property
|
|
55
|
+
@_builtins.property
|
|
51
56
|
@pulumi.getter(name="displayNamePrefix")
|
|
52
|
-
def display_name_prefix(self) -> str:
|
|
57
|
+
def display_name_prefix(self) -> _builtins.str:
|
|
53
58
|
return pulumi.get(self, "display_name_prefix")
|
|
54
59
|
|
|
55
|
-
@property
|
|
60
|
+
@_builtins.property
|
|
56
61
|
@pulumi.getter(name="displayNames")
|
|
57
|
-
def display_names(self) -> Sequence[str]:
|
|
62
|
+
def display_names(self) -> Sequence[_builtins.str]:
|
|
58
63
|
"""
|
|
59
64
|
The display names of the groups.
|
|
60
65
|
"""
|
|
61
66
|
return pulumi.get(self, "display_names")
|
|
62
67
|
|
|
63
|
-
@property
|
|
68
|
+
@_builtins.property
|
|
64
69
|
@pulumi.getter
|
|
65
|
-
def id(self) -> str:
|
|
70
|
+
def id(self) -> _builtins.str:
|
|
66
71
|
"""
|
|
67
72
|
The provider-assigned unique ID for this managed resource.
|
|
68
73
|
"""
|
|
69
74
|
return pulumi.get(self, "id")
|
|
70
75
|
|
|
71
|
-
@property
|
|
76
|
+
@_builtins.property
|
|
72
77
|
@pulumi.getter(name="ignoreMissing")
|
|
73
|
-
def ignore_missing(self) -> Optional[bool]:
|
|
78
|
+
def ignore_missing(self) -> Optional[_builtins.bool]:
|
|
74
79
|
return pulumi.get(self, "ignore_missing")
|
|
75
80
|
|
|
76
|
-
@property
|
|
81
|
+
@_builtins.property
|
|
77
82
|
@pulumi.getter(name="mailEnabled")
|
|
78
|
-
def mail_enabled(self) -> bool:
|
|
83
|
+
def mail_enabled(self) -> _builtins.bool:
|
|
79
84
|
return pulumi.get(self, "mail_enabled")
|
|
80
85
|
|
|
81
|
-
@property
|
|
86
|
+
@_builtins.property
|
|
82
87
|
@pulumi.getter(name="objectIds")
|
|
83
|
-
def object_ids(self) -> Sequence[str]:
|
|
88
|
+
def object_ids(self) -> Sequence[_builtins.str]:
|
|
84
89
|
"""
|
|
85
90
|
The object IDs of the groups.
|
|
86
91
|
"""
|
|
87
92
|
return pulumi.get(self, "object_ids")
|
|
88
93
|
|
|
89
|
-
@property
|
|
94
|
+
@_builtins.property
|
|
90
95
|
@pulumi.getter(name="returnAll")
|
|
91
|
-
def return_all(self) -> Optional[bool]:
|
|
96
|
+
def return_all(self) -> Optional[_builtins.bool]:
|
|
92
97
|
return pulumi.get(self, "return_all")
|
|
93
98
|
|
|
94
|
-
@property
|
|
99
|
+
@_builtins.property
|
|
95
100
|
@pulumi.getter(name="securityEnabled")
|
|
96
|
-
def security_enabled(self) -> bool:
|
|
101
|
+
def security_enabled(self) -> _builtins.bool:
|
|
97
102
|
return pulumi.get(self, "security_enabled")
|
|
98
103
|
|
|
99
104
|
|
|
@@ -113,13 +118,13 @@ class AwaitableGetGroupsResult(GetGroupsResult):
|
|
|
113
118
|
security_enabled=self.security_enabled)
|
|
114
119
|
|
|
115
120
|
|
|
116
|
-
def get_groups(display_name_prefix: Optional[str] = None,
|
|
117
|
-
display_names: Optional[Sequence[str]] = None,
|
|
118
|
-
ignore_missing: Optional[bool] = None,
|
|
119
|
-
mail_enabled: Optional[bool] = None,
|
|
120
|
-
object_ids: Optional[Sequence[str]] = None,
|
|
121
|
-
return_all: Optional[bool] = None,
|
|
122
|
-
security_enabled: Optional[bool] = None,
|
|
121
|
+
def get_groups(display_name_prefix: Optional[_builtins.str] = None,
|
|
122
|
+
display_names: Optional[Sequence[_builtins.str]] = None,
|
|
123
|
+
ignore_missing: Optional[_builtins.bool] = None,
|
|
124
|
+
mail_enabled: Optional[_builtins.bool] = None,
|
|
125
|
+
object_ids: Optional[Sequence[_builtins.str]] = None,
|
|
126
|
+
return_all: Optional[_builtins.bool] = None,
|
|
127
|
+
security_enabled: Optional[_builtins.bool] = None,
|
|
123
128
|
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetGroupsResult:
|
|
124
129
|
"""
|
|
125
130
|
Gets Object IDs or Display Names for multiple Azure Active Directory groups.
|
|
@@ -181,13 +186,13 @@ def get_groups(display_name_prefix: Optional[str] = None,
|
|
|
181
186
|
```
|
|
182
187
|
|
|
183
188
|
|
|
184
|
-
:param str display_name_prefix: A common display name prefix to match when returning groups.
|
|
185
|
-
:param Sequence[str] display_names: The display names of the groups.
|
|
186
|
-
:param bool ignore_missing: Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `return_all`. Defaults to `false`.
|
|
187
|
-
:param bool mail_enabled: Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
188
|
-
:param Sequence[str] object_ids: The object IDs of the groups.
|
|
189
|
-
:param bool return_all: A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignore_missing`. Defaults to `false`.
|
|
190
|
-
:param bool security_enabled: Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
189
|
+
:param _builtins.str display_name_prefix: A common display name prefix to match when returning groups.
|
|
190
|
+
:param Sequence[_builtins.str] display_names: The display names of the groups.
|
|
191
|
+
:param _builtins.bool ignore_missing: Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `return_all`. Defaults to `false`.
|
|
192
|
+
:param _builtins.bool mail_enabled: Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
193
|
+
:param Sequence[_builtins.str] object_ids: The object IDs of the groups.
|
|
194
|
+
:param _builtins.bool return_all: A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignore_missing`. Defaults to `false`.
|
|
195
|
+
:param _builtins.bool security_enabled: Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
191
196
|
|
|
192
197
|
> One of `display_names`, `display_name_prefix`, `object_ids` or `return_all` should be specified. Either `display_name` or `object_ids` _may_ be specified as an empty list, in which case no results will be returned.
|
|
193
198
|
"""
|
|
@@ -211,17 +216,14 @@ def get_groups(display_name_prefix: Optional[str] = None,
|
|
|
211
216
|
object_ids=pulumi.get(__ret__, 'object_ids'),
|
|
212
217
|
return_all=pulumi.get(__ret__, 'return_all'),
|
|
213
218
|
security_enabled=pulumi.get(__ret__, 'security_enabled'))
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
return_all: Optional[pulumi.Input[Optional[bool]]] = None,
|
|
223
|
-
security_enabled: Optional[pulumi.Input[Optional[bool]]] = None,
|
|
224
|
-
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetGroupsResult]:
|
|
219
|
+
def get_groups_output(display_name_prefix: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
|
|
220
|
+
display_names: Optional[pulumi.Input[Optional[Sequence[_builtins.str]]]] = None,
|
|
221
|
+
ignore_missing: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
|
|
222
|
+
mail_enabled: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
|
|
223
|
+
object_ids: Optional[pulumi.Input[Optional[Sequence[_builtins.str]]]] = None,
|
|
224
|
+
return_all: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
|
|
225
|
+
security_enabled: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
|
|
226
|
+
opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetGroupsResult]:
|
|
225
227
|
"""
|
|
226
228
|
Gets Object IDs or Display Names for multiple Azure Active Directory groups.
|
|
227
229
|
|
|
@@ -282,14 +284,32 @@ def get_groups_output(display_name_prefix: Optional[pulumi.Input[Optional[str]]]
|
|
|
282
284
|
```
|
|
283
285
|
|
|
284
286
|
|
|
285
|
-
:param str display_name_prefix: A common display name prefix to match when returning groups.
|
|
286
|
-
:param Sequence[str] display_names: The display names of the groups.
|
|
287
|
-
:param bool ignore_missing: Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `return_all`. Defaults to `false`.
|
|
288
|
-
:param bool mail_enabled: Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
289
|
-
:param Sequence[str] object_ids: The object IDs of the groups.
|
|
290
|
-
:param bool return_all: A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignore_missing`. Defaults to `false`.
|
|
291
|
-
:param bool security_enabled: Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
287
|
+
:param _builtins.str display_name_prefix: A common display name prefix to match when returning groups.
|
|
288
|
+
:param Sequence[_builtins.str] display_names: The display names of the groups.
|
|
289
|
+
:param _builtins.bool ignore_missing: Ignore missing groups and return groups that were found. The data source will still fail if no groups are found. Cannot be specified with `return_all`. Defaults to `false`.
|
|
290
|
+
:param _builtins.bool mail_enabled: Whether the returned groups should be mail-enabled. By itself this does not exclude security-enabled groups. Setting this to `true` ensures all groups are mail-enabled, and setting to `false` ensures that all groups are _not_ mail-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
291
|
+
:param Sequence[_builtins.str] object_ids: The object IDs of the groups.
|
|
292
|
+
:param _builtins.bool return_all: A flag to denote if all groups should be fetched and returned. Cannot be specified wth `ignore_missing`. Defaults to `false`.
|
|
293
|
+
:param _builtins.bool security_enabled: Whether the returned groups should be security-enabled. By itself this does not exclude mail-enabled groups. Setting this to `true` ensures all groups are security-enabled, and setting to `false` ensures that all groups are _not_ security-enabled. To ignore this filter, omit the property or set it to null. Cannot be specified together with `object_ids`.
|
|
292
294
|
|
|
293
295
|
> One of `display_names`, `display_name_prefix`, `object_ids` or `return_all` should be specified. Either `display_name` or `object_ids` _may_ be specified as an empty list, in which case no results will be returned.
|
|
294
296
|
"""
|
|
295
|
-
|
|
297
|
+
__args__ = dict()
|
|
298
|
+
__args__['displayNamePrefix'] = display_name_prefix
|
|
299
|
+
__args__['displayNames'] = display_names
|
|
300
|
+
__args__['ignoreMissing'] = ignore_missing
|
|
301
|
+
__args__['mailEnabled'] = mail_enabled
|
|
302
|
+
__args__['objectIds'] = object_ids
|
|
303
|
+
__args__['returnAll'] = return_all
|
|
304
|
+
__args__['securityEnabled'] = security_enabled
|
|
305
|
+
opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
|
|
306
|
+
__ret__ = pulumi.runtime.invoke_output('azuread:index/getGroups:getGroups', __args__, opts=opts, typ=GetGroupsResult)
|
|
307
|
+
return __ret__.apply(lambda __response__: GetGroupsResult(
|
|
308
|
+
display_name_prefix=pulumi.get(__response__, 'display_name_prefix'),
|
|
309
|
+
display_names=pulumi.get(__response__, 'display_names'),
|
|
310
|
+
id=pulumi.get(__response__, 'id'),
|
|
311
|
+
ignore_missing=pulumi.get(__response__, 'ignore_missing'),
|
|
312
|
+
mail_enabled=pulumi.get(__response__, 'mail_enabled'),
|
|
313
|
+
object_ids=pulumi.get(__response__, 'object_ids'),
|
|
314
|
+
return_all=pulumi.get(__response__, 'return_all'),
|
|
315
|
+
security_enabled=pulumi.get(__response__, 'security_enabled')))
|
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
# coding=utf-8
|
|
2
|
-
# *** WARNING: this file was generated by
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
from . import outputs
|
|
12
17
|
|
|
@@ -22,7 +27,7 @@ class GetNamedLocationResult:
|
|
|
22
27
|
"""
|
|
23
28
|
A collection of values returned by getNamedLocation.
|
|
24
29
|
"""
|
|
25
|
-
def __init__(__self__, countries=None, display_name=None, id=None, ips=None):
|
|
30
|
+
def __init__(__self__, countries=None, display_name=None, id=None, ips=None, object_id=None):
|
|
26
31
|
if countries and not isinstance(countries, list):
|
|
27
32
|
raise TypeError("Expected argument 'countries' to be a list")
|
|
28
33
|
pulumi.set(__self__, "countries", countries)
|
|
@@ -35,30 +40,38 @@ class GetNamedLocationResult:
|
|
|
35
40
|
if ips and not isinstance(ips, list):
|
|
36
41
|
raise TypeError("Expected argument 'ips' to be a list")
|
|
37
42
|
pulumi.set(__self__, "ips", ips)
|
|
43
|
+
if object_id and not isinstance(object_id, str):
|
|
44
|
+
raise TypeError("Expected argument 'object_id' to be a str")
|
|
45
|
+
pulumi.set(__self__, "object_id", object_id)
|
|
38
46
|
|
|
39
|
-
@property
|
|
47
|
+
@_builtins.property
|
|
40
48
|
@pulumi.getter
|
|
41
49
|
def countries(self) -> Sequence['outputs.GetNamedLocationCountryResult']:
|
|
42
50
|
return pulumi.get(self, "countries")
|
|
43
51
|
|
|
44
|
-
@property
|
|
52
|
+
@_builtins.property
|
|
45
53
|
@pulumi.getter(name="displayName")
|
|
46
|
-
def display_name(self) -> str:
|
|
54
|
+
def display_name(self) -> _builtins.str:
|
|
47
55
|
return pulumi.get(self, "display_name")
|
|
48
56
|
|
|
49
|
-
@property
|
|
57
|
+
@_builtins.property
|
|
50
58
|
@pulumi.getter
|
|
51
|
-
def id(self) -> str:
|
|
59
|
+
def id(self) -> _builtins.str:
|
|
52
60
|
"""
|
|
53
61
|
The provider-assigned unique ID for this managed resource.
|
|
54
62
|
"""
|
|
55
63
|
return pulumi.get(self, "id")
|
|
56
64
|
|
|
57
|
-
@property
|
|
65
|
+
@_builtins.property
|
|
58
66
|
@pulumi.getter
|
|
59
67
|
def ips(self) -> Sequence['outputs.GetNamedLocationIpResult']:
|
|
60
68
|
return pulumi.get(self, "ips")
|
|
61
69
|
|
|
70
|
+
@_builtins.property
|
|
71
|
+
@pulumi.getter(name="objectId")
|
|
72
|
+
def object_id(self) -> _builtins.str:
|
|
73
|
+
return pulumi.get(self, "object_id")
|
|
74
|
+
|
|
62
75
|
|
|
63
76
|
class AwaitableGetNamedLocationResult(GetNamedLocationResult):
|
|
64
77
|
# pylint: disable=using-constant-test
|
|
@@ -69,10 +82,11 @@ class AwaitableGetNamedLocationResult(GetNamedLocationResult):
|
|
|
69
82
|
countries=self.countries,
|
|
70
83
|
display_name=self.display_name,
|
|
71
84
|
id=self.id,
|
|
72
|
-
ips=self.ips
|
|
85
|
+
ips=self.ips,
|
|
86
|
+
object_id=self.object_id)
|
|
73
87
|
|
|
74
88
|
|
|
75
|
-
def get_named_location(display_name: Optional[str] = None,
|
|
89
|
+
def get_named_location(display_name: Optional[_builtins.str] = None,
|
|
76
90
|
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNamedLocationResult:
|
|
77
91
|
"""
|
|
78
92
|
Gets information about a Named Location within Azure Active Directory.
|
|
@@ -93,6 +107,7 @@ def get_named_location(display_name: Optional[str] = None,
|
|
|
93
107
|
|
|
94
108
|
example = azuread.get_named_location(display_name="My Named Location")
|
|
95
109
|
```
|
|
110
|
+
|
|
96
111
|
## Attributes Reference
|
|
97
112
|
|
|
98
113
|
The following attributes are exported:
|
|
@@ -100,7 +115,8 @@ def get_named_location(display_name: Optional[str] = None,
|
|
|
100
115
|
* `country` - A `country` block as documented below, which describes a country-based named location.
|
|
101
116
|
* `id` - The ID of the named location.
|
|
102
117
|
* `ip` - An `ip` block as documented below, which describes an IP-based named location.
|
|
103
|
-
*
|
|
118
|
+
* `object_id` - The object ID of the named location.
|
|
119
|
+
|
|
104
120
|
***
|
|
105
121
|
|
|
106
122
|
`country` block exports the following:
|
|
@@ -116,7 +132,7 @@ def get_named_location(display_name: Optional[str] = None,
|
|
|
116
132
|
* `trusted` - Whether the named location is trusted.
|
|
117
133
|
|
|
118
134
|
|
|
119
|
-
:param str display_name: Specifies the display named of the named location to look up.
|
|
135
|
+
:param _builtins.str display_name: Specifies the display named of the named location to look up.
|
|
120
136
|
"""
|
|
121
137
|
__args__ = dict()
|
|
122
138
|
__args__['displayName'] = display_name
|
|
@@ -127,12 +143,10 @@ def get_named_location(display_name: Optional[str] = None,
|
|
|
127
143
|
countries=pulumi.get(__ret__, 'countries'),
|
|
128
144
|
display_name=pulumi.get(__ret__, 'display_name'),
|
|
129
145
|
id=pulumi.get(__ret__, 'id'),
|
|
130
|
-
ips=pulumi.get(__ret__, 'ips')
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
def get_named_location_output(display_name: Optional[pulumi.Input[str]] = None,
|
|
135
|
-
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetNamedLocationResult]:
|
|
146
|
+
ips=pulumi.get(__ret__, 'ips'),
|
|
147
|
+
object_id=pulumi.get(__ret__, 'object_id'))
|
|
148
|
+
def get_named_location_output(display_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
149
|
+
opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNamedLocationResult]:
|
|
136
150
|
"""
|
|
137
151
|
Gets information about a Named Location within Azure Active Directory.
|
|
138
152
|
|
|
@@ -152,6 +166,7 @@ def get_named_location_output(display_name: Optional[pulumi.Input[str]] = None,
|
|
|
152
166
|
|
|
153
167
|
example = azuread.get_named_location(display_name="My Named Location")
|
|
154
168
|
```
|
|
169
|
+
|
|
155
170
|
## Attributes Reference
|
|
156
171
|
|
|
157
172
|
The following attributes are exported:
|
|
@@ -159,7 +174,8 @@ def get_named_location_output(display_name: Optional[pulumi.Input[str]] = None,
|
|
|
159
174
|
* `country` - A `country` block as documented below, which describes a country-based named location.
|
|
160
175
|
* `id` - The ID of the named location.
|
|
161
176
|
* `ip` - An `ip` block as documented below, which describes an IP-based named location.
|
|
162
|
-
*
|
|
177
|
+
* `object_id` - The object ID of the named location.
|
|
178
|
+
|
|
163
179
|
***
|
|
164
180
|
|
|
165
181
|
`country` block exports the following:
|
|
@@ -175,6 +191,15 @@ def get_named_location_output(display_name: Optional[pulumi.Input[str]] = None,
|
|
|
175
191
|
* `trusted` - Whether the named location is trusted.
|
|
176
192
|
|
|
177
193
|
|
|
178
|
-
:param str display_name: Specifies the display named of the named location to look up.
|
|
194
|
+
:param _builtins.str display_name: Specifies the display named of the named location to look up.
|
|
179
195
|
"""
|
|
180
|
-
|
|
196
|
+
__args__ = dict()
|
|
197
|
+
__args__['displayName'] = display_name
|
|
198
|
+
opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
|
|
199
|
+
__ret__ = pulumi.runtime.invoke_output('azuread:index/getNamedLocation:getNamedLocation', __args__, opts=opts, typ=GetNamedLocationResult)
|
|
200
|
+
return __ret__.apply(lambda __response__: GetNamedLocationResult(
|
|
201
|
+
countries=pulumi.get(__response__, 'countries'),
|
|
202
|
+
display_name=pulumi.get(__response__, 'display_name'),
|
|
203
|
+
id=pulumi.get(__response__, 'id'),
|
|
204
|
+
ips=pulumi.get(__response__, 'ips'),
|
|
205
|
+
object_id=pulumi.get(__response__, 'object_id')))
|