Group interface
代表群組的介面。
方法
| create |
建立或更新群組。 |
| delete(string, string, string, string, Group |
刪除API 管理服務實例的特定群組。 |
| get(string, string, string, Group |
取得其識別碼所指定群組的詳細資料。 |
| get |
取得實體狀態 (Etag) 其識別碼所指定的群組版本。 |
| list |
列出服務實例內定義的群組集合。 |
| update(string, string, string, string, Group |
更新識別碼所指定群組的詳細資料。 |
方法詳細資料
createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)
建立或更新群組。
function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- groupId
-
string
群組識別碼。 目前API 管理服務實例中必須是唯一的。
- parameters
- GroupCreateParameters
建立參數。
選項參數。
傳回
Promise<GroupCreateOrUpdateResponse>
delete(string, string, string, string, GroupDeleteOptionalParams)
刪除API 管理服務實例的特定群組。
function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- groupId
-
string
群組識別碼。 目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- options
- GroupDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, GroupGetOptionalParams)
取得其識別碼所指定群組的詳細資料。
function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- groupId
-
string
群組識別碼。 目前API 管理服務實例中必須是唯一的。
- options
- GroupGetOptionalParams
選項參數。
傳回
Promise<GroupGetResponse>
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)
取得實體狀態 (Etag) 其識別碼所指定的群組版本。
function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- groupId
-
string
群組識別碼。 目前API 管理服務實例中必須是唯一的。
- options
- GroupGetEntityTagOptionalParams
選項參數。
傳回
Promise<GroupGetEntityTagHeaders>
listByService(string, string, GroupListByServiceOptionalParams)
列出服務實例內定義的群組集合。
function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- options
- GroupListByServiceOptionalParams
選項參數。
傳回
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)
更新識別碼所指定群組的詳細資料。
function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- groupId
-
string
群組識別碼。 目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- parameters
- GroupUpdateParameters
更新參數。
- options
- GroupUpdateOptionalParams
選項參數。
傳回
Promise<GroupUpdateResponse>