Skip to content

Commit 4d27190

Browse files
(GH-642) Update schema URIs to aka.ms and v3
This change updates the schema URIs in the various resource manifests, configuration documents, and tests to use the new schema URIs: - `https://aka.ms/dsc/schemas/v3/bundled/config/document.json` for configuration documents. - `https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json` for resource manifests. This change pins the changes to the major version to reduce how often these files need to be updated with future releases. It uses the `aka.ms` prefix instead of the GitHub URI prefix for readability and because we expect the majority of users to prefer the shorter URI. With this change in place, tests broken in the previous commit should pass again.
1 parent 498eb6a commit 4d27190

File tree

79 files changed

+145
-144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+145
-144
lines changed

.github/ISSUE_TEMPLATE/Bug_Report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ body:
3535
3636
```yaml
3737
# repro.dsc.config.yaml
38-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
38+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
3939
resources:
4040
- name: repro
4141
type: Test/Echo

.vscode/docs.code-snippets

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"",
4343
"```yaml",
4444
"# ${1:name}.example.1.dsc.config.yaml",
45-
"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
45+
"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
4646
"resources:",
4747
"- name: ${7:descriptive resource name}",
4848
" type: Test/Echo",
@@ -101,7 +101,7 @@
101101
"",
102102
"```yaml",
103103
"# $TM_FILENAME_BASE.example.$1.dsc.config.yaml",
104-
"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
104+
"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
105105
"resources:",
106106
"- name: ${4:descriptive resource name}",
107107
" type: Test/Echo",

archive/registry/registry.dsc.resource.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/resource/manifest.json",
2+
"$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
33
"type": "Microsoft.Windows/Registry",
44
"description": "Manage Windows Registry keys and values",
55
"tags": [

configurations/windows/windows_baseline.dsc.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# This configuration validates a Windows system against a security baseline configuration
2-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
2+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
33
metadata:
44
Microsoft.DSC:
55
securityContext: elevated
66
resources:
77
- name: Validate the OS is Windows
88
type: Microsoft.DSC/Assertion
99
properties:
10-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
10+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
1111
resources:
1212
- name: os
1313
type: Microsoft/OSInfo
@@ -18,7 +18,7 @@ resources:
1818
dependsOn:
1919
- "[resourceId('Microsoft.DSC/Assertion','Validate the OS is Windows')]"
2020
properties:
21-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
21+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
2222
resources:
2323
- name: Default RDP port
2424
type: Microsoft.Windows/Registry

configurations/windows/windows_inventory.dsc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
1+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
22
resources:
33
- name: Validate the OS is Windows
44
type: Microsoft.DSC/Assertion
55
properties:
6-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
6+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
77
resources:
88
- name: os
99
type: Microsoft/OSInfo

dsc/assertion.dsc.resource.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/resource/manifest.json",
2+
"$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
33
"type": "Microsoft.DSC/Assertion",
44
"version": "0.1.0",
55
"description": "`test` will be invoked for all resources in the supplied configuration.",

dsc/examples/assertion.dsc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Example configuration that uses assertions to validate the environment before running the configuration.
2-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
2+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
33
resources:
44
- name: current user registry
55
type: Microsoft.Windows/Registry
@@ -11,7 +11,7 @@ resources:
1111
- name: my assertions
1212
type: Microsoft.DSC/Assertion
1313
properties:
14-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
14+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
1515
resources:
1616
- name: os
1717
type: Microsoft/OSInfo

dsc/examples/brew.dsc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Example to see if PowerShell 7 is installed, install it, or get all installed packages
2-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
2+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
33
resources:
44
- name: assertions
55
type: Microsoft.DSC/Assertion
66
properties:
7-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
7+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
88
resources:
99
- name: os_check
1010
type: Microsoft/OSInfo

dsc/examples/brew_export.dsc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Example to see if PowerShell 7 is installed, install it, or get all installed packages
2-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
2+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
33
resources:
44
- name: brew
55
type: DSC.PackageManagement/Brew

dsc/examples/brew_uninstall.dsc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Example to see if PowerShell 7 is installed, install it, or get all installed packages
2-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
2+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
33
resources:
44
- name: assertions
55
type: Microsoft.DSC/Assertion
66
properties:
7-
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
7+
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
88
resources:
99
- name: os_check
1010
type: Microsoft/OSInfo

0 commit comments

Comments
 (0)