ApplicationsOperations Class

ApplicationsOperations operations.

Inheritance

builtins.object

ApplicationsOperations

Constructor

ApplicationsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

api_version

Client API version. Constant value: "1.6".

Methods

add_owner	Add an owner to an application.
create	Create a new application.
delete	Delete an application.
get	Get an application by object ID.
get_service_principals_id_by_app_id	Gets an object id for a given application id from the current tenant.
list	Lists applications by filter parameters.
list_key_credentials	Get the keyCredentials associated with an application.
list_owners	Directory objects that are owners of the application. The owners are a set of non-admin users who are allowed to modify this object.
list_password_credentials	Get the passwordCredentials associated with an application.
patch	Update an existing application.
remove_owner	Remove a member from owners.
update_key_credentials	Update the keyCredentials associated with an application.
update_password_credentials	Update passwordCredentials associated with an application.

add_owner

Add an owner to an application.

add_owner(application_object_id, url, additional_properties=None, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

The object ID of the application to which to add the owner.

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.

additional_properties

dict[str, object]

default value: None

Unmatched properties from the message are deserialized this collection

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

create

Create a new application.

create(parameters, custom_headers=None, raw=False, **operation_config)

Parameters

parameters

ApplicationCreateParameters

Required

The parameters for creating an application.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Application or ClientRawResponse if raw=true

Return type

Application,

ClientRawResponse

Exceptions

GraphErrorException

delete

Delete an application.

delete(application_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

get

Get an application by object ID.

get(application_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Application or ClientRawResponse if raw=true

Return type

Application,

ClientRawResponse

Exceptions

GraphErrorException

get_service_principals_id_by_app_id

Gets an object id for a given application id from the current tenant.

get_service_principals_id_by_app_id(application_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_id

str

Required

The application ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

ServicePrincipalObjectResult or ClientRawResponse if raw=true

Return type

ServicePrincipalObjectResult,

ClientRawResponse

Exceptions

GraphErrorException

list

Lists applications by filter parameters.

list(filter=None, custom_headers=None, raw=False, **operation_config)

Parameters

filter

str

default value: None

The filters to apply to the operation.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of Application

Return type

ApplicationPaged[Application]

Exceptions

GraphErrorException

list_key_credentials

Get the keyCredentials associated with an application.

list_key_credentials(application_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of KeyCredential

Return type

KeyCredentialPaged[KeyCredential]

Exceptions

GraphErrorException

list_owners

Directory objects that are owners of the application.

The owners are a set of non-admin users who are allowed to modify this object.

list_owners(application_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

The object ID of the application for which to get owners.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of DirectoryObject

Return type

DirectoryObjectPaged[DirectoryObject]

Exceptions

GraphErrorException

list_password_credentials

Get the passwordCredentials associated with an application.

list_password_credentials(application_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of PasswordCredential

Return type

PasswordCredentialPaged[PasswordCredential]

Exceptions

GraphErrorException

patch

Update an existing application.

patch(application_object_id, parameters, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

parameters

ApplicationUpdateParameters

Required

Parameters to update an existing application.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

remove_owner

Remove a member from owners.

remove_owner(application_object_id, owner_object_id, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

The object ID of the application from which to remove the owner.

owner_object_id

str

Required

Owner object id

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

update_key_credentials

Update the keyCredentials associated with an application.

update_key_credentials(application_object_id, value, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

value

list[KeyCredential]

Required

A collection of KeyCredentials.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

update_password_credentials

Update passwordCredentials associated with an application.

update_password_credentials(application_object_id, value, custom_headers=None, raw=False, **operation_config)

Parameters

application_object_id

str

Required

Application object ID.

value

list[PasswordCredential]

Required

A collection of PasswordCredentials.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

GraphErrorException

Attributes

models

models = <module 'azure.graphrbac.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\graphrbac\\models\\__init__.py'>