AzureDevOpsDscNative.AzDoGitRepository.dsc.adaptedResource.json

{
  "$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json",
  "type": "AzureDevOpsDscNative/AzDoGitRepository",
  "kind": "resource",
  "version": "1.2.0",
  "capabilities": [
    "set",
    "test",
    "get",
    "export"
  ],
  "description": "This class represents an Azure DevOps Git repository.",
  "author": "ZanattaMichael",
  "requireAdapter": "Microsoft.Adapter/PowerShell",
  "path": "AzureDevOpsDscNative.psd1",
  "schema": {
    "embedded": {
      "description": "This class represents an Azure DevOps Git repository.",
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "additionalProperties": false,
      "properties": {
        "Ensure": {
          "type": "string",
          "enum": [
            "Present",
            "Absent"
          ],
          "title": "Ensure",
          "description": "The Ensure property."
        },
        "LookupResult": {
          "type": "object",
          "title": "LookupResult",
          "readOnly": true,
          "description": "The LookupResult property."
        },
        "ProjectName": {
          "type": "string",
          "title": "ProjectName",
          "description": "The name of the Azure DevOps project where the Git repository is located."
        },
        "RepositoryName": {
          "type": "string",
          "title": "RepositoryName",
          "description": "The name of the Git repository. This is the key property for the resource."
        },
        "SourceRepository": {
          "type": "string",
          "title": "SourceRepository",
          "description": "Optional. Seeds the repository at creation time. Its meaning depends on 'SourceType': a Git URL (for example 'https://github.com/MyUser/MyRepository.git') for an import, or 'Project/Repo' (or just 'Repo' for a repository in the same project) for a fork. When omitted, an empty repository is created. Ignored on an existing repository - never re-applied by Set()."
        },
        "SourceType": {
          "type": "string",
          "enum": [
            "",
            "Import",
            "Fork"
          ],
          "title": "SourceType",
          "description": "Optional. Selects how 'SourceRepository' is used: 'Import' requests an import from an external Git URL, 'Fork' creates the repository as a fork of an existing Azure DevOps repository. When omitted and 'SourceRepository' is set, it defaults to 'Import' if the value looks like a URL (or an SSH remote, e.g. 'git@host:owner/repo.git'), and to 'Fork' otherwise."
        },
        "ImportServiceConnectionName": {
          "type": "string",
          "title": "ImportServiceConnectionName",
          "description": "Optional. The name of a generic Git service connection (in the same project) that holds the credentials needed to import from a private 'SourceRepository' URL. Only used when 'SourceType' is 'Import'. Omit it for a public source."
        },
        "IsDisabled": {
          "type": "boolean",
          "title": "IsDisabled",
          "description": "Optional. Disables or enables the repository. Unlike the source properties above, this is a plain repository property the API can update at any time, so it is compared and enforced on every Test()/Set() - not just at creation. Defaults to $false."
        }
      },
      "type": "object",
      "required": [
        "ProjectName",
        "RepositoryName"
      ],
      "title": "AzureDevOpsDscNative/AzDoGitRepository"
    }
  }
}