Group - Get

參考

Service:: API Management

API Version:: 2022-08-01

取得其識別碼所指定群組的詳細資料。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-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	目標訂用帳戶的識別碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

Name	Type	Description
200 OK	GroupContract	回應主體包含指定的群組實體。 Headers ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

Name

Type

Description

200 OK

GroupContract

回應主體包含指定的群組實體。

Headers

ETag: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

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

範例

ApiManagementGetGroup

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2022-08-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "59306a29e4bbd510dc24e5f9",
  "properties": {
    "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)",
    "description": "awesome group of people",
    "builtIn": false,
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
  }
}

定義

ErrorFieldContract	錯誤欄位合約。
ErrorResponse	錯誤回應。
GroupContract	合約詳細資料。
GroupType	群組類型。

ErrorFieldContract

錯誤欄位合約。

Name	Type	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤標記法。
target	string	屬性名稱。

ErrorResponse

錯誤回應。

Name	Type	Description
error.code	string	服務定義的錯誤碼。此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details	ErrorFieldContract[]	在驗證錯誤時，要求中傳送的無效欄位清單。
error.message	string	人類可閱讀的錯誤表示法。

GroupContract

合約詳細資料。

Name	Type	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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	GroupType	群組類型。
type	string	資源類型。例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

GroupType

群組類型。

Name	Type	Description
custom	string
external	string
system	string