Class TenantService

Calls the nebius.iam.v2.TenantService service through the Nebius SDK.

Implements

TenantService

Implemented by

TenantService

Index

Constructors

constructor

new TenantService(sdk: SDKInterface): TenantService
Creates a client that uses the SDK service address.
Parameters
- sdk: SDKInterface
Returns TenantService
- Defined in src/api/nebius/iam/v2/index.ts:6922

Properties

$type

$type: "nebius.iam.v2.TenantService"

Contains the fully qualified protobuf service name.

Methods

filter

filter(
    request: ListTenantsRequest,
    metadata?: Metadata,
    options?: Partial<CallOptions> & RetryOptions,
): AsyncGenerator<Tenant>
Calls the filter method.
Parameters
- request: ListTenantsRequest
- Optionalmetadata: Metadata
- Optionaloptions: Partial<CallOptions> & RetryOptions
Returns AsyncGenerator<Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6911
filter(
    request: ListTenantsRequest,
    metadata?: Metadata,
    options?: Partial<CallOptions> & RetryOptions,
): AsyncGenerator<Tenant>
Yields list items across pages, without changing the supplied request.
Parameters
- request: ListTenantsRequest
- Optionalmetadata: Metadata
- Optionaloptions: Partial<CallOptions> & RetryOptions
Returns AsyncGenerator<Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:7037

get

get(request: GetTenantRequest): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6861
get(
request: GetTenantRequest,
metadata: Metadata,
): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
- metadata: Metadata
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6865
get(
    request: GetTenantRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6869
get(request: GetTenantRequest): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6940
get(
request: GetTenantRequest,
metadata: Metadata,
): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
- metadata: Metadata
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6944
get(
    request: GetTenantRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<GetTenantRequest, Tenant>
Calls the Get RPC.
Parameters
- request: GetTenantRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<GetTenantRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6948

getByName

getByName(
request: GetTenantByNameRequest,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6873
getByName(
request: GetTenantByNameRequest,
metadata: Metadata,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
- metadata: Metadata
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6877
getByName(
    request: GetTenantByNameRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6881
getByName(
request: GetTenantByNameRequest,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6964
getByName(
request: GetTenantByNameRequest,
metadata: Metadata,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
- metadata: Metadata
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6968
getByName(
    request: GetTenantByNameRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<GetTenantByNameRequest, Tenant>
Calls the GetByName RPC.
Parameters
- request: GetTenantByNameRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<GetTenantByNameRequest, Tenant>
- Defined in src/api/nebius/iam/v2/index.ts:6972

getOperationService

getOperationService(): OperationService
Returns the operation service for this service address.

Returns OperationService
- Defined in src/api/nebius/iam/v2/index.ts:6929

list

list(
request: ListTenantsRequest,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6885
list(
request: ListTenantsRequest,
metadata: Metadata,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
- metadata: Metadata
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6889
list(
    request: ListTenantsRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6893
list(
request: ListTenantsRequest,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6988
list(
request: ListTenantsRequest,
metadata: Metadata,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
- metadata: Metadata
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6992
list(
    request: ListTenantsRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<ListTenantsRequest, ListTenantsResponse>
Calls the List RPC.
Parameters
- request: ListTenantsRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<ListTenantsRequest, ListTenantsResponse>
- Defined in src/api/nebius/iam/v2/index.ts:6996

listOperations

listOperations(
    request: ListOperationsRequest,
    metadata?: Metadata,
    options?: Partial<CallOptions> & RetryOptions,
): Request<ListOperationsRequest>
Lists operations for this service address.
Parameters
- request: ListOperationsRequest
- metadata: Metadata = ...
- options: Partial<CallOptions> & RetryOptions = {}
Returns Request<ListOperationsRequest>
- Defined in src/api/nebius/iam/v2/index.ts:6933

update

update(
request: UpdateTenantRequest,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:6897
update(
request: UpdateTenantRequest,
metadata: Metadata,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
- metadata: Metadata
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:6901
update(
    request: UpdateTenantRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:6905
update(
request: UpdateTenantRequest,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:7012
update(
request: UpdateTenantRequest,
metadata: Metadata,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
- metadata: Metadata
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:7016
update(
    request: UpdateTenantRequest,
    metadata: Metadata,
    options: Partial<CallOptions> & RetryOptions,
): Request<UpdateTenantRequest, Operation<GetOperationRequest>>
Calls the Update RPC.
Parameters
- request: UpdateTenantRequest
- metadata: Metadata
- options: Partial<CallOptions> & RetryOptions
Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>
- Defined in src/api/nebius/iam/v2/index.ts:7020

Class TenantService

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TenantService

Properties

$type

Methods

filter

Parameters

Returns AsyncGenerator<Tenant>

Parameters

Returns AsyncGenerator<Tenant>

get

Parameters

Returns Request<GetTenantRequest, Tenant>

Parameters

Returns Request<GetTenantRequest, Tenant>

Parameters

Returns Request<GetTenantRequest, Tenant>

Parameters

Returns Request<GetTenantRequest, Tenant>

Parameters

Returns Request<GetTenantRequest, Tenant>

Parameters

Returns Request<GetTenantRequest, Tenant>

getByName

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

Parameters

Returns Request<GetTenantByNameRequest, Tenant>

getOperationService

Returns OperationService

list

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

Parameters

Returns Request<ListTenantsRequest, ListTenantsResponse>

listOperations

Parameters

Returns Request<ListOperationsRequest>

update

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Parameters

Returns Request<UpdateTenantRequest, Operation<GetOperationRequest>>

Settings

On This Page