Product Group - Create Or Update

加入指定之開發人員群組與指定產品之間的關聯。

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

URI 參數

Name In Required Type Description
groupId
path True
  • string

群組識別碼。 在目前的 API 管理服務實例中必須是唯一的。

productId
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 訂用帳戶的訂用帳號憑證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True
  • string

要搭配用戶端要求使用的 API 版本。

回應

Name Type Description
200 OK

指定的群組已與產品產生關聯。

201 Created

群組已成功與產品產生關聯。

Other Status Codes

描述作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

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

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

ApiManagementCreateProductGroup

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groups/templateGroup?api-version=2021-01-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup",
  "type": "Microsoft.ApiManagement/service/products/groups",
  "name": "templateGroup",
  "properties": {
    "displayName": "Template Group",
    "description": "group created via Template",
    "builtIn": false,
    "type": "custom"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup",
  "type": "Microsoft.ApiManagement/service/products/groups",
  "name": "templateGroup",
  "properties": {
    "displayName": "Template Group",
    "description": "group created via Template",
    "builtIn": false,
    "type": "custom"
  }
}

定義

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

GroupContract

合約詳細資料。

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

資源識別碼。

name
  • string

資源名稱。

properties.builtIn
  • boolean

如果群組是三個系統群組之一 (系統管理員、開發人員或來賓) ,則為 true;否則為 false。

properties.description
  • string

群組描述。 可包含 HTML 格式標記。

properties.displayName
  • string

群組名稱。

properties.externalId
  • string

對於外部群組,此屬性包含來自外部識別提供者之群組的識別碼,例如 Azure Active Directory, aad://<tenant>.onmicrosoft.com/groups/<group object id> 否則值為 null。

properties.type

群組類型。

type
  • string

API 管理資源的資源類型。

GroupType

群組類型。

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