BillingPermissionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:billing_permissions> attribute.

Constructor

BillingPermissionsOperations(*args, **kwargs)

Methods

check_access_by_billing_account	Provides a list of check access response objects for a billing account.
check_access_by_billing_profile	Provides a list of check access response objects for a billing profile.
check_access_by_customer	Provides a list of check access response objects for a customer.
check_access_by_department	Provides a list of check access response objects for a department.
check_access_by_enrollment_account	Provides a list of check access response objects for an enrollment account.
check_access_by_invoice_section	Provides a list of check access response objects for an invoice section.
list_by_billing_account	Lists the billing permissions the caller has on a billing account.
list_by_billing_profile	Lists the billing permissions the caller has on a billing profile.
list_by_customer	Lists the billing permissions the caller has for a customer.
list_by_customer_at_billing_account	Lists the billing permissions the caller has for a customer at billing account level.
list_by_department	Lists the billing permissions the caller has for a department.
list_by_enrollment_account	Lists the billing permissions the caller has for an enrollment account.
list_by_invoice_section	Lists the billing permissions the caller has for an invoice section.

check_access_by_billing_account

Provides a list of check access response objects for a billing account.

check_access_by_billing_account(billing_account_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

check_access_by_billing_profile

Provides a list of check access response objects for a billing profile.

check_access_by_billing_profile(billing_account_name: str, billing_profile_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

check_access_by_customer

Provides a list of check access response objects for a customer.

check_access_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
customer_name Required	str The ID that uniquely identifies a customer. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

check_access_by_department

Provides a list of check access response objects for a department.

check_access_by_department(billing_account_name: str, department_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
department_name Required	str The name of the department. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

check_access_by_enrollment_account

Provides a list of check access response objects for an enrollment account.

check_access_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
enrollment_account_name Required	str The name of the enrollment account. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

check_access_by_invoice_section

Provides a list of check access response objects for an invoice section.

check_access_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, parameters: _models.CheckAccessRequest, *, content_type: str = 'application/json', **kwargs: Any) -> List[_models.CheckAccessResponse]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
invoice_section_name Required	str The ID that uniquely identifies an invoice section. Required.
parameters Required	CheckAccessRequest or <xref:JSON> or IO[bytes] The request object against which access of the caller will be checked. Is one of the following types: CheckAccessRequest, JSON, IO[bytes] Required.

Returns

Type	Description
list[CheckAccessResponse]	list of CheckAccessResponse

Exceptions

Type	Description
HttpResponseError

list_by_billing_account

Lists the billing permissions the caller has on a billing account.

list_by_billing_account(billing_account_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_billing_profile

Lists the billing permissions the caller has on a billing profile.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_customer

Lists the billing permissions the caller has for a customer.

list_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
customer_name Required	str The ID that uniquely identifies a customer. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_customer_at_billing_account

Lists the billing permissions the caller has for a customer at billing account level.

list_by_customer_at_billing_account(billing_account_name: str, customer_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
customer_name Required	str The ID that uniquely identifies a customer. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_department

Lists the billing permissions the caller has for a department.

list_by_department(billing_account_name: str, department_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
department_name Required	str The name of the department. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_enrollment_account

Lists the billing permissions the caller has for an enrollment account.

list_by_enrollment_account(billing_account_name: str, enrollment_account_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
enrollment_account_name Required	str The name of the enrollment account. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

list_by_invoice_section

Lists the billing permissions the caller has for an invoice section.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, **kwargs: Any) -> ItemPaged[BillingPermission]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
invoice_section_name Required	str The ID that uniquely identifies an invoice section. Required.

Returns

Type	Description
ItemPaged[BillingPermission]	An iterator like instance of BillingPermission

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?