Settings API - Management zones settings schema table
Management zones settings (builtin:management-zones)
Management zones enable defining fine grained access rights to parts of an environment. A Management zone consists of a set of entities like applications, hosts, process groups, or services.
For each Management zone you can define which user groups have access to them. This way you can ensure the confidentiality of certain parts of an environment and still keep an end to end view across all components for the users that need it.
For value suggestions based on entity data and preview functionality, environment-wide "Access environment" permission is required.
Management zone rules are executed periodically in the background, for a limited timeframe. Any entity that matches a management zone rule will receive the specific zone assigned to it, while removing zones from entities that no longer match. Be aware that for any condition that requires the relationship between multiple entities, all entities in this scope need to be present in this timeframe!
Depending on environment-size, rule count (Management zones, as well as tagging and naming rules) and rule complexity, the application of all management zones might be delayed!
Schema ID | Schema groups | Scope |
---|---|---|
builtin:management-zones |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:management-zones |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:management-zones | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:management-zones |
Authentication
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Property | Type | Description | Required |
---|---|---|---|
Management zone namename | text | Be careful when renaming - if there are policies that are referencing this Management zone, they will need to be adapted to the new name! | required |
Descriptiondescription | text | - | optional |
Rulesrules | Set<Rule> | - | required |
The Rule
object
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | - | required |
Rule typetype | enum |
| required |
attributeRule | ManagementZoneAttributeRule | - | required |
dimensionRule | DimensionRule | - | required |
Entity selectorentitySelector | text | The documentation of the entity selector can be found here. | required |
The ManagementZoneAttributeRule
object
Property | Type | Description | Required |
---|---|---|---|
Rule applies toentityType | enum |
| required |
Conditionsconditions | Set<AttributeCondition> | - | required |
Apply to underlying hosts of matching servicesserviceToHostPropagation | boolean | - | required |
Apply to underlying process groups of matching servicesserviceToPGPropagation | boolean | - | required |
Apply to underlying hosts of matching process groupspgToHostPropagation | boolean | - | required |
Apply to all services provided by the process groupspgToServicePropagation | boolean | - | required |
Apply to processes running on matching hostshostToPGPropagation | boolean | - | required |
Apply to custom devices in a custom device groupcustomDeviceGroupToCustomDevicePropagation | boolean | - | required |
Apply to services provided by matching Azure entitiesazureToServicePropagation | boolean | - | required |
Apply to process groups connected to matching Azure entitiesazureToPGPropagation | boolean | - | required |
The DimensionRule
object
Property | Type | Description | Required |
---|---|---|---|
TypeappliesTo | enum |
| required |
Conditionsconditions | Set<DimensionCondition> | - | required |
The AttributeCondition
object
Property | Type | Description | Required |
---|---|---|---|
Propertykey | enum |
| required |
Key sourcedynamicKeySource | text | - | required |
Dynamic keydynamicKey | text | - | required |
Operatoroperator | enum |
| required |
ValueenumValue | text | - | required |
ValuestringValue | text | - | required |
Case sensitivecaseSensitive | boolean | - | required |
ValueintegerValue | integer | - | required |
ValueentityId | text | - | required |
Tagtag | text | Format: | required |
The DimensionCondition
object
Property | Type | Description | Required |
---|---|---|---|
TypeconditionType | enum |
| required |
Keykey | text | - | required |
OperatorruleMatcher | enum |
| required |
Valuevalue | text | - | required |