Azure Stack Hub での Java による API バージョンのプロファイルの使用

サービスの最新バージョンを使用するには、依存関係として latest プロファイルを使用します。

既存の com.azure.resourcemanager の依存関係を取得することで Azure Stack Hub のリソースをお使いのアプリの対象とし、バージョンを x.y.z から x.y.z-hybrid に変更することができます。 Azure Stack Hub をサポートするハイブリッド パッケージでは、バージョンの末尾に -hybrid サフィックス (1.0.0-hybrid など) を使用します。 これにより、そのバージョンに関連付けられているエンドポイントの静的コレクションが参照されます。

latest プロファイルを取得するには、既存の com.azure.resourcemanager 依存関係を取得し、バージョンを latest に変更します。 latest プロファイル Java パッケージにより、Azure での一貫したエクスペリエンスが実現します。 このパッケージは、Azure com.azure.resourcemanager と同じグループ ID を共有します。 成果物 ID と名前空間も、グローバル Azure と同じです。 これは、Azure アプリを Azure Stack Hub に移植する際に役立ちます。 ハイブリッド プロファイルの一部として Azure Stack Hub で使用されるエンドポイントの詳細については、「API プロファイルの概要」を参照してください。

このプロファイルは、Maven プロジェクトの pom.xml ファイルに依存関係として指定されます。 (.NET と同様に) ドロップダウン リストから適切なクラスを選択すると、プロファイルによってモジュールが自動的に読み込まれます。

開発環境を設定する

SDK を実行するための環境を準備するには、Eclipse や Visual Studio Code などの IDE を使用できますが、Git、Java SDK、Apache Maven がインストールされている必要があります。 開発環境を設定するための前提条件の詳細については、Azure SDK for Java の使用に関する記事を参照してください。

1. GIT をインストールします。 Git をインストールするための公式の手順については「はじめに - Git のインストール」を参照してください。

2. Java SDK をインストールし、JAVA_HOME 環境変数を Java Development Kit のバイナリの場所に設定します。 OpenJDK のダウンロード可能なインストール メディアの手順をご覧ください。 Java Developer Kit のバージョン 8 以降をインストールします。

3. Apache Maven をインストールします。 手順については、「Apache Maven プロジェクト」を参照してください。 Apache Maven は 3.0 以降をインストールします。

Java と API バージョンのプロファイル

すべてのサービスの最新バージョンを使用するには、依存関係として latest プロファイルを使用します。

• latest プロファイルを使用する場合、依存関係は com.microsoft.azure です。

• Azure Stack Hub でサポートされている最新のサービスを使用するには、com.microsoft.azure.profile_2019_03_01_hybrid プロファイルを使用します。

  • このプロファイルは、Pom.xml ファイルに依存関係として指定されます。これにより、.NET と同様に、ドロップダウン リストから適切なクラスを選択すると、モジュールが自動的に読み込まれます。

• 依存関係は次のようになります。

  <dependency>
  <groupId>com.microsoft.azure.profile_2019_03_01_hybrid</groupId>
  <artifactId>azure</artifactId>
  <version>1.0.0-beta-1</version>
  </dependency>
  

• 特定のリソース プロバイダーのリソースの種類に合わせて特定の API バージョンを使用するには、Intellisense を使用して定義した特定の API バージョンを使用します。

すべてのオプションを同じアプリ内で組み合わせることができます。

Azure Java SDK のインストール

次の手順に従って、Java SDK をインストールします。

1. 正式な指示に従って、Git をインストールします。 「はじめに - Git のインストール」を参照してください。

2. 指示に従って、Java SDK と Maven をインストールします。 適切なバージョンは、Java Developer Kit のバージョン 8 です。 Apache Maven の適切なバージョンは 3.0 以降です。 このクイック スタートを完了するには、JAVA_HOME 環境変数を Java Development Kit のインストール場所に設定する必要があります。 詳細については、「Java と Maven を使用して初めての関数を作成する」を参照してください。

3. 適切な依存関係パッケージをインストールするには、Java アプリで Pom.xml ファイルを開きます。 次のコードに示されているように、依存関係を追加します。

   <dependency>
   <groupId>com.microsoft.azure.profile_2019_03_01_hybrid</groupId>
   <artifactId>azure</artifactId>
   <version>1.0.0-beta-1</version>
   </dependency>
   

4. インストールする必要があるパッケージのセットは、使用したいプロファイル バージョンによって異なります。 プロファイル バージョンのパッケージ名は次のとおりです。

   • com.microsoft.azure.profile_2019_03_01_hybrid
   • com.microsoft.azure
     • latest

Azure Stack Hub の CA ルート証明書を信頼する

Azure Stack Development Kit (ASDK) を使用する場合は、リモート マシン上で CA ルート証明書を信頼する必要があります。 Azure Stack Hub 統合システムで CA ルート証明書を信頼する必要はありません。

Windows

1. Azure Stack Hub の自己署名証明書を自分のデスクトップにエクスポートします。

2. コマンド プロンプトでディレクトリを %JAVA_HOME%\bin に変更します。

3. 次のコマンドを実行します。

   .\keytool.exe -importcert -noprompt -file <location of the exported certificate here> -alias root -keystore %JAVA_HOME%\lib\security\cacerts -trustcacerts -storepass changeit
   

既存の API プロファイル

• com.microsoft.azure.profile_2019_03_01_hybrid: Azure Stack Hub 用に作成された最新のプロファイル。 1904 以降を使用している限り、Azure Stack Hub との互換性に優れたサービスには、このプロファイルを使用します。

• com.microsoft.azure.profile_2018_03_01_hybrid: Azure Stack Hub 用に作成されたプロファイル。 バージョン 1808 以降を使用する Azure Stack Hub と互換性のあるサービスには、このプロファイルを使用します。

• com.microsoft.azure:すべてのサービスの最新バージョンで構成されているプロンプトファイル。 すべてのサービスの最新バージョンを使用してください。

Azure Stack Hub および API プロファイルについて詳しくは、「API プロファイルの概要」をご覧ください。

Azure Java SDK API プロファイルの使用

次のコードでは、Azure Stack Hub でサービス プリンシパルを認証します。 これにより、テナント ID と、Azure Stack Hub に固有の認証基準を使用して、トークンが作成されます。

AzureTokenCredentials credentials = new ApplicationTokenCredentials(client, tenant, key, AZURE_STACK)
                    .withDefaultSubscriptionID(subscriptionID);
Azure azureStack = Azure.configure()
                    .withLogLevel(com.microsoft.rest.LogLevel.BASIC)
                    .authenticate(credentials, credentials.defaultSubscriptionID());

このコードにより、API プロファイルの依存関係を使用して、アプリを Azure Stack Hub に正常にデプロイすることができます。

Azure Stack Hub 環境設定関数の定義

適切なエンドポイントで Azure Stack Hub クラウドを登録するには、次のコードを使用します。

// Get Azure Stack Hub cloud endpoints
final HashMap<String, String> settings = getActiveDirectorySettings(armEndpoint);

AzureEnvironment AZURE_STACK = new AzureEnvironment(new HashMap<String, String>() {
                {
                    put("managementEndpointUrl", settings.get("audience"));
                    put("resourceManagerEndpointUrl", armEndpoint);
                    put("galleryEndpointUrl", settings.get("galleryEndpoint"));
                    put("activeDirectoryEndpointUrl", settings.get("login_endpoint"));
                    put("activeDirectoryResourceID", settings.get("audience"));
                    put("activeDirectoryGraphResourceID", settings.get("graphEndpoint"));
                    put("storageEndpointSuffix", armEndpoint.substring(armEndpoint.indexOf('.')));
                    put("keyVaultDnsSuffix", ".vault" + armEndpoint.substring(armEndpoint.indexOf('.')));
                }
            });

前のコードの getActiveDirectorySettings 呼び出しは、メタデータ エンドポイントからエンドポイントを取得します。 これは、この呼び出しからの環境変数を示しています。

public static HashMap<String, String> getActiveDirectorySettings(String armEndpoint) {

    HashMap<String, String> adSettings = new HashMap<String, String>();
    try {

        // create HTTP Client
        HttpClient httpClient = HttpClientBuilder.create().build();

        // Create new getRequest with below mentioned URL
        HttpGet getRequest = new HttpGet(String.format("%s/metadata/endpoints?api-version=1.0",
                             armEndpoint));

        // Add additional header to getRequest which accepts application/xml data
        getRequest.addHeader("accept", "application/xml");

        // Execute request and catch response
        HttpResponse response = httpClient.execute(getRequest);

        // Check for HTTP response code: 200 = success
        if (response.getStatusLine().getStatusCode() != 200) {
            throw new RuntimeException("Failed : HTTP error code : " + response.getStatusLine().getStatusCode());
        }

        String responseStr = EntityUtils.toString(response.getEntity());
        JSONObject responseJson = new JSONObject(responseStr);
        adSettings.put("galleryEndpoint", responseJson.getString("galleryEndpoint"));
        JSONObject authentication = (JSONObject) responseJson.get("authentication");
        String audience = authentication.get("audiences").toString().split("\"")[1];
        adSettings.put("login_endpoint", authentication.getString("loginEndpoint"));
        adSettings.put("audience", audience);
        adSettings.put("graphEndpoint", responseJson.getString("graphEndpoint"));

    } catch (ClientProtocolException cpe) {
        cpe.printStackTrace();
        throw new RuntimeException(cpe);
    } catch (IOException ioe) {
        ioe.printStackTrace();
        throw new RuntimeException(ioe);
    }
    return adSettings;
}

単体テスト プロジェクトのサンプル

1. 次のコマンドを使用して、リポジトリを複製します。

   git clone https://github.com/Azure-Samples/Hybrid-Java-Samples.git -b resourcegroup-2019-03-01-hybrid
   

2. Azure サービス プリンシパルを作成し、サブスクリプションにアクセスするロールを割り当てます。 サービス プリンシパルの作成方法については、「Azure PowerShell を使用して資格情報でのサービス プリンシパルを作成する」をご覧ください。

3. 次の必要な環境変数を取得します。

   • AZURE_TENANT_ID
   • AZURE_CLIENT_ID
   • AZURE_CLIENT_SECRET
   • AZURE_SUBSCRIPTION_ID
   • ARM_ENDPOINT
   • RESOURCE_LOCATION

4. コマンド プロンプトを使用して作成したサービス プリンシパルから取得した情報を使用して、次の環境変数を設定します。

   • export AZURE_TENANT_ID={your tenant ID}
   • export AZURE_CLIENT_ID={your client ID}
   • export AZURE_CLIENT_SECRET={your client secret}
   • export AZURE_SUBSCRIPTION_ID={your subscription ID}
   • export ARM_ENDPOINT={your Azure Stack Hub Resource Manager URL}
   • export RESOURCE_LOCATION={location of Azure Stack Hub}

   Windows では、export ではなく set を使用します。

5. Azure Resource Manager のメタデータ エンドポイントを取得するには、getActiveDirectorySettings の関数を使用します。

   // Get Azure Stack Hub cloud endpoints
   final HashMap<String, String> settings = getActiveDirectorySettings(armEndpoint);
   

6. Pom.xml ファイルで、Azure Stack Hub 用の 2019-03-01-hybrid プロファイルを使用するために次の依存関係を追加します。 この依存関係では、Compute、Networking、Storage、Key Vault、App Services のリソース プロバイダー用の、このプロファイルに関連付けられているモジュールがインストールされます。

   <dependency>
     <groupId>com.microsoft.azure.profile_2019_03_01_hybrid</groupId>
     <artifactId>azure</artifactId>
     <version>1.0.0-beta-1</version>
   </dependency>
   

7. 環境変数を設定するために開いていたコマンド プロンプトで、次のコマンドを入力します。

   mvn clean compile exec:java
   

Azure Stack バージョン 2008 またはプロファイル 2019-03-01 以前に適用できるサンプルについては、こちらを参照してください。