Skip to content

azdo_service-endpoint_create_github.md

Latest commit

 

History

History
82 lines (43 loc) · 2.23 KB

azdo_service-endpoint_create_github.md

File metadata and controls

82 lines (43 loc) · 2.23 KB

Command azdo service-endpoint create github

azdo service-endpoint create github [ORGANIZATION/]PROJECT --name NAME [--url URL] [--token TOKEN] [flags]

Create a GitHub service endpoint using a personal access token (PAT) or an installation/oauth configuration.

Options

  • --configuration-id string

    Configuration for connecting to the endpoint (use an OAuth/installation configuration). Mutually exclusive with --token.

  • --description string

    Description for the service endpoint

  • --grant-permission-to-all-pipelines

    Grant access permission to all pipelines to use the service connection

  • -q, --jq expression

    Filter JSON output using a jq expression

  • --json fields

    Output JSON with the specified fields. Prefix a field with '-' to exclude it.

  • --name string

    Name of the service endpoint

  • -t, --template string

    Format JSON output using a Go template; see "azdo help formatting"

  • --timeout duration (default "2m0s")

    Maximum time to wait when --wait or --validate-connection is enabled

  • --token string

    Visit https://github.com/settings/tokens to create personal access tokens. Recommended scopes: repo, user, admin:repo_hook. If omitted, you will be prompted for a token when interactive.

  • --url string

    GitHub URL (defaults to https://github.com)

  • --validate-connection

    Run TestConnection after creation (opt-in)

  • --validate-schema

    Validate auth scheme/params against endpoint type metadata (opt-in)

  • --wait

    Wait until the endpoint reports ready/failed

JSON Fields

administratorsGroup, authorization, createdBy, data, description, groupScopeId, id, isReady, isShared, name, operationStatus, owner, readersGroup, serviceEndpointProjectReferences, type, url

Examples

# Create a GitHub service endpoint with a personal access token (PAT)
azdo service-endpoint create github my-org/my-project --name "gh-ep" --token <PAT>

# Create a GitHub service endpoint with an installation / OAuth configuration id
azdo service-endpoint create github my-org/my-project --name "gh-ep" --configuration-id <CONFIG_ID>

See also