az aks draft

Note

このリファレンスは、Azure CLI (バージョン 2.73.0 以降) の aks-preview 拡張機能の一部です。 az aks draft コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

プロジェクト ディレクトリに配置ファイルをビルドし、AKS クラスターにデプロイするためのコマンド。

コマンド

名前 説明 型 状態
az aks draft create

Dockerfile と、プロジェクト ディレクトリに必要な最小限の Kubernetes デプロイ ファイル (helm、kustomize、マニフェスト) を生成します。

 Extension GA
az aks draft generate-workflow

自動ビルドと AKS へのデプロイのためのGitHub ワークフローを生成します。

 Extension GA
az aks draft setup-gh

アプリケーションGitHub OIDC を設定します。

 Extension GA
az aks draft up

az aks draft setup-gh実行してからaz aks draft generate-workflowします。

 Extension GA
az aks draft update

インターネットにアクセスできるようにアプリケーションを更新します。

 Extension GA

az aks draft create

Dockerfile と、プロジェクト ディレクトリに必要な最小限の Kubernetes デプロイ ファイル (helm、kustomize、マニフェスト) を生成します。

az aks draft create [--acquire-policy-token]
                    [--app]
                    [--change-reference]
                    [--create-config]
                    [--deployment-only]
                    [--destination]
                    [--dockerfile-only]
                    [--language]
                    [--path]

例

現在のディレクトリに Dockerfile ファイルとデプロイ ファイルを生成するように求めるメッセージが表示されます。

az aks draft create

現在のディレクトリに Dockerfile のみを生成します。

az aks draft create --dockerfile-only=true

現在のディレクトリ内のデプロイ ファイルのみを生成します。

az aks draft create --deployment-only=true

特定のプロジェクト ディレクトリにあるアプリ名を使用して、Java プロジェクトに Dockerfile とデプロイ ファイルを生成します。

az aks draft create --language=java --app=some_app --destination=/projects/some_project

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--app

Helm リリースの名前を指定します。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--create-config

構成ファイルへのパスを指定します。

--deployment-only

Kubernetes デプロイの配置ファイル (helm、kustomize、マニフェスト) のみを生成します。

--destination

プロジェクト ディレクトリへのパスを指定します (既定値は .)。

プロパティ 値
規定値: .
--dockerfile-only

Kubernetes デプロイに対してのみ Dockerfile を生成します。

--language

Kubernetes デプロイの作成に使用する言語を指定します。

--path

指定した場所にある Draft バイナリを自動的にダウンロードして使用します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az aks draft generate-workflow

自動ビルドと AKS へのデプロイのためのGitHub ワークフローを生成します。

このコマンドを実行する前に、アプリケーションGitHub OIDC を設定していることを確認します。 また、Azureにリソース グループ、コンテナー レジストリ、Kubernetes クラスターを作成し、az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name> を使用して 3 つのリソースをリンクする必要があります。

az aks draft generate-workflow [--acquire-policy-token]
                               [--branch]
                               [--change-reference]
                               [--cluster-name]
                               [--container-name]
                               [--destination]
                               [--path]
                               [--registry-name]
                               [--resource-group]

例

現在のディレクトリにGitHub ワークフローを生成するように求めるメッセージが表示されます。

az aks draft generate-workflow

特定のプロジェクト ディレクトリにGitHub ワークフローを生成するように求めるメッセージが表示されます。

az aks draft generate-workflow --destination=/projects/some_project

リソース グループ、AKS クラスター名、特定のプロジェクト ディレクトリ内のコンテナー レジストリ名を含むGitHub ワークフローを生成します。

az aks draft generate-workflow --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --destination=/projects/some_project

リソース グループ、AKS クラスター名、コンテナー レジストリ名、および特定のプロジェクト ディレクトリ内のコンテナー イメージ名を使用してメイン ブランチからデプロイするGitHub ワークフローを生成します。

az aks draft generate-workflow --branch=main --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --container-name=some_image --destination=/projects/some_project

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--branch

自動的にデプロイするGitHub ブランチを指定します。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--cluster-name

AKS クラスター名を指定します。

--container-name

コンテナー イメージの名前を指定します。

--destination

プロジェクト ディレクトリへのパスを指定します (既定値は .)。

--path

指定した場所にある Draft バイナリを自動的にダウンロードして使用します。

--registry-name

プロジェクト ディレクトリへのパスを指定します。

--resource-group

Azure リソース グループの名前を指定します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az aks draft setup-gh

アプリケーションGitHub OIDC を設定します。

az aks draft setup-gh [--acquire-policy-token]
                      [--app]
                      [--change-reference]
                      [--gh-repo]
                      [--path]
                      [--provider]
                      [--resource-group]
                      [--subscription-id]

例

リポジトリのGitHub OIDC をセットアップするように求めるメッセージが表示されます。

az aks draft setup-gh

特定のリポジトリのAzureにGitHub OIDC をセットアップします。

az aks draft setup-gh --provider=azure --gh-repo=some_organization/some_repo

サブスクリプション ID とリソース グループを使用して、AzureにGitHub OIDC を設定します。

az aks draft setup-gh --provider=azure --subscription-id=some_subscription --resource-group=some_rg

特定のリポジトリのサブスクリプション ID とリソース グループを使用して、Azureにアプリケーション名を使用して GitHub OIDC をセットアップします。

az aks draft setup-gh --app=some_app --provider=azure --subscription-id=some_subscription --resource-group=some_rg --gh-repo=some_organization/some_repo

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--app

Azure Active Directoryアプリケーション名を指定します。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--gh-repo

GitHub リポジトリ (組織/repo_name) を指定します。

--path

指定した場所にある Draft バイナリを自動的にダウンロードして使用します。

--provider

クラウド プロバイダーを指定します (既定値は azure)。

プロパティ 値
規定値: azure
--resource-group

Azure リソース グループの名前を指定します。

--subscription-id

Azure サブスクリプション ID を指定します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az aks draft up

az aks draft setup-gh実行してからaz aks draft generate-workflowします。

このコマンドは、az aks draft setup-gh と az aks draft generate-workflow を組み合わせて、GITHUB OIDC を設定し、AKS に自動ビルドしてデプロイするためのGitHub ワークフローを生成します。 このコマンドを実行する前に、Azureにリソース グループ、コンテナー レジストリ、Kubernetes クラスターを作成し、az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name> を使用して 3 つのリソースをリンクします。

az aks draft up [--acquire-policy-token]
                [--app]
                [--branch]
                [--change-reference]
                [--cluster-name]
                [--container-name]
                [--destination]
                [--gh-repo]
                [--path]
                [--provider]
                [--registry-name]
                [--resource-group]
                [--subscription-id]

例

GitHub OIDC をセットアップするように求めるメッセージが表示され、現在のディレクトリにGitHubワークフローが生成されます。

az aks draft up

GitHub OIDC をセットアップするように求められた後、特定のプロジェクト ディレクトリにGitHub ワークフローを生成します。

az aks draft up --destination=/projects/some_project

特定のリポジトリに対してGitHub OIDC をセットアップし、特定のプロジェクト ディレクトリにGitHub ワークフローを生成するように求めるメッセージが表示されます。

az aks draft up --gh-repo=some_organization/some_repo --destination=/projects/some_project

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--app

アプリケーションの名前を指定します。

--branch

自動的にデプロイするGitHub ブランチを指定します。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--cluster-name

AKS クラスター名を指定します。

--container-name

コンテナー イメージの名前を指定します。

--destination

プロジェクト ディレクトリへのパスを指定します (既定値は .)。

--gh-repo

GitHub リポジトリ (組織/repo_name) を指定します。

--path

指定した場所にある Draft バイナリを自動的にダウンロードして使用します。

--provider

クラウド プロバイダーを指定します (既定値は azure)。

プロパティ 値
規定値: azure
--registry-name

プロジェクト ディレクトリへのパスを指定します。

--resource-group

Azure リソース グループの名前を指定します。

--subscription-id

Azure サブスクリプション ID を指定します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az aks draft update

インターネットにアクセスできるようにアプリケーションを更新します。

このコマンドは、アプリケーションが外部要求を受信できるように、必要に応じて yaml ファイルを自動的に更新します。

az aks draft update [--acquire-policy-token]
                    [--certificate]
                    [--change-reference]
                    [--destination]
                    [--host]
                    [--path]

例

インターネットにアクセスできるようにアプリケーションを更新するように求めるメッセージが表示されます。

az aks draft update

特定のプロジェクト ディレクトリでインターネットにアクセスできるようにアプリケーションを更新するように求めるメッセージが表示されます。

az aks draft update --destination=/projects/some_project

イングレス リソースのホストと、特定のプロジェクト ディレクトリ内の Keyvault 証明書を使用して、インターネットにアクセスできるようにアプリケーションを更新します。

az aks draft update --host=some_host --certificate=some_certificate --destination=/projects/some_project

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--certificate

提示する Keyvault 証明書の URI を指定します。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--destination

プロジェクト ディレクトリへのパスを指定します (既定値は .)。

--host

イングレス リソースのホストを指定します。

--path

指定した場所にある Draft バイナリを自動的にダウンロードして使用します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False