Gateway interface
Interfejs reprezentujący bramę.
Metody
Szczegóły metody
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje bramę do użycia w wystąpieniu usługi Api Management.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- parameters
- GatewayContract
Szczegóły bramy.
Parametry opcji.
Zwraca
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Usuwa określoną bramę.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- options
- GatewayDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Pobiera token autoryzacji dostępu współdzielonego dla bramy.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- parameters
- GatewayTokenRequestContract
Właściwości kontraktu żądania tokenu bramy.
Parametry opcji.
Zwraca
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Pobiera szczegóły bramy określone przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- options
- GatewayGetOptionalParams
Parametry opcji.
Zwraca
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) bramy określonej przez jej identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
Parametry opcji.
Zwraca
Promise<GatewayGetEntityTagHeaders>
invalidateDebugCredentials(string, string, string, GatewayInvalidateDebugCredentialsOptionalParams)
Akcja powoduje unieważnienie wszystkich poświadczeń debugowania wystawionych dla bramy.
function invalidateDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayInvalidateDebugCredentialsOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
Parametry opcji.
Zwraca
Promise<void>
listByService(string, string, GatewayListByServiceOptionalParams)
Wyświetla listę kolekcji bram zarejestrowanych w wystąpieniu usługi.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
Parametry opcji.
Zwraca
listDebugCredentials(string, string, string, GatewayListDebugCredentialsContract, GatewayListDebugCredentialsOptionalParams)
Utwórz nowe poświadczenia debugowania dla bramy.
function listDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListDebugCredentialsContract, options?: GatewayListDebugCredentialsOptionalParams): Promise<GatewayDebugCredentialsContract>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- parameters
- GatewayListDebugCredentialsContract
Wyświetlanie listy właściwości poświadczeń debugowania.
Parametry opcji.
Zwraca
Promise<GatewayDebugCredentialsContract>
listKeys(string, string, string, GatewayListKeysOptionalParams)
Pobiera klucze bramy.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- options
- GatewayListKeysOptionalParams
Parametry opcji.
Zwraca
Promise<GatewayListKeysResponse>
listTrace(string, string, string, GatewayListTraceContract, GatewayListTraceOptionalParams)
Pobiera ślad zbierany przez bramę.
function listTrace(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListTraceContract, options?: GatewayListTraceOptionalParams): Promise<GatewayListTraceResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- parameters
- GatewayListTraceContract
Wyświetlanie listy właściwości śledzenia.
- options
- GatewayListTraceOptionalParams
Parametry opcji.
Zwraca
Promise<GatewayListTraceResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Ponownie generuje określony klucz bramy, unieważniając wszystkie utworzone za jego pomocą tokeny.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- parameters
- GatewayKeyRegenerationRequestContract
Właściwości kontraktu żądania ponownego odtworzenia klucza bramy.
Parametry opcji.
Zwraca
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Aktualizuje szczegóły bramy określone przez jego identyfikator.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- gatewayId
-
string
Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- GatewayContract
Szczegóły bramy.
- options
- GatewayUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<GatewayUpdateResponse>