> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/naming-conventions.md).

# Runbook の命名規則

RealmJoin runbook の命名規則: コンテキストとカテゴリが共有リポジトリの Runbook 名を Azure Automation とポータルでどのように対応付けるか。

## Github のファイル名

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

ダッシュ（"-"）はスペースに変換されます。フォルダーは runbook を「context」と「category」に分けるために使用されます。たとえば `user\general`. ファイル名はスクリプトの目的を表すものであるべきです。

インポートされるすべての runbook には `rjgit-`というプレフィックスが付き、その後にコンテキストが続き、次のいずれかが入ります `組織`, `グループ`, `ユーザー` または `デバイス` その後にカテゴリ、たとえば `_general_`, `_security_`, `_mail_` そして、スクリプト自体の名前、たとえば `add-additional-alias`.

### 例:

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

* `rjgit-user_general_add-additional-alias` Azure Automation Account 内で
* 「Add Additional Alias」は、runbook カテゴリ「General」の User オブジェクト上で RealmJoin Portal に表示されます。

一般的なカテゴリ

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

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

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

これにより、RealmJoin Portal の runbook を自動的に入力し、命名できます。また、 `rjgit-` このプレフィックスにより、ローカル／顧客固有の runbook との命名競合を避けられます。このプレフィックスのない runbook は、RealmJoin のインポートロジックの対象になりません。

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

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

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

例：Azure AD グループをコンテキストとし、カテゴリ「General」の runbook「Private 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)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/naming-conventions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
