Bicep のMicrosoft Graphの指定方法が変更されます

皆さんこんにちは。ACS事業部 亀崎です。

今年の初夏にMicrosoft Graph Bicepが利用可能になったことをご紹介したのを覚えていますでしょうか。

techblog.ap-com.co.jp

まだExperimentalではありますが、2024年5月から利用可能になっていました。

当初は

provider microsoftGraph

@description('Application name, unique globally. Can not change after create it')
param appName string
@description('Applicaton displayname, default value is same as appName')
param displayName string = appName

resource app 'Microsoft.Graph/applications@v1.0' = {
  displayName: displayName
  uniqueName: appName
}

resource sp 'Microsoft.Graph/servicePrincipals@v1.0' = {
  appId: app.appId
}

と、 provider microsoftGraph という組み込み型を指定することで利用できました。 じつはこのあと providerの部分が extension という指定に変更され、 extension microsoftGraph と指定する方式になりました。

そしてこの度指定方法がさらに変更となります。

learn.microsoft.com

これまでは「組み込み型」で定義するものでしたが、それが「動的な型」に変更され、従来の「組み込み型」は2025年1月24日に廃止となります。

ということで今回は変更方法についてご紹介したいと思います。

Microsoft Graphの動的な型指定方法

変更するのは以下の2点です。

変更点１ bicepconfig.json へ指定追加

bicepconfig.jsonに'extension' 部の指定を追加します。

microsoftGraphV1_0の部分はMicrosoft アーティファクト レジストリ内のパッケージ バージョンを参照するためのユーザー定義のフレンドリ拡張名です。

mcr.microsoft.com/bicep/extensions/microsoftgraph の部分がアーティファクトレジストリで <version> はレジストリで公開されているバージョンです。

バージョンは https://github.com/microsoftgraph/msgraph-bicep-types/tags で公開されているタグの先頭のvを除いたものを指定します（v0.1.8-previewの場合は 0.1.8-preview と記載します）。

{  
    "experimentalFeaturesEnabled": {  
        "extensibility": true  
    },
    "extensions": {  
        "microsoftGraphV1_0": "br:mcr.microsoft.com/bicep/extensions/microsoftgraph/v1.0:<version>"  
    }  
}

変更点２　bicepでの指定

続いて実際にMicrosoft Graphを利用しているBicepでの指定です。 先程の例で provider microsoftGraph または extension microsoftGraph となっている部分を extension microsoftGraphV1_0 と置き換えます。 microsoftGraphV1_0 の部分は bicepconfig.json のextensionsのところで定義した名称になります。

extension microsoftGraphV1_0

@description('Application name, unique globally. Can not change after create it')
param appName string

...

これで終了です。

ステータスがexperimentalであったこともあり何度か変更が実施されましたが、今回の指定で概ね方向は固まったのではないかなと思います。

ということで、今回はMicrosoft Graph Bicep利用時の変更方法についてお知らせしました。

Microsoft Graph Bicepのステータスがexperimentalから脱するのも間近かもしれません。早くGAとなることを期待します。