Group - Create Or Update

グループを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2019-12-01

URI パラメーター

Name In Required Type Description
groupId
path True
  • string

グループ識別子。 現在の API 管理サービス インスタンス内で一意である必要があります。

resourceGroupName
path True
  • string

リソース グループの名前。

serviceName
path True
  • string

API 管理サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

要求ヘッダー

Name Required Type Description
If-Match
  • string

エンティティの ETag。 エンティティの作成時には必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

Name Required Type Description
properties.description
  • string

グループの説明。

properties.displayName True
  • string

[グループ名]:

properties.externalId
  • string

外部グループの識別子、このプロパティには、外部 ID プロバイダーからのグループの ID が含まれますaad://<tenant>.onmicrosoft.com/groups/<group object id>。それ以外の場合、値は null です。

properties.type

グループの種類。

応答

Name Type Description
200 OK

グループは既に存在します。

Headers

  • ETag: string
201 Created

グループは正常に作成されました。

Headers

  • ETag: string
Other Status Codes

操作が失敗した理由を示すエラー応答です。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementCreateGroup
ApiManagementCreateGroupExternal

ApiManagementCreateGroup

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2019-12-01
{
  "properties": {
    "displayName": "temp group"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}

ApiManagementCreateGroupExternal

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2019-12-01
{
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

定義

ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

GroupContract

契約の詳細。

GroupCreateParameters

グループの作成操作に指定されたパラメーター。

GroupType

グループの種類。

ErrorFieldContract

エラー フィールド コントラクト。

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に、要求で送信される無効なフィールドのリスト。

error.message
  • string

エラーの人間が読み取り可能な表現。

GroupContract

契約の詳細。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.builtIn
  • boolean

グループが 3 つのシステム グループ (管理者、開発者、またはゲスト) のいずれかである場合は true。それ以外の場合は false です。

properties.description
  • string

グループの説明。 HTML 書式設定タグを含めることができます。

properties.displayName
  • string

[グループ名]:

properties.externalId
  • string

外部グループの場合、このプロパティには、外部 ID プロバイダーからのグループの ID が含まれますaad://<tenant>.onmicrosoft.com/groups/<group object id>。それ以外の場合、値は null です。

properties.type

グループの種類。

type
  • string

API 管理リソースのリソースの種類。

GroupCreateParameters

グループの作成操作に指定されたパラメーター。

Name Type Description
properties.description
  • string

グループの説明。

properties.displayName
  • string

[グループ名]:

properties.externalId
  • string

外部グループの識別子、このプロパティには、外部 ID プロバイダーからのグループの ID が含まれますaad://<tenant>.onmicrosoft.com/groups/<group object id>。それ以外の場合、値は null です。

properties.type

グループの種類。

GroupType

グループの種類。

Name Type Description
custom
  • string
external
  • string
system
  • string