UpdateTenant
Operatie voor het bijwerken van een tenant of de eigenschappen voor een onderliggende tenant van de root tenant:
<UpdateTenant>
<Tenant>
<Name>MyTenantName</Name>
</Tenant>
<User>
<Name>MyUser</Name>
</User>
<Operations>
<ImportDatasource>datasource.xml</ImportDatasource>
</Operations>
</UpdateTenant>
Bovenstaand script voert voert de operatie ImportDatasource uit op de geselecteerde tenant. De operatie UpdateTenant kan ook gebruikt worden om een eigenschappen van een tenant te veranderen:
<UpdateTenant>
<Tenant>
<Name>MyTenantName</Name>
</Tenant>
<Properties>
<Name>MyNewTenantName</Name>
<Active>Yes</Active>
</Properties>
</UpdateTenant>
Bovenstaand script hernoemt de tenant en zet de tenant op actief.
De operatie UpdateTenant mag alleen worden uitgevoerd onder de root tenant, omdat een onderliggende tenant zelf geen tenants heeft.
Parameters
De UpdateTenant operatie heeft de volgende parameters:
| Element | Verplicht | Omschrijving |
|---|---|---|
| Tenant | Yes | Referentie naar de tenant waar de bewerkingen op worden uitgevoerd. |
| User | No | Referentie naar de gebruiker in de tenant. De gebruiker hoeft alleen worden opgegeven als het Operations element gebruikt wordt. |
| Properties | Choice | Eigenschappen Name, Description, Active en UserManagement om aan te passen op de gerefereerde tenant. |
| Operations | Choice | Operaties binnen de context van de gerefereerde tenant. Als het Operations element wordt gebruikt is het User element verplicht. Voor het uitvoeren de operaties zal een nieuwe taak worden gestart op de gerefereerde tenant met het account van de gespecificeerde gebruiker. |
De elementen Properties and Operations kunnen in combinatie met elkaar gebruikt worden.
Properties
The element Properties updates the properties for the tenant. Only the properties that should be updated are specified.
| Eigenschap | Beschrijving |
|---|---|
| Name | Nieuwe naam voor de tenant |
| Description | Beschrijving voor de tenant |
| Active | Activeren (true) en deactiveren (false) van de tenant. |
| UserManagement | Lokaal gebruikersbeheer inschakelen met true en centraal gebruikersbeheer inschakelen met false |
The element Properties will not result in a task and are executed in the root tenant. The UserName element is not required when only the Properties element is used.
Example of the UpdateTenant operation that renames and activates the tenant:
<UpdateTenant>
<TenantName>MyTenantName</TenantName>
<Properties>
<Name>MyNewTenantName</Name>
<Active>Yes</Active>
</Properties>
</UpdateTenant>