# ランブックの命名規則

## GitHub内のファイル名

私たちは、の中に一定のファイルおよび命名構造を想定しています [共有 runbook リポジトリ](https://github.com/realmjoin/realmjoin-runbooks)。RealmJoin は、これらのフォルダーとファイルを GitHub から顧客の Azure Automation Account にインポートします。

ダッシュ（"-"）はスペースに変換されます。フォルダーは runbook を「コンテキスト」と「カテゴリ」に分けるために使用されます。例： `user\general`。ファイル名は、スクリプトの目的を表すものであるべきです。 

インポートされるすべての runbook には、のプレフィックスが付きます `rjgit-`。続いてコンテキストが入り、その後に `org`, `group`, `user` 、そしてカテゴリが続きます。例： `_general_`, `_security_`, `_mail_` そして、スクリプト自体の名前、たとえば `add-additional-alias`.

### 例:

GitHub 内の runbook で `user\general` という名前の `add-additional-alias.ps1` は次のように表示されます：

* `rjgit-user_general_add-additional-alias` Azure Automation Account 内で 
* runbook カテゴリ「General」にある User オブジェクトの「Add Additional Alias」。

一般的なカテゴリ

* 一般
* セキュリティ
* メール
* ユーザー情報

追加のカテゴリは定義できますが、コンテキストは定義できません。

### これは何のためですか？

これにより、RealmJoin Portal 内で runbook を自動的に入力し、名前を付けることができます。また、 `rjgit-` プレフィックスにより、ローカル／顧客固有の runbook との命名競合を回避できます。このプレフィックスを持たない runbook は、RealmJoin のインポートロジックによって変更されません。

## プライベート / 顧客固有の Runbook

Azure Automation Account でプライベート（ローカル）runbook をホストできます。これらの runbook は、共有 runbook と同様に RealmJoin Portal に表示されます。ローカル runbook は当社の同期プロセスの対象とならず、他の顧客には表示されません。

ローカル runbook を作成するには、 `rjgit-` プレフィックスを命名規則から削除し、命名構造の残りはそのまま維持します。

例：Azure AD グループのコンテキストとカテゴリ「General」で「Private Runbook」という runbook を提供したい場合、次のように名前を付けます `group_general_private-runbook` Azure Automation Account 内で。

Azure Automation では次のように表示されます：

![GitHub / Azure Automation 内の runbook 名](https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fdv7DajK5q1sVfnlQKurb%2Fnaming-ing1.png?alt=media\&token=136ada07-f577-4210-bd23-4cae6e83fce0)

RealmJoin Portal では次のように表示されます：

![RealmJoin Portal 内の runbook 名](https://3438325150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FwGCdu4ikL2Qvubpf3K2a%2Fnaming-ing2.png?alt=media\&token=917652eb-4cec-4607-8165-f62356477c87)