azure.graphrbac.models package¶
Submodules¶
azure.graphrbac.models.ad_group module¶
-
class
azure.graphrbac.models.ad_group.ADGroup(**kwargs)[source]¶ Active Directory group information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
display_name (str) – The display name of the group.
mail_enabled (bool) – Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API.
mail_nickname (str) – The mail alias for the group.
security_enabled (bool) – Whether the group is security-enable.
mail (str) – The primary email address of the group.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.ad_group_paged module¶
-
class
azure.graphrbac.models.ad_group_paged.ADGroupPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ADGroupobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.ad_group_py3 module¶
-
class
azure.graphrbac.models.ad_group_py3.ADGroup(*, additional_properties=None, display_name: str = None, mail_enabled: bool = None, mail_nickname: str = None, security_enabled: bool = None, mail: str = None, **kwargs)[source]¶ Active Directory group information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
display_name (str) – The display name of the group.
mail_enabled (bool) – Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API.
mail_nickname (str) – The mail alias for the group.
security_enabled (bool) – Whether the group is security-enable.
mail (str) – The primary email address of the group.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.add_owner_parameters module¶
-
class
azure.graphrbac.models.add_owner_parameters.AddOwnerParameters(**kwargs)[source]¶ Request parameters for adding a owner to an application.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A owner object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the owner (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.add_owner_parameters_py3 module¶
-
class
azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters(*, url: str, additional_properties=None, **kwargs)[source]¶ Request parameters for adding a owner to an application.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A owner object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the owner (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.app_role module¶
-
class
azure.graphrbac.models.app_role.AppRole(**kwargs)[source]¶ AppRole.
- Parameters
id (str) – Unique role identifier inside the appRoles collection.
allowed_member_types (list[str]) – Specifies whether this app role definition can be assigned to users and groups by setting to ‘User’, or to other applications (that are accessing this application in daemon service scenarios) by setting to ‘Application’, or to both.
description (str) – Permission help text that appears in the admin app assignment and consent experiences.
display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
is_enabled (bool) – When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
value (str) – Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.app_role_py3 module¶
-
class
azure.graphrbac.models.app_role_py3.AppRole(*, id: str = None, allowed_member_types=None, description: str = None, display_name: str = None, is_enabled: bool = None, value: str = None, **kwargs)[source]¶ AppRole.
- Parameters
id (str) – Unique role identifier inside the appRoles collection.
allowed_member_types (list[str]) – Specifies whether this app role definition can be assigned to users and groups by setting to ‘User’, or to other applications (that are accessing this application in daemon service scenarios) by setting to ‘Application’, or to both.
description (str) – Permission help text that appears in the admin app assignment and consent experiences.
display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
is_enabled (bool) – When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
value (str) – Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application module¶
-
class
azure.graphrbac.models.application.Application(**kwargs)[source]¶ Active Directory application information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
app_id (str) – The application ID.
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
display_name (str) – The display name of the application.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_base module¶
-
class
azure.graphrbac.models.application_base.ApplicationBase(**kwargs)[source]¶ Active Directive Application common properties shared among GET, POST and PATCH.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_base_py3 module¶
-
class
azure.graphrbac.models.application_base_py3.ApplicationBase(*, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, **kwargs)[source]¶ Active Directive Application common properties shared among GET, POST and PATCH.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_create_parameters module¶
-
class
azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters(**kwargs)[source]¶ Request parameters for creating a new application.
All required parameters must be populated in order to send to Azure.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – Required. The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_create_parameters_py3 module¶
-
class
azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters(*, display_name: str, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, identifier_uris=None, **kwargs)[source]¶ Request parameters for creating a new application.
All required parameters must be populated in order to send to Azure.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – Required. The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_paged module¶
-
class
azure.graphrbac.models.application_paged.ApplicationPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ApplicationobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.application_py3 module¶
-
class
azure.graphrbac.models.application_py3.Application(*, additional_properties=None, app_id: str = None, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, display_name: str = None, error_url: str = None, group_membership_claims=None, homepage: str = None, identifier_uris=None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, **kwargs)[source]¶ Active Directory application information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
app_id (str) – The application ID.
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
display_name (str) – The display name of the application.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_update_parameters module¶
-
class
azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters(**kwargs)[source]¶ Request parameters for updating a new application.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.application_update_parameters_py3 module¶
-
class
azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters(*, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, display_name: str = None, identifier_uris=None, **kwargs)[source]¶ Request parameters for updating a new application.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.check_group_membership_parameters module¶
-
class
azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters(**kwargs)[source]¶ Request parameters for IsMemberOf API call.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
group_id (str) – Required. The object ID of the group to check.
member_id (str) – Required. The object ID of the contact, group, user, or service principal to check for membership in the specified group.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.check_group_membership_parameters_py3 module¶
-
class
azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters(*, group_id: str, member_id: str, additional_properties=None, **kwargs)[source]¶ Request parameters for IsMemberOf API call.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
group_id (str) – Required. The object ID of the group to check.
member_id (str) – Required. The object ID of the contact, group, user, or service principal to check for membership in the specified group.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.check_group_membership_result module¶
-
class
azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult(**kwargs)[source]¶ Server response for IsMemberOf API call.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.check_group_membership_result_py3 module¶
-
class
azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult(*, additional_properties=None, value: bool = None, **kwargs)[source]¶ Server response for IsMemberOf API call.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.directory_object module¶
-
class
azure.graphrbac.models.directory_object.DirectoryObject(**kwargs)[source]¶ Represents an Azure Active Directory object.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Application, ADGroup, ServicePrincipal, User
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.directory_object_paged module¶
-
class
azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
DirectoryObjectobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.directory_object_py3 module¶
-
class
azure.graphrbac.models.directory_object_py3.DirectoryObject(*, additional_properties=None, **kwargs)[source]¶ Represents an Azure Active Directory object.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Application, ADGroup, ServicePrincipal, User
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.domain module¶
-
class
azure.graphrbac.models.domain.Domain(**kwargs)[source]¶ Active Directory Domain information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.domain_paged module¶
-
class
azure.graphrbac.models.domain_paged.DomainPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
DomainobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.domain_py3 module¶
-
class
azure.graphrbac.models.domain_py3.Domain(*, name: str, additional_properties=None, **kwargs)[source]¶ Active Directory Domain information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.get_objects_parameters module¶
-
class
azure.graphrbac.models.get_objects_parameters.GetObjectsParameters(**kwargs)[source]¶ Request parameters for the GetObjectsByObjectIds API.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.get_objects_parameters_py3 module¶
-
class
azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters(*, additional_properties=None, object_ids=None, types=None, include_directory_object_references: bool = None, **kwargs)[source]¶ Request parameters for the GetObjectsByObjectIds API.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.graph_error module¶
-
exception
azure.graphrbac.models.graph_error.GraphErrorException(deserialize, response, *args)[source]¶ Server responsed with exception of type: ‘GraphError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
with_traceback()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
args¶
-
class
azure.graphrbac.models.graph_error.GraphError(**kwargs)[source]¶ Active Directory error information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
azure.graphrbac.models.graph_error_py3 module¶
-
exception
azure.graphrbac.models.graph_error_py3.GraphErrorException(deserialize, response, *args)[source]¶ Server responsed with exception of type: ‘GraphError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
with_traceback()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
args¶
-
class
azure.graphrbac.models.graph_error_py3.GraphError(*, code: str = None, message: str = None, **kwargs)[source]¶ Active Directory error information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
azure.graphrbac.models.graph_rbac_management_client_enums module¶
azure.graphrbac.models.group_add_member_parameters module¶
-
class
azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters(**kwargs)[source]¶ Request parameters for adding a member to a group.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A member object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the member (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.group_add_member_parameters_py3 module¶
-
class
azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters(*, url: str, additional_properties=None, **kwargs)[source]¶ Request parameters for adding a member to a group.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A member object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the member (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.group_create_parameters module¶
-
class
azure.graphrbac.models.group_create_parameters.GroupCreateParameters(**kwargs)[source]¶ Request parameters for creating a new group.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
mail_enabled (bool) – Required. Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API. Default value: False .
security_enabled (bool) – Required. Whether the group is a security group. Must be true. This is because only pure security groups can be created using the Graph API. Default value: True .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
validate()¶ Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
mail_enabled= False¶
-
security_enabled= True¶
azure.graphrbac.models.group_create_parameters_py3 module¶
-
class
azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters(*, display_name: str, mail_nickname: str, additional_properties=None, **kwargs)[source]¶ Request parameters for creating a new group.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
mail_enabled (bool) – Required. Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API. Default value: False .
security_enabled (bool) – Required. Whether the group is a security group. Must be true. This is because only pure security groups can be created using the Graph API. Default value: True .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
validate()¶ Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
mail_enabled= False¶
-
security_enabled= True¶
azure.graphrbac.models.group_get_member_groups_parameters module¶
-
class
azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters(**kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.group_get_member_groups_parameters_py3 module¶
-
class
azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, **kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.informational_url module¶
-
class
azure.graphrbac.models.informational_url.InformationalUrl(**kwargs)[source]¶ Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each string is null.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.informational_url_py3 module¶
-
class
azure.graphrbac.models.informational_url_py3.InformationalUrl(*, terms_of_service: str = None, marketing: str = None, privacy: str = None, support: str = None, **kwargs)[source]¶ Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each string is null.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.key_credential module¶
-
class
azure.graphrbac.models.key_credential.KeyCredential(**kwargs)[source]¶ Active Directory Key Credential information.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
start_date (datetime) – Start date.
end_date (datetime) – End date.
value (str) – Key value.
key_id (str) – Key ID.
usage (str) – Usage. Acceptable values are ‘Verify’ and ‘Sign’.
type (str) – Type. Acceptable values are ‘AsymmetricX509Cert’ and ‘Symmetric’.
custom_key_identifier (str) – Custom Key Identifier
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.key_credential_paged module¶
-
class
azure.graphrbac.models.key_credential_paged.KeyCredentialPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
KeyCredentialobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.key_credential_py3 module¶
-
class
azure.graphrbac.models.key_credential_py3.KeyCredential(*, additional_properties=None, start_date=None, end_date=None, value: str = None, key_id: str = None, usage: str = None, type: str = None, custom_key_identifier: str = None, **kwargs)[source]¶ Active Directory Key Credential information.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
start_date (datetime) – Start date.
end_date (datetime) – End date.
value (str) – Key value.
key_id (str) – Key ID.
usage (str) – Usage. Acceptable values are ‘Verify’ and ‘Sign’.
type (str) – Type. Acceptable values are ‘AsymmetricX509Cert’ and ‘Symmetric’.
custom_key_identifier (str) – Custom Key Identifier
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.key_credentials_update_parameters module¶
-
class
azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters(**kwargs)[source]¶ Request parameters for a KeyCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[KeyCredential]) – Required. A collection of KeyCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.key_credentials_update_parameters_py3 module¶
-
class
azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters(*, value, **kwargs)[source]¶ Request parameters for a KeyCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[KeyCredential]) – Required. A collection of KeyCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.oauth2_permission module¶
-
class
azure.graphrbac.models.oauth2_permission.OAuth2Permission(**kwargs)[source]¶ Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.
- Parameters
admin_consent_description (str) – Permission help text that appears in the admin consent and app assignment experiences.
admin_consent_display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
id (str) – Unique scope permission identifier inside the oauth2Permissions collection.
is_enabled (bool) – When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.
type (str) – Specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are “User” or “Admin”.
user_consent_description (str) – Permission help text that appears in the end user consent experience.
user_consent_display_name (str) – Display name for the permission that appears in the end user consent experience.
value (str) – The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.oauth2_permission_grant module¶
-
class
azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant(**kwargs)[source]¶ OAuth2PermissionGrant.
- Parameters
odatatype (str) – Microsoft.DirectoryServices.OAuth2PermissionGrant
client_id (str) – The id of the resource’s service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId property).
object_id (str) – The id of the permission grant
consent_type (str or ConsentType) – Indicates if consent was provided by the administrator (on behalf of the organization) or by an individual. Possible values include: ‘AllPrincipals’, ‘Principal’
principal_id (str) – When consent type is Principal, this property specifies the id of the user that granted consent and applies only for that user.
resource_id (str) – Object Id of the resource you want to grant
scope (str) – Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. For example, User.Read
start_time (str) – Start time for TTL
expiry_time (str) – Expiry time for TTL
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.oauth2_permission_grant_paged module¶
-
class
azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
OAuth2PermissionGrantobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.oauth2_permission_grant_py3 module¶
-
class
azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant(*, odatatype: str = None, client_id: str = None, object_id: str = None, consent_type=None, principal_id: str = None, resource_id: str = None, scope: str = None, start_time: str = None, expiry_time: str = None, **kwargs)[source]¶ OAuth2PermissionGrant.
- Parameters
odatatype (str) – Microsoft.DirectoryServices.OAuth2PermissionGrant
client_id (str) – The id of the resource’s service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId property).
object_id (str) – The id of the permission grant
consent_type (str or ConsentType) – Indicates if consent was provided by the administrator (on behalf of the organization) or by an individual. Possible values include: ‘AllPrincipals’, ‘Principal’
principal_id (str) – When consent type is Principal, this property specifies the id of the user that granted consent and applies only for that user.
resource_id (str) – Object Id of the resource you want to grant
scope (str) – Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. For example, User.Read
start_time (str) – Start time for TTL
expiry_time (str) – Expiry time for TTL
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.oauth2_permission_py3 module¶
-
class
azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission(*, admin_consent_description: str = None, admin_consent_display_name: str = None, id: str = None, is_enabled: bool = None, type: str = None, user_consent_description: str = None, user_consent_display_name: str = None, value: str = None, **kwargs)[source]¶ Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.
- Parameters
admin_consent_description (str) – Permission help text that appears in the admin consent and app assignment experiences.
admin_consent_display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
id (str) – Unique scope permission identifier inside the oauth2Permissions collection.
is_enabled (bool) – When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.
type (str) – Specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are “User” or “Admin”.
user_consent_description (str) – Permission help text that appears in the end user consent experience.
user_consent_display_name (str) – Display name for the permission that appears in the end user consent experience.
value (str) – The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.optional_claim module¶
-
class
azure.graphrbac.models.optional_claim.OptionalClaim(**kwargs)[source]¶ Specifying the claims to be included in a token.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.optional_claim_py3 module¶
-
class
azure.graphrbac.models.optional_claim_py3.OptionalClaim(*, name: str = None, source: str = None, essential: bool = None, additional_properties=None, **kwargs)[source]¶ Specifying the claims to be included in a token.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.optional_claims module¶
-
class
azure.graphrbac.models.optional_claims.OptionalClaims(**kwargs)[source]¶ Specifying the claims to be included in the token.
- Parameters
id_token (list[OptionalClaim]) – Optional claims requested to be included in the id token.
access_token (list[OptionalClaim]) – Optional claims requested to be included in the access token.
saml_token (list[OptionalClaim]) – Optional claims requested to be included in the saml token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.optional_claims_py3 module¶
-
class
azure.graphrbac.models.optional_claims_py3.OptionalClaims(*, id_token=None, access_token=None, saml_token=None, **kwargs)[source]¶ Specifying the claims to be included in the token.
- Parameters
id_token (list[OptionalClaim]) – Optional claims requested to be included in the id token.
access_token (list[OptionalClaim]) – Optional claims requested to be included in the access token.
saml_token (list[OptionalClaim]) – Optional claims requested to be included in the saml token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_credential module¶
-
class
azure.graphrbac.models.password_credential.PasswordCredential(**kwargs)[source]¶ Active Directory Password Credential information.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_credential_paged module¶
-
class
azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
PasswordCredentialobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.password_credential_py3 module¶
-
class
azure.graphrbac.models.password_credential_py3.PasswordCredential(*, additional_properties=None, start_date=None, end_date=None, key_id: str = None, value: str = None, custom_key_identifier: bytearray = None, **kwargs)[source]¶ Active Directory Password Credential information.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_credentials_update_parameters module¶
-
class
azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters(**kwargs)[source]¶ Request parameters for a PasswordCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[PasswordCredential]) – Required. A collection of PasswordCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_credentials_update_parameters_py3 module¶
-
class
azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters(*, value, **kwargs)[source]¶ Request parameters for a PasswordCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[PasswordCredential]) – Required. A collection of PasswordCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_profile module¶
-
class
azure.graphrbac.models.password_profile.PasswordProfile(**kwargs)[source]¶ The password profile associated with a user.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.password_profile_py3 module¶
-
class
azure.graphrbac.models.password_profile_py3.PasswordProfile(*, password: str, additional_properties=None, force_change_password_next_login: bool = None, **kwargs)[source]¶ The password profile associated with a user.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.pre_authorized_application module¶
Contains information about pre authorized client application.
- Parameters
app_id (str) – Represents the application id.
permissions (list[PreAuthorizedApplicationPermission]) – Collection of required app permissions/entitlements from the resource application.
extensions (list[PreAuthorizedApplicationExtension]) – Collection of extensions from the resource application.
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.pre_authorized_application_extension module¶
Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.pre_authorized_application_extension_py3 module¶
Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.pre_authorized_application_permission module¶
Contains information about the pre-authorized permissions.
- Parameters
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.pre_authorized_application_permission_py3 module¶
Contains information about the pre-authorized permissions.
- Parameters
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.pre_authorized_application_py3 module¶
Contains information about pre authorized client application.
- Parameters
app_id (str) – Represents the application id.
permissions (list[PreAuthorizedApplicationPermission]) – Collection of required app permissions/entitlements from the resource application.
extensions (list[PreAuthorizedApplicationExtension]) – Collection of extensions from the resource application.
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
azure.graphrbac.models.required_resource_access module¶
-
class
azure.graphrbac.models.required_resource_access.RequiredResourceAccess(**kwargs)[source]¶ Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
resource_access (list[ResourceAccess]) – Required. The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resource_app_id (str) – The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.required_resource_access_py3 module¶
-
class
azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess(*, resource_access, additional_properties=None, resource_app_id: str = None, **kwargs)[source]¶ Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
resource_access (list[ResourceAccess]) – Required. The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resource_app_id (str) – The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.resource_access module¶
-
class
azure.graphrbac.models.resource_access.ResourceAccess(**kwargs)[source]¶ Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
id (str) – Required. The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.
type (str) – Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are “scope” or “role”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.resource_access_py3 module¶
-
class
azure.graphrbac.models.resource_access_py3.ResourceAccess(*, id: str, additional_properties=None, type: str = None, **kwargs)[source]¶ Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
id (str) – Required. The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.
type (str) – Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are “scope” or “role”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal module¶
-
class
azure.graphrbac.models.service_principal.ServicePrincipal(**kwargs)[source]¶ Active Directory service principal information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
account_enabled (bool) – whether or not the service principal account is enabled
app_id (str) – The application ID.
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
display_name (str) – The display name of the service principal.
error_url (str) – A URL provided by the author of the associated application to report errors when using the application.
homepage (str) – The URL to the homepage of the associated application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
logout_url (str) – A URL provided by the author of the associated application to logout
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
preferred_token_signing_key_thumbprint (str) – The thumbprint of preferred certificate to sign the token
publisher_name (str) – The publisher’s name of the associated application
reply_urls (list[str]) – The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.
saml_metadata_url (str) – The URL to the SAML metadata of the associated application
service_principal_names (list[str]) – A collection of service principal names.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
app_display_name (str) – The display name exposed by the associated application.
app_owner_tenant_id (str) –
oauth2_permissions (list[OAuth2Permission]) – The OAuth 2.0 permissions exposed by the associated application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_base module¶
-
class
azure.graphrbac.models.service_principal_base.ServicePrincipalBase(**kwargs)[source]¶ Active Directory service principal common properties shared among GET, POST and PATCH.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_base_py3 module¶
-
class
azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase(*, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Active Directory service principal common properties shared among GET, POST and PATCH.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_create_parameters module¶
-
class
azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters(**kwargs)[source]¶ Request parameters for creating a new service principal.
All required parameters must be populated in order to send to Azure.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
app_id (str) – Required. The application ID.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_create_parameters_py3 module¶
-
class
azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters(*, app_id: str, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Request parameters for creating a new service principal.
All required parameters must be populated in order to send to Azure.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
app_id (str) – Required. The application ID.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_object_result module¶
-
class
azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult(**kwargs)[source]¶ Service Principal Object Result.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_object_result_py3 module¶
-
class
azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult(*, value: str = None, odatametadata: str = None, **kwargs)[source]¶ Service Principal Object Result.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_paged module¶
-
class
azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ServicePrincipalobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.service_principal_py3 module¶
-
class
azure.graphrbac.models.service_principal_py3.ServicePrincipal(*, additional_properties=None, account_enabled: bool = None, alternative_names=None, app_id: str = None, app_role_assignment_required: bool = None, app_roles=None, display_name: str = None, error_url: str = None, homepage: str = None, key_credentials=None, logout_url: str = None, password_credentials=None, preferred_token_signing_key_thumbprint: str = None, publisher_name: str = None, reply_urls=None, saml_metadata_url: str = None, service_principal_names=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Active Directory service principal information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
account_enabled (bool) – whether or not the service principal account is enabled
app_id (str) – The application ID.
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
display_name (str) – The display name of the service principal.
error_url (str) – A URL provided by the author of the associated application to report errors when using the application.
homepage (str) – The URL to the homepage of the associated application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
logout_url (str) – A URL provided by the author of the associated application to logout
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
preferred_token_signing_key_thumbprint (str) – The thumbprint of preferred certificate to sign the token
publisher_name (str) – The publisher’s name of the associated application
reply_urls (list[str]) – The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.
saml_metadata_url (str) – The URL to the SAML metadata of the associated application
service_principal_names (list[str]) – A collection of service principal names.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
app_display_name (str) – The display name exposed by the associated application.
app_owner_tenant_id (str) –
oauth2_permissions (list[OAuth2Permission]) – The OAuth 2.0 permissions exposed by the associated application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_update_parameters module¶
-
class
azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters(**kwargs)[source]¶ Request parameters for update an existing service principal.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.service_principal_update_parameters_py3 module¶
-
class
azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters(*, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Request parameters for update an existing service principal.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.sign_in_name module¶
-
class
azure.graphrbac.models.sign_in_name.SignInName(**kwargs)[source]¶ Contains information about a sign-in name of a local account user in an Azure Active Directory B2C tenant.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – A string value that can be used to classify user sign-in types in your directory, such as ‘emailAddress’ or ‘userName’.
value (str) – The sign-in used by the local account. Must be unique across the company/tenant. For example, ‘johnc@example.com’.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.sign_in_name_py3 module¶
-
class
azure.graphrbac.models.sign_in_name_py3.SignInName(*, additional_properties=None, type: str = None, value: str = None, **kwargs)[source]¶ Contains information about a sign-in name of a local account user in an Azure Active Directory B2C tenant.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – A string value that can be used to classify user sign-in types in your directory, such as ‘emailAddress’ or ‘userName’.
value (str) – The sign-in used by the local account. Must be unique across the company/tenant. For example, ‘johnc@example.com’.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.str_paged module¶
-
class
azure.graphrbac.models.str_paged.StrPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of str object
Bring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.user module¶
-
class
azure.graphrbac.models.user.User(**kwargs)[source]¶ Active Directory user information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
user_principal_name (str) – The principal name of the user.
mail_nickname (str) – The mail alias for the user.
mail (str) – The primary email address of the user.
sign_in_names (list[SignInName]) – The sign-in names of the user.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_base module¶
-
class
azure.graphrbac.models.user_base.UserBase(**kwargs)[source]¶ UserBase.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_base_py3 module¶
-
class
azure.graphrbac.models.user_base_py3.UserBase(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, **kwargs)[source]¶ UserBase.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_create_parameters module¶
-
class
azure.graphrbac.models.user_create_parameters.UserCreateParameters(**kwargs)[source]¶ Request parameters for creating a new work or school account user.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Required. Whether the account is enabled.
display_name (str) – Required. The display name of the user.
password_profile (PasswordProfile) – Required. Password Profile
user_principal_name (str) – Required. The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – Required. The mail alias for the user.
mail (str) – The primary email address of the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_create_parameters_py3 module¶
-
class
azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile, user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, mail: str = None, **kwargs)[source]¶ Request parameters for creating a new work or school account user.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Required. Whether the account is enabled.
display_name (str) – Required. The display name of the user.
password_profile (PasswordProfile) – Required. Password Profile
user_principal_name (str) – Required. The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – Required. The mail alias for the user.
mail (str) – The primary email address of the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_get_member_groups_parameters module¶
-
class
azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters(**kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_get_member_groups_parameters_py3 module¶
-
class
azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, **kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_paged module¶
-
class
azure.graphrbac.models.user_paged.UserPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
UserobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
azure.graphrbac.models.user_py3 module¶
-
class
azure.graphrbac.models.user_py3.User(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: bool = None, display_name: str = None, user_principal_name: str = None, mail_nickname: str = None, mail: str = None, sign_in_names=None, **kwargs)[source]¶ Active Directory user information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
user_principal_name (str) – The principal name of the user.
mail_nickname (str) – The mail alias for the user.
mail (str) – The primary email address of the user.
sign_in_names (list[SignInName]) – The sign-in names of the user.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_update_parameters module¶
-
class
azure.graphrbac.models.user_update_parameters.UserUpdateParameters(**kwargs)[source]¶ Request parameters for updating an existing work or school account user.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
password_profile (PasswordProfile) – The password profile of the user.
user_principal_name (str) – The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – The mail alias for the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.graphrbac.models.user_update_parameters_py3 module¶
-
class
azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: bool = None, display_name: str = None, password_profile=None, user_principal_name: str = None, mail_nickname: str = None, **kwargs)[source]¶ Request parameters for updating an existing work or school account user.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
password_profile (PasswordProfile) – The password profile of the user.
user_principal_name (str) – The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – The mail alias for the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Module contents¶
-
exception
azure.graphrbac.models.GraphErrorException(deserialize, response, *args)[source]¶ Server responsed with exception of type: ‘GraphError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
with_traceback()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
args¶
-
class
azure.graphrbac.models.InformationalUrl(*, terms_of_service: str = None, marketing: str = None, privacy: str = None, support: str = None, **kwargs)[source]¶ Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each string is null.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.OAuth2Permission(*, admin_consent_description: str = None, admin_consent_display_name: str = None, id: str = None, is_enabled: bool = None, type: str = None, user_consent_description: str = None, user_consent_display_name: str = None, value: str = None, **kwargs)[source]¶ Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.
- Parameters
admin_consent_description (str) – Permission help text that appears in the admin consent and app assignment experiences.
admin_consent_display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
id (str) – Unique scope permission identifier inside the oauth2Permissions collection.
is_enabled (bool) – When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.
type (str) – Specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are “User” or “Admin”.
user_consent_description (str) – Permission help text that appears in the end user consent experience.
user_consent_display_name (str) – Display name for the permission that appears in the end user consent experience.
value (str) – The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.OptionalClaim(*, name: str = None, source: str = None, essential: bool = None, additional_properties=None, **kwargs)[source]¶ Specifying the claims to be included in a token.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.OptionalClaims(*, id_token=None, access_token=None, saml_token=None, **kwargs)[source]¶ Specifying the claims to be included in the token.
- Parameters
id_token (list[OptionalClaim]) – Optional claims requested to be included in the id token.
access_token (list[OptionalClaim]) – Optional claims requested to be included in the access token.
saml_token (list[OptionalClaim]) – Optional claims requested to be included in the saml token.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.PreAuthorizedApplicationPermission(*, direct_access_grant: bool = None, access_grants=None, **kwargs)[source]¶ Contains information about the pre-authorized permissions.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.PreAuthorizedApplicationExtension(*, conditions=None, **kwargs)[source]¶ Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
-
class
azure.graphrbac.models.PreAuthorizedApplication(*, app_id: str = None, permissions=None, extensions=None, **kwargs)[source]¶ Contains information about pre authorized client application.
- Parameters
app_id (str) – Represents the application id.
permissions (list[PreAuthorizedApplicationPermission]) – Collection of required app permissions/entitlements from the resource application.
extensions (list[PreAuthorizedApplicationExtension]) – Collection of extensions from the resource application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.GraphError(*, code: str = None, message: str = None, **kwargs)[source]¶ Active Directory error information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
-
class
azure.graphrbac.models.DirectoryObject(*, additional_properties=None, **kwargs)[source]¶ Represents an Azure Active Directory object.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Application, ADGroup, ServicePrincipal, User
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.KeyCredential(*, additional_properties=None, start_date=None, end_date=None, value: str = None, key_id: str = None, usage: str = None, type: str = None, custom_key_identifier: str = None, **kwargs)[source]¶ Active Directory Key Credential information.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
start_date (datetime) – Start date.
end_date (datetime) – End date.
value (str) – Key value.
key_id (str) – Key ID.
usage (str) – Usage. Acceptable values are ‘Verify’ and ‘Sign’.
type (str) – Type. Acceptable values are ‘AsymmetricX509Cert’ and ‘Symmetric’.
custom_key_identifier (str) – Custom Key Identifier
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.PasswordCredential(*, additional_properties=None, start_date=None, end_date=None, key_id: str = None, value: str = None, custom_key_identifier: bytearray = None, **kwargs)[source]¶ Active Directory Password Credential information.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ResourceAccess(*, id: str, additional_properties=None, type: str = None, **kwargs)[source]¶ Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
id (str) – Required. The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.
type (str) – Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are “scope” or “role”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.RequiredResourceAccess(*, resource_access, additional_properties=None, resource_app_id: str = None, **kwargs)[source]¶ Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
resource_access (list[ResourceAccess]) – Required. The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resource_app_id (str) – The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.AppRole(*, id: str = None, allowed_member_types=None, description: str = None, display_name: str = None, is_enabled: bool = None, value: str = None, **kwargs)[source]¶ AppRole.
- Parameters
id (str) – Unique role identifier inside the appRoles collection.
allowed_member_types (list[str]) – Specifies whether this app role definition can be assigned to users and groups by setting to ‘User’, or to other applications (that are accessing this application in daemon service scenarios) by setting to ‘Application’, or to both.
description (str) – Permission help text that appears in the admin app assignment and consent experiences.
display_name (str) – Display name for the permission that appears in the admin consent and app assignment experiences.
is_enabled (bool) – When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
value (str) – Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ApplicationBase(*, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, **kwargs)[source]¶ Active Directive Application common properties shared among GET, POST and PATCH.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ApplicationCreateParameters(*, display_name: str, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, identifier_uris=None, **kwargs)[source]¶ Request parameters for creating a new application.
All required parameters must be populated in order to send to Azure.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – Required. The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ApplicationUpdateParameters(*, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, error_url: str = None, group_membership_claims=None, homepage: str = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, display_name: str = None, identifier_uris=None, **kwargs)[source]¶ Request parameters for updating a new application.
- Parameters
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
display_name (str) – The display name of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.Application(*, additional_properties=None, app_id: str = None, allow_guests_sign_in: bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: bool = None, display_name: str = None, error_url: str = None, group_membership_claims=None, homepage: str = None, identifier_uris=None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str = None, **kwargs)[source]¶ Active Directory application information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
app_id (str) – The application ID.
allow_guests_sign_in (bool) – A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
allow_passthrough_users (bool) – Indicates that the application supports pass through users who have no presence in the resource tenant.
app_logo_url (str) – The url for the application logo image stored in a CDN.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
available_to_other_tenants (bool) – Whether the application is available to other tenants.
display_name (str) – The display name of the application.
error_url (str) – A URL provided by the author of the application to report errors when using the application.
group_membership_claims (object) – Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage (str) – The home page of the application.
identifier_uris (list[str]) – A collection of URIs for the application.
informational_urls (InformationalUrl) – URLs with more information about the application.
is_device_only_auth_supported (bool) – Specifies whether this application supports device authentication without a user. The default is false.
key_credentials (list[KeyCredential]) – A collection of KeyCredential objects.
known_client_applications (list[str]) – Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
logout_url (str) – the url of the logout page
oauth2_allow_implicit_flow (bool) – Whether to allow implicit grant flow for OAuth2
oauth2_allow_url_path_matching (bool) – Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
oauth2_permissions (list[OAuth2Permission]) – The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
oauth2_require_post_response (bool) – Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
org_restrictions (list[str]) – A list of tenants allowed to access application.
optional_claims (OptionalClaims) –
password_credentials (list[PasswordCredential]) – A collection of PasswordCredential objects
pre_authorized_applications (list[PreAuthorizedApplication]) – list of pre-authorized applications.
public_client (bool) – Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
publisher_domain (str) – Reliable domain which can be used to identify an application.
reply_urls (list[str]) – A collection of reply URLs for the application.
required_resource_access (list[RequiredResourceAccess]) – Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
saml_metadata_url (str) – The URL to the SAML metadata for the application.
sign_in_audience (str) – Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
www_homepage (str) – The primary Web page.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ServicePrincipalObjectResult(*, value: str = None, odatametadata: str = None, **kwargs)[source]¶ Service Principal Object Result.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.AddOwnerParameters(*, url: str, additional_properties=None, **kwargs)[source]¶ Request parameters for adding a owner to an application.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A owner object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the owner (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.KeyCredentialsUpdateParameters(*, value, **kwargs)[source]¶ Request parameters for a KeyCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[KeyCredential]) – Required. A collection of KeyCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.PasswordCredentialsUpdateParameters(*, value, **kwargs)[source]¶ Request parameters for a PasswordCredentials update operation.
All required parameters must be populated in order to send to Azure.
- Parameters
value (list[PasswordCredential]) – Required. A collection of PasswordCredentials.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.GroupAddMemberParameters(*, url: str, additional_properties=None, **kwargs)[source]¶ Request parameters for adding a member to a group.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
url (str) – Required. A member object URL, such as “https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd”, where “0b1f9851-1bf0-433f-aec3-cb9272f093dc” is the tenantId and “f260bbc4-c254-447b-94cf-293b5ec434dd” is the objectId of the member (user, application, servicePrincipal, group) to be added.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.GroupCreateParameters(*, display_name: str, mail_nickname: str, additional_properties=None, **kwargs)[source]¶ Request parameters for creating a new group.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
mail_enabled (bool) – Required. Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API. Default value: False .
security_enabled (bool) – Required. Whether the group is a security group. Must be true. This is because only pure security groups can be created using the Graph API. Default value: True .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
validate()¶ Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
mail_enabled= False¶
-
security_enabled= True¶
-
class
azure.graphrbac.models.ADGroup(*, additional_properties=None, display_name: str = None, mail_enabled: bool = None, mail_nickname: str = None, security_enabled: bool = None, mail: str = None, **kwargs)[source]¶ Active Directory group information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
display_name (str) – The display name of the group.
mail_enabled (bool) – Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API.
mail_nickname (str) – The mail alias for the group.
security_enabled (bool) – Whether the group is security-enable.
mail (str) – The primary email address of the group.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.GroupGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, **kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.CheckGroupMembershipParameters(*, group_id: str, member_id: str, additional_properties=None, **kwargs)[source]¶ Request parameters for IsMemberOf API call.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
group_id (str) – Required. The object ID of the group to check.
member_id (str) – Required. The object ID of the contact, group, user, or service principal to check for membership in the specified group.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.CheckGroupMembershipResult(*, additional_properties=None, value: bool = None, **kwargs)[source]¶ Server response for IsMemberOf API call.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ServicePrincipalBase(*, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Active Directory service principal common properties shared among GET, POST and PATCH.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ServicePrincipalCreateParameters(*, app_id: str, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Request parameters for creating a new service principal.
All required parameters must be populated in order to send to Azure.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
app_id (str) – Required. The application ID.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ServicePrincipalUpdateParameters(*, account_enabled: bool = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Request parameters for update an existing service principal.
- Parameters
account_enabled (bool) – whether or not the service principal account is enabled
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.ServicePrincipal(*, additional_properties=None, account_enabled: bool = None, alternative_names=None, app_id: str = None, app_role_assignment_required: bool = None, app_roles=None, display_name: str = None, error_url: str = None, homepage: str = None, key_credentials=None, logout_url: str = None, password_credentials=None, preferred_token_signing_key_thumbprint: str = None, publisher_name: str = None, reply_urls=None, saml_metadata_url: str = None, service_principal_names=None, service_principal_type: str = None, tags=None, **kwargs)[source]¶ Active Directory service principal information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
account_enabled (bool) – whether or not the service principal account is enabled
app_id (str) – The application ID.
app_role_assignment_required (bool) – Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
app_roles (list[AppRole]) – The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
display_name (str) – The display name of the service principal.
error_url (str) – A URL provided by the author of the associated application to report errors when using the application.
homepage (str) – The URL to the homepage of the associated application.
key_credentials (list[KeyCredential]) – The collection of key credentials associated with the service principal.
logout_url (str) – A URL provided by the author of the associated application to logout
password_credentials (list[PasswordCredential]) – The collection of password credentials associated with the service principal.
preferred_token_signing_key_thumbprint (str) – The thumbprint of preferred certificate to sign the token
publisher_name (str) – The publisher’s name of the associated application
reply_urls (list[str]) – The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.
saml_metadata_url (str) – The URL to the SAML metadata of the associated application
service_principal_names (list[str]) – A collection of service principal names.
service_principal_type (str) – the type of the service principal
tags (list[str]) – Optional list of tags that you can apply to your service principals. Not nullable.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
app_display_name (str) – The display name exposed by the associated application.
app_owner_tenant_id (str) –
oauth2_permissions (list[OAuth2Permission]) – The OAuth 2.0 permissions exposed by the associated application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.PasswordProfile(*, password: str, additional_properties=None, force_change_password_next_login: bool = None, **kwargs)[source]¶ The password profile associated with a user.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.UserBase(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, **kwargs)[source]¶ UserBase.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile, user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, mail: str = None, **kwargs)[source]¶ Request parameters for creating a new work or school account user.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Required. Whether the account is enabled.
display_name (str) – Required. The display name of the user.
password_profile (PasswordProfile) – Required. Password Profile
user_principal_name (str) – Required. The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – Required. The mail alias for the user.
mail (str) – The primary email address of the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.UserUpdateParameters(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: bool = None, display_name: str = None, password_profile=None, user_principal_name: str = None, mail_nickname: str = None, **kwargs)[source]¶ Request parameters for updating an existing work or school account user.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
password_profile (PasswordProfile) – The password profile of the user.
user_principal_name (str) – The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
mail_nickname (str) – The mail alias for the user.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.SignInName(*, additional_properties=None, type: str = None, value: str = None, **kwargs)[source]¶ Contains information about a sign-in name of a local account user in an Azure Active Directory B2C tenant.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
type (str) – A string value that can be used to classify user sign-in types in your directory, such as ‘emailAddress’ or ‘userName’.
value (str) – The sign-in used by the local account. Must be unique across the company/tenant. For example, ‘johnc@example.com’.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.User(*, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: bool = None, display_name: str = None, user_principal_name: str = None, mail_nickname: str = None, mail: str = None, sign_in_names=None, **kwargs)[source]¶ Active Directory user information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
object_type (str) – Required. Constant filled by server.
immutable_id (str) – This must be specified if you are using a federated domain for the user’s userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
usage_location (str) – A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: “US”, “JP”, and “GB”.
given_name (str) – The given name for the user.
surname (str) – The user’s surname (family name or last name).
user_type (str or UserType) – A string value that can be used to classify user types in your directory, such as ‘Member’ and ‘Guest’. Possible values include: ‘Member’, ‘Guest’
account_enabled (bool) – Whether the account is enabled.
display_name (str) – The display name of the user.
user_principal_name (str) – The principal name of the user.
mail_nickname (str) – The mail alias for the user.
mail (str) – The primary email address of the user.
sign_in_names (list[SignInName]) – The sign-in names of the user.
- Variables
object_id (str) – The object ID.
deletion_timestamp (datetime) – The time at which the directory object was deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.UserGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, **kwargs)[source]¶ Request parameters for GetMemberGroups API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.GetObjectsParameters(*, additional_properties=None, object_ids=None, types=None, include_directory_object_references: bool = None, **kwargs)[source]¶ Request parameters for the GetObjectsByObjectIds API.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.Domain(*, name: str, additional_properties=None, **kwargs)[source]¶ Active Directory Domain information.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.OAuth2PermissionGrant(*, odatatype: str = None, client_id: str = None, object_id: str = None, consent_type=None, principal_id: str = None, resource_id: str = None, scope: str = None, start_time: str = None, expiry_time: str = None, **kwargs)[source]¶ OAuth2PermissionGrant.
- Parameters
odatatype (str) – Microsoft.DirectoryServices.OAuth2PermissionGrant
client_id (str) – The id of the resource’s service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId property).
object_id (str) – The id of the permission grant
consent_type (str or ConsentType) – Indicates if consent was provided by the administrator (on behalf of the organization) or by an individual. Possible values include: ‘AllPrincipals’, ‘Principal’
principal_id (str) – When consent type is Principal, this property specifies the id of the user that granted consent and applies only for that user.
resource_id (str) – Object Id of the resource you want to grant
scope (str) – Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. For example, User.Read
start_time (str) – Start time for TTL
expiry_time (str) – Expiry time for TTL
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.graphrbac.models.DirectoryObjectPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
DirectoryObjectobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.ApplicationPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ApplicationobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.KeyCredentialPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
KeyCredentialobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.PasswordCredentialPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
PasswordCredentialobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.ADGroupPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ADGroupobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.StrPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of str object
Bring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.ServicePrincipalPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
ServicePrincipalobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.UserPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
UserobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.DomainPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
DomainobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-
-
class
azure.graphrbac.models.OAuth2PermissionGrantPaged(*args, **kwargs)[source]¶ A paging container for iterating over a list of
OAuth2PermissionGrantobjectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
advance_page()¶ Force moving the cursor to the next azure call.
This method is for advanced usage, iterator protocol is prefered.
- Raises
StopIteration if no further page
- Returns
The current page list
- Return type
-
async
async_advance_page()¶
-
async
async_get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
get(url)¶ Get an arbitrary page.
This resets the iterator and then fully consumes it to return the specific page only.
- Parameters
url (str) – URL to arbitrary page results.
-
next()¶ Iterate through responses.
-
reset()¶ Reset iterator to first page.
-
property
raw¶ Get current page as ClientRawResponse.
- Return type
ClientRawResponse
-