通过

DSC 资源完全限定的类型名称架构参考

摘要

标识 DSC 资源。

元数据

SchemaDialect: https://json-schema.org/draft/2020-12/schema
SchemaID:      https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/definitions/resourceType.json
Type:          string
Pattern:       ^\w+(\.\w+){0,2}\/\w+$

描述

DSC 资源由其完全限定的类型名称标识。 此类型的值用于在配置文档中指定资源，并在使用 dsc resource * 命令时指定标志的值--resource。

资源的完全限定类型名称使用以下语法：

`<owner>[.<group>][.<area>]/<name>`

每个段必须是字母数字字符和下划线的字符串。 不允许使用其他字符。 每个资源都必须定义 owner 和 name。 group使用 和 area 组件将资源组织到相关的命名空间中。 例如：

  • Microsoft.SqlServer/Database
  • Microsoft.SqlServer.Database/Role
  • Microsoft.SqlServer.Database/User
  • Microsoft.SqlServer/Endpoint
  • Microsoft.SqlServer.Endpoint/Permission
  • Microsoft.SqlServer/Login
  • Microsoft.SqlServer/MaxDop

键入名称段

所有者

类型名称的所有者段是必需的。 它标识拥有、开发和维护资源的个人或组织。

组

类型名称的组段是可选的。 它定义资源集合的逻辑分组。 例如，管理SQL Server的资源可能会在其类型名称中使用SqlServer组。

区域

类型名称的区域段是可选的。 它按用途或更高级别组件定义资源集合的分组。 例如，管理SQL Server数据库的组件的资源可能会Database在其类型名称中使用 区域。

名称

类型名称的名称段是必需的。 它标识资源管理的组件。 此段应为单数名词，除非资源始终管理单个资源实例中的组件列表。 在这种情况下，资源名称应是它所管理的名词的复数形式或名词的单数形式，后跟单词 List，例如 JeaRoleCapabilities 或 JeaRoleCapabilityList。