Gateway interface
Interface representing a Gateway.
Methods
| create(string, string, Gateway |
Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application. |
| delete(string, string, Gateway |
Deletes the gateway resource identified by the name. |
| get(string, string, Gateway |
Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway. |
| list |
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway. |
| list |
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway. |
Method Details
create(string, string, GatewayResourceDescription, GatewayCreateOptionalParams)
Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.
function create(resourceGroupName: string, gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, options?: GatewayCreateOptionalParams): Promise<GatewayResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- gatewayResourceDescription
- GatewayResourceDescription
Description for creating a Gateway resource.
- options
- GatewayCreateOptionalParams
The options parameters.
Returns
Promise<GatewayResourceDescription>
delete(string, string, GatewayDeleteOptionalParams)
Deletes the gateway resource identified by the name.
function delete(resourceGroupName: string, gatewayResourceName: string, options?: GatewayDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- GatewayDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, GatewayGetOptionalParams)
Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.
function get(resourceGroupName: string, gatewayResourceName: string, options?: GatewayGetOptionalParams): Promise<GatewayResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- GatewayGetOptionalParams
The options parameters.
Returns
Promise<GatewayResourceDescription>
listByResourceGroup(string, GatewayListByResourceGroupOptionalParams)
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
function listByResourceGroup(resourceGroupName: string, options?: GatewayListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GatewayResourceDescription, GatewayResourceDescription[], PageSettings>Parameters
- resourceGroupName
-
string
Azure resource group name
The options parameters.
Returns
listBySubscription(GatewayListBySubscriptionOptionalParams)
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
function listBySubscription(options?: GatewayListBySubscriptionOptionalParams): PagedAsyncIterableIterator<GatewayResourceDescription, GatewayResourceDescription[], PageSettings>Parameters
The options parameters.
Returns
Azure SDK for JavaScript