SqlServerDsc.SqlPermission.dsc.adaptedResource.json
|
{
"$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json", "type": "SqlServerDsc/SqlPermission", "kind": "resource", "version": "17.6.0", "capabilities": [ "get", "test", "set" ], "description": "The `SqlPermission` DSC resource is used to grant, deny or revoke server permissions for a login or server role.", "author": "DSC Community", "requireAdapter": "Microsoft.Adapter/PowerShell", "path": "SqlServerDsc.psd1", "schema": { "embedded": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "InstanceName": { "type": "string", "title": "InstanceName", "description": "The InstanceName property." }, "ServerName": { "type": "string", "title": "ServerName", "description": "The ServerName property." }, "Credential": { "type": "string", "title": "Credential", "description": "The Credential property." }, "Protocol": { "type": "string", "enum": [ "tcp", "np", "lpc" ], "title": "Protocol", "description": "The Protocol property." }, "Port": { "type": "string", "title": "Port", "description": "The Port property." }, "Reasons": { "items": { "type": "string" }, "type": "array", "title": "Reasons", "readOnly": true, "description": "The Reasons property." }, "Name": { "type": "string", "title": "Name", "description": "The name of the principal (login or server role) that should be granted or denied the permission." }, "Permission": { "items": { "type": "string" }, "type": "array", "title": "Permission", "description": "An array of server permissions to enforce. Any permission that is not part of the desired state will be revoked. Must provide all permission states (`Grant`, `Deny`, `GrantWithGrant`) with at least an empty string array for the advanced type `ServerPermission`'s property `Permission`. Valid permission names can be found in the article [ServerPermissionSet Class properties](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.serverpermissionset#properties). This is an array of CIM instances of advanced type `ServerPermission` from the namespace `root/Microsoft/Windows/DesiredStateConfiguration`." }, "PermissionToInclude": { "items": { "type": "string" }, "type": "array", "title": "PermissionToInclude", "description": "An array of server permissions to include to the current state. The current state will not be affected unless the current state contradict the desired state. For example if the desired state specifies a deny permissions but in the current state that permission is granted, that permission will be changed to be denied. Valid permission names can be found in the article [ServerPermissionSet Class properties](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.serverpermissionset#properties). This is an array of CIM instances of advanced type `ServerPermission` from the namespace `root/Microsoft/Windows/DesiredStateConfiguration`." }, "PermissionToExclude": { "items": { "type": "string" }, "type": "array", "title": "PermissionToExclude", "description": "An array of server permissions to exclude (revoke) from the current state. Valid permission names can be found in the article [ServerPermissionSet Class properties](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.serverpermissionset#properties). This is an array of CIM instances of advanced type `ServerPermission` from the namespace `root/Microsoft/Windows/DesiredStateConfiguration`." } }, "description": "The `SqlPermission` DSC resource is used to grant, deny or revoke server permissions for a login or server role.", "additionalProperties": false, "required": [ "InstanceName", "Name" ], "title": "SqlServerDsc/SqlPermission", "type": "object" } } } |