ApiGateway interface
Interface representing a ApiGateway.
Methods
Method Details
beginCreateOrUpdate(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)
Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- parameters
- ApiManagementGatewayResource
Parameters supplied to the CreateOrUpdate API Management gateway operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)
Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<ApiManagementGatewayResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- parameters
- ApiManagementGatewayResource
Parameters supplied to the CreateOrUpdate API Management gateway operation.
The options parameters.
Returns
Promise<ApiManagementGatewayResource>
beginDelete(string, string, ApiGatewayDeleteOptionalParams)
Deletes an existing API Management gateway.
function beginDelete(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ApiGatewayDeleteResponse>, ApiGatewayDeleteResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- options
- ApiGatewayDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiGatewayDeleteResponse>, ApiGatewayDeleteResponse>>
beginDeleteAndWait(string, string, ApiGatewayDeleteOptionalParams)
Deletes an existing API Management gateway.
function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<ApiGatewayDeleteResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- options
- ApiGatewayDeleteOptionalParams
The options parameters.
Returns
Promise<ApiGatewayDeleteResponse>
beginUpdate(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)
Updates an existing API Management gateway.
function beginUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- parameters
- ApiManagementGatewayUpdateParameters
Parameters supplied to the CreateOrUpdate API Management gateway operation.
- options
- ApiGatewayUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>
beginUpdateAndWait(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)
Updates an existing API Management gateway.
function beginUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<ApiManagementGatewayResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- parameters
- ApiManagementGatewayUpdateParameters
Parameters supplied to the CreateOrUpdate API Management gateway operation.
- options
- ApiGatewayUpdateOptionalParams
The options parameters.
Returns
Promise<ApiManagementGatewayResource>
get(string, string, ApiGatewayGetOptionalParams)
Gets an API Management gateway resource description.
function get(resourceGroupName: string, gatewayName: string, options?: ApiGatewayGetOptionalParams): Promise<ApiManagementGatewayResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- gatewayName
-
string
The name of the API Management gateway.
- options
- ApiGatewayGetOptionalParams
The options parameters.
Returns
Promise<ApiManagementGatewayResource>
list(ApiGatewayListOptionalParams)
List all API Management gateways within a subscription.
function list(options?: ApiGatewayListOptionalParams): PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>Parameters
- options
- ApiGatewayListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ApiGatewayListByResourceGroupOptionalParams)
List all API Management gateways within a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ApiGatewayListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.