KMP PHP API Reference

TenantDocumentProvisioner
in package

FinalYes

Provision private tenant containers and their fixed, blob-only runtime grant.

Table of Contents

Properties

$client  : Client|null
$createContainer  : Closure|null
$credential  : TokenCredential|null

Methods

__construct()  : mixed
ensure()  : void
grant()  : array{url: string, body: array}
Validate all target data before container creation or management requests.
plan()  : array{azure: array, grant: array{url: string, body: array}}
Resolve and validate a proposed grant without making external writes.
armGuid()  : string
Match ARM guid() so Bicep and provisioning update the same role assignment.

Properties

Methods

__construct()

public __construct([Client|null $client = null ][, TokenCredential|null $credential = null ][, Closure|null $createContainer = null ]) : mixed
Parameters
$client : Client|null = null

Management HTTP client

$credential : TokenCredential|null = null

Management credential

$createContainer : Closure|null = null

Optional test container creator

grant()

Validate all target data before container creation or management requests.

public static grant(array<string, mixed> $azure, array<string, string> $config) : array{url: string, body: array}
Parameters
$azure : array<string, mixed>

Document adapter config

$config : array<string, string>

Administrative grant config

Return values
array{url: string, body: array}

plan()

Resolve and validate a proposed grant without making external writes.

public plan([TenantMetadata|null $tenant = null ]) : array{azure: array, grant: array{url: string, body: array}}
Parameters
$tenant : TenantMetadata|null = null

Registered tenant or default container

Return values
array{azure: array, grant: array{url: string, body: array}}

armGuid()

Match ARM guid() so Bicep and provisioning update the same role assignment.

private static armGuid(string ...$parts) : string
Parameters
$parts : string
Return values
string
On this page

Search results