ApiTagDescription interface
表示 ApiTagDescription 的介面。
方法
| create |
在 Api 的範圍內建立/更新標籤描述。 |
| delete(string, string, string, string, string, Api |
刪除 Api 的標籤描述。 |
| get(string, string, string, string, Api |
取得 API 範圍中的標籤描述 |
| get |
取得其識別碼所指定的標記實體狀態版本。 |
| list |
列出 API 範圍中的所有標記描述。 類似于 swagger 的模型 - tagDescription 是在 API 層級上定義，但標記可能會指派給 Operations |
方法詳細資料
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
在 Api 的範圍內建立/更新標籤描述。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 修訂識別碼。 在目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
- tagDescriptionId
-
string
標籤描述識別碼。 用於建立 API/標記關聯的 tagDescription。 根據 API 和標記名稱。
- parameters
- TagDescriptionCreateParameters
建立參數。
選項參數。
傳回
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
刪除 Api 的標籤描述。
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 修訂識別碼。 在目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
- tagDescriptionId
-
string
標籤描述識別碼。 用於建立 API/標記關聯的 tagDescription。 根據 API 和標記名稱。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
取得 API 範圍中的標籤描述
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 修訂識別碼。 在目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
- tagDescriptionId
-
string
標籤描述識別碼。 用於建立 API/標記關聯的 tagDescription。 根據 API 和標記名稱。
選項參數。
傳回
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
取得其識別碼所指定的標記實體狀態版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 修訂識別碼。 在目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
- tagDescriptionId
-
string
標籤描述識別碼。 用於建立 API/標記關聯的 tagDescription。 根據 API 和標記名稱。
選項參數。
傳回
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
列出 API 範圍中的所有標記描述。 類似于 swagger 的模型 - tagDescription 是在 API 層級上定義，但標記可能會指派給 Operations
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 修訂識別碼。 在目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
選項參數。