NerdGraph チュートリアル: チームの設定

UI で New Relic チームを設定する代わりに、NerdGraph API を使用してプログラムで設定することもできます。

簡単に始めるには、 NerdGraph API エクスプローラーを使用してチーム情報を作成および編集します。以下の例の各フィールドの定義は、NerdGraph で確認できます。 GraphiQL IDE の使用に関してサポートが必要な場合は、 NerdGraph API エクスプローラーチュートリアルをご覧ください。

チームを作成する

以下は、 entityManagementCreateTeamミューテーションクエリを使用してチームを作成する NerdGraph 呼び出しの例です。

mutation {
  entityManagementCreateTeam(
    teamEntity: {
      name: "INSERT_YOUR_TEAM_NAME",
      description: "this is a description of a team",
      aliases: ["tn", "tName"],
      externalIntegration: {
        externalId: "INSERT_THE_EXTERNAL_ID",
        type: IAM_GROUP
      },
      resources: [
        {content: "email@mail.com", title: "email", type: "EMAIL"},
        {content: "https://slack.com/channels/team", title: "Team slack", type: "SLACK"}
      ],
      scope: {
        id: "INSERT_YOUR_ORGANIZATION_ID",
        type: ORGANIZATION
      }
  ) {
    entity {
      id
      ownership {
        id
      }
      membership {
        id
      }
    }
  }
}

このミューテーションを使用する場合は、次の点に注意してください。

必須フィールドはteamNameとscopeのみです。
organizationIDについてサポートが必要な場合は、以下の組織 ID 情報の取得を参照してください。
externalIntegration チームの同期を保つために外部システムとの接続を指します。
- externalId: 外部システム内のID
- type: 外部システムのタイプ
チームを作成すると、2 つのコレクションエンティティが自動的に作成され、チームにリンクされます。エンティティの追加の詳細については、「コレクションの管理」を参照してください。
- ownership: このコレクションは、チームが所有するエンティティを管理します。
- membership: このコレクションはチームのメンバーを管理します。 userID詳細については、「ユーザー ID の取得」を参照してください。

組織を取得する `id`

チームを作成するには、スコープ内に組織 ID を指定する必要があります。

{
  actor {
    organization {
      name
      id
    }
  }
}

コレクションを管理する

チームにユーザーまたはエンティティを追加するには、チームに関連付けられているコレクションにメンバーを追加する必要があります。それぞれのコレクション ID で適切なミューテーションを使用します。ユーザーにはmembershipコレクションを使用し、エンティティにはownershipコレクションを使用します。リクエストごとに最大 100 個のエンティティをコレクションに追加できます。

mutation {
  entityManagementAddCollectionMembers(
    collectionId: "INSERT_YOUR_COLLECTION_ID"
    ids: ["ENTITY_ID"]
  )
}

チームからユーザーまたはエンティティを削除するには、次のクエリを使用して、チームに添付されたコレクションエンティティからメンバーを削除する必要があります。

mutation {
  entityManagementRemoveCollectionMembers(
    collectionId: "INSERT_YOUR_COLLECTION_ID"
    ids: ["ENTITY_ID"]
  )
}

ユーザーを取得する `id`

ユーザーをチームに追加するには、ユーザーエンティティ (GUID とも呼ばれます) の一意の識別子が必要です。

GUID を見つけるのに役立つクエリが多数あります。

ヒント

以下の例では、すべての型で大文字と小文字が区別されることに注意してください。たとえば、 USERとTEAMを使用する必要があります。

ユーザーのドメインを見つける `id`

まず、ユーザーのドメイン ID を見つける必要があります。これは、ユーザーの名前またはメールでクエリとフィルタリングを行うことで実行できます。

{
  actor {
    users {
      userSearch(query: { scope: { email: "INSERT_PARTIAL_EMAIL" } }) {
        users {
          userId
        }
      }
    }
  }
}

{
  actor {
    users {
      userSearch(query: { scope: { name: "INSERT_PARTIAL_NAME" } }) {
        users {
          userId
        }
      }
    }
  }
}

ドメインを持つIDを見つける `id`

ドメインidを取得したら、次のクエリを使用して GUID を検索できます。

{
  actor {
    entitySearch(query: "type='USER' AND tags.userId = 'INSERT_DOMAIN_ID'") {
      results {
        entities {
          guid
        }
      }
    }
  }
}

このタイプのクエリでは、 in演算子も有効です。例:

...
     entitySearch(query: "type = 'USER' AND tags.userId IN ('domainId1', 'domainId2')") {
...

チーム情報を取得する

チーム情報を取得するにはいくつかのオプションがあります。

チーム別 `id`

チームidがある場合、次のクエリを使用してチームに関する情報を取得します。

{
  actor {
    entityManagement {
      entity(id = 'INSERT_TEAM_ENTITY_ID'") {
        ... on EntityManagementTeamEntity {
          id
          name
        }
      }
    }
  }
}

全チーム

team idがない場合は、既存のチームをすべて確認することもできます。

{
  actor {
    entityManagement {
      entitySearch(query: "type = 'TEAM'") {
        entities {
          ... on EntityManagementTeamEntity {
            id
            name
            description
            aliases
          }
        }
      }
    }
  }
}

チームを更新する

チームを更新するには、 entityManagementUpdateTeamミューテーションを使用します。上記のクエリを使用して、チームのid見つけます。

mutation {
  entityManagementUpdateTeam(
    id: "INSERT_YOUR_TEAM_ID",
    teamEntity: {
      ...
    }) {
    entity {
      id
    }
  }
}

コレクションの要素を表示する

collectionElementsクエリを使用して、メンバーシップコレクション内のユーザーまたは所有権コレクション内のエンティティを表示します。

{
  actor {
    entityManagement {
      collectionElements(
        filter: { collectionId: { eq: "INSERT_YOUR_COLLECTION_ID" } }
      ) {
        items {
          id
          name
          type
        }
        nextCursor
      }
    }
  }
}

チーム組織設定の表示と更新

チームは組織スコープのエンティティであるため、組織レベルで適用される設定がいくつかあります。組織の設定を行うには、次のコマンドを使用できます。

{
  actor {
    entityManagement {
      entity(id: “INSERT_TEAMS_SETTINGS_ID”) {
        ... on EntityManagementTeamsOrganizationSettingsEntity {
          discovery {
            enabled
            tagKeys
          }
          syncGroups {
            rules {
              conditions {
                value
                type
              }
            }
            enabled
          }
        }
      }
    }
  }
}

このクエリを使用するときは、次の点に注意してください。

discovery: これは、タグを介してエンティティをチームに割り当てることができる機能です。
enabled: 組織に対してdiscovery機能が有効になっているかどうかを指定します。
tagKeys: チーム名とエイリアスを検索するために使用されるタグキー。デフォルト値はTeamです。したがって、タグTeam: teamNameを持つすべてのエンティティは、その名前またはその名前に一致するエイリアスを持つチームに割り当てられます。
syncGroups: この機能を使用すると、ユーザーグループを認識するためのルールを定義し、アイデンティティプロバイダー (IdP) からのチームの CRUD 操作を完全に自動化できます。これにより、手動による介入を必要とせずに、チームの作成、更新、メンバーシップ管理が常に最新の状態に保たれます。
enabled: 組織に対して機能syncGroupsが有効になっているかどうかを指定します。
rules: conditionsのリスト。
conditions: valueとtypeのリスト。
value: 識別プロバイダーグループ名と一致する文字列。
type: グループ名と一致する必要がある値の型。可能な値はSTARTS_WITH 、 CONTAINS 、 ENDS_WITHです。

組織の設定を編集できるのは、組織の特定のメンバーのみです。これは次のクエリで実行されます。

mutation {
  entityManagementUpdateTeamsOrganizationSettings(
    id: "0bf6d7b0-e1f3-4172-a26a-6e4e0asample"
    teamsOrganizationSettingsEntity: {
      discovery: { enabled: true, tagKeys: ["Owner", "OwningTeam"] }
      syncGroups: {
        enabled: true
        rules: [{ conditions: [{ type: "STARTS_WITH", value: "testing" }] }]
      }
    }
  )
}

チームUI設定に戻る

New Relic チームの紹介

この機械翻訳は、参考として提供されています。