Gateway interface
代表閘道的介面。
方法
方法詳細資料
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
建立或更新要用於 Api 管理實例的閘道。
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- parameters
- GatewayContract
閘道詳細數據。
選項參數。
傳回
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
刪除特定的閘道。
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- options
- GatewayDeleteOptionalParams
選項參數。
傳回
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
取得閘道的共用存取授權令牌。
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- parameters
- GatewayTokenRequestContract
閘道令牌要求合約屬性。
選項參數。
傳回
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
取得其標識碼所指定的網關詳細數據。
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- options
- GatewayGetOptionalParams
選項參數。
傳回
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
取得其標識碼所指定閘道的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
選項參數。
傳回
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
列出向服務實例註冊的網關集合。
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listKeys(string, string, string, GatewayListKeysOptionalParams)
擷取閘道金鑰。
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- options
- GatewayListKeysOptionalParams
選項參數。
傳回
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
重新產生指定的閘道金鑰，使它所建立的任何令牌失效。
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- parameters
- GatewayKeyRegenerationRequestContract
閘道金鑰重新產生要求合約屬性。
選項參數。
傳回
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
更新其識別碼所指定的閘道詳細數據。
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- gatewayId
-
string
閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- GatewayContract
閘道詳細數據。
- options
- GatewayUpdateOptionalParams
選項參數。
傳回
Promise<GatewayUpdateResponse>