Resource Type: dsc_cgithubapicontent

Defined in:

lib/puppet/type/dsc_cgithubapicontent.rb

Overview

The DSC cGitHubApiContent resource type. Automatically generated from version 3.7.8.4

Properties

• dsc_allowredirect

  Specify if you want to control Redirect. Default is true as Github requires. refer : developer.github.com/v3/#http-redirects

• dsc_branch

  Specify Branch name for the content. Default is master. refer : developer.github.com/v3/repos/contents/

• dsc_cachelocation

  Specify CacheLocation to hold your last configuration result.

• dsc_contentpath

  Path to the content. If README.md under root, then just README.md. Make sure path is case-sensitive. refer : developer.github.com/v3/repos/contents/

• dsc_contenttype

  Select Media Type to access GitHub API Default is application/json. You need change for each content type. refer : developer.github.com/v3/media/

• dsc_ensure

  Describe File is exist on DestinationPath or not.

• dsc_header

  Specify Headers for Web Request. if you need any ‘if’ or other header control. refer : developer.github.com/v3/

• dsc_repository

  GitHub Repository name to access. refer : developer.github.com/v3/repos/contents/

• dsc_repositoryowner

  GitHub Repository Owner Name which content owns. refer : developer.github.com/v3/repos/contents/

• dsc_useragent

  Specify User-Agent for Web Request. Default is powerShell user-agent default. refer : developer.github.com/v3/#user-agent-required

Parameters

• dsc_destinationpath (namevar)

  File Path to output Donwloaded item.

• dsc_oauth2token

  OAuth2 access token for GitHub Api Authorization. UserName value will not been in use. refer : developer.github.com/v3/#authentication

• dsc_psdscrunascredential
• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).