Azure DevOps CLI の概要

  • [アーティクル]

Azure DevOps Services

Azure コマンド ライン インターフェイス (CLI) 用の Azure DevOps 拡張機能を使用すると、コマンド ラインから多くのAzure DevOps Servicesを管理できます。 CLI コマンドを使用すると、高速で柔軟な対話型キャンバスによりユーザー インターフェイス ワークフローがバイパスされ、タスクを効率化できます。

注意

Azure DevOps コマンド ライン インターフェイス (CLI) は、Azure DevOps Servicesでのみ使用できます。 Azure CLI 用の Azure DevOps 拡張機能では、Azure DevOps Serverのどのバージョンもサポートされていません。

Azure CLI で Azure DevOps 拡張機能の使用を開始するには、次のステップを実行します。

  1. Azure CLI をインストールします: 「Azure CLI のインストール」に記載されている手順に従って、Azure CLI 環境をセットアップします。 Azure CLI のバージョンは、少なくとも 2.10.1 以降である必要があります。 検証するには、az --version を使用します。

  2. Azure DevOps 拡張機能を追加します:

     az extension add --name azure-devops

    az extension list または az extension show --name azure-devops を使用して、インストールを確認できます。

  3. サインインします: az login を実行してサインインします。 サポートされているのは、対話型、または az login によるユーザー名とパスワードを使用したログインのみです。 個人用アクセス トークン (PAT) を使用してサインインするには、Azure DevOps 個人用アクセス トークン (PAT) を使用したサインインに関する記事を参照してください。

  4. 既定値を構成します: 組織およびプロジェクトの既定の構成を設定することをお勧めします。 それ以外の場合は、個々のコマンド内でこれらの設定を行うことができます。

     az devops configure --defaults organization=https://dev.azure.com/contoso project=ContosoWebApp

コマンドの使用方法

Azure DevOps 拡張機能を追加すると、devops、pipelines、artifacts、boards、および repos のグループが追加されます。 任意のコマンドの使用方法とヘルプ コンテンツを参照するには、 -h パラメーターを入力します。次に例を示します。

az devops -h

Group
    az devops : Manage Azure DevOps organization level operations.
        Related Groups
        az pipelines: Manage Azure Pipelines
        az boards: Manage Azure Boards
        az repos: Manage Azure Repos
        az artifacts: Manage Azure Artifacts.
   
Subgroups:
    admin            : Manage administration operations.
    extension        : Manage extensions.
    project          : Manage team projects.
    security         : Manage security related operations.
    service-endpoint : Manage service endpoints/service connections.
    team             : Manage teams.
    user             : Manage users.
    wiki             : Manage wikis.

Commands:
    configure        : Configure the Azure DevOps CLI or view your configuration.
    feedback         : Displays information on how to provide feedback to the Azure DevOps CLI team.
    invoke           : This command will invoke request for any DevOps area and resource. Please use
                       only json output as the response of this command is not fixed. Helpful docs -
                       https://learn.microsoft.com/rest/api/azure/devops/.
    login            : Set the credential (PAT) to use for a particular organization.
    logout           : Clear the credential for all or a particular organization.

ブラウザーで項目を開く

--open スイッチを使用すると、既定のブラウザーで Azure DevOps ポータルの任意の成果物を開くことができます。

例:

az pipelines build show --id 1 --open

このコマンドでは、id 1 でのビルドの詳細がコマンド ラインに表示され、それが既定のブラウザーでも開きます。