Vcenter Namespaces ManagementServices AccessGrants CreateSpec

Vcenter Namespaces ManagementServices AccessGrants CreateSpec
Vcenter Namespaces ManagementServices AccessGrants CreateSpec

The Vcenter Namespaces ManagementServices AccessGrants CreateSpec schema specifies how to create an Access Grant.

This schema was added in vSphere API 9.1.0.0.

JSON Example
{
    "access_grant": "string",
    "description": "string",
    "managed_by": "string",
    "management_service": "string",
    "workload_selector": {
        "type": "string"
    },
    "enabled": false
}
string
access_grant
Required

Identifier of the Access Grant. The name has DNS Label restrictions as specified in RFC 1123. This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. The name of an Access Grant has to be unique within the namespace.

This property was added in vSphere API 9.1.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespaces.management_services.AccessGrant. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespaces.management_services.AccessGrant.

string
description
Optional

The description of the Access Grant.

This property was added in vSphere API 9.1.0.0.

If missing or null, no description will be available for the Access Grant.

string
managed_by
Optional

Information about the entity responsible for the lifecycle of this Access Grant record.

When set, the field implies that any change to update or delete the Access Grant by any principal other than the component referenced by the field may be reverted by the automation component managing it.

This property was added in vSphere API 9.1.0.0.

If missing or null, it implies the Access Grant is not created by automation.

string
management_service
Required

A reference to an existing Management Service.

This property was added in vSphere API 9.1.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.ManagementService. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.ManagementService.

workload_selector
Required

Selection of workloads to be granted access to the given management service.

This property was added in vSphere API 9.1.0.0.

boolean
enabled
Optional

Set to false to create an Access Grant in a disabled state. A disabled Access Grant deactivates access for the recipient workloads of the grant to the referenced Management Service. The field defaults to true, which means the Access Grant will be enabled on its creation.

This property was added in vSphere API 9.1.0.0.

If missing or null, will default to true. The Access Grant will be enabled on creation.