Gateway class
Class representing a Gateway.
Constructors
| Gateway(Service |
Create a Gateway. |
Methods
Constructor Details
Gateway(ServiceFabricMeshManagementClientContext)
Create a Gateway.
new Gateway(client: ServiceFabricMeshManagementClientContext)Parameters
Reference to the service client.
Method Details
create(string, string, GatewayResourceDescription, RequestOptionsBase)
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?: RequestOptionsBase): Promise<GatewayCreateResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- gatewayResourceDescription
- GatewayResourceDescription
Description for creating a Gateway resource.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GatewayCreateResponse>
Promise<Models.GatewayCreateResponse>
create(string, string, GatewayResourceDescription, RequestOptionsBase, ServiceCallback<GatewayResourceDescription>)
function create(resourceGroupName: string, gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- gatewayResourceDescription
- GatewayResourceDescription
Description for creating a Gateway resource.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
create(string, string, GatewayResourceDescription, ServiceCallback<GatewayResourceDescription>)
function create(resourceGroupName: string, gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, callback: ServiceCallback<GatewayResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- gatewayResourceDescription
- GatewayResourceDescription
Description for creating a Gateway resource.
- callback
The callback
deleteMethod(string, string, RequestOptionsBase)
Deletes the gateway resource identified by the name.
function deleteMethod(resourceGroupName: string, gatewayResourceName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, gatewayResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, gatewayResourceName: string, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- callback
-
ServiceCallback<void>
The callback
get(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<GatewayGetResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GatewayGetResponse>
Promise<Models.GatewayGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<GatewayResourceDescription>)
function get(resourceGroupName: string, gatewayResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<GatewayResourceDescription>)
function get(resourceGroupName: string, gatewayResourceName: string, callback: ServiceCallback<GatewayResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- gatewayResourceName
-
string
The identity of the gateway.
- callback
The callback
listByResourceGroup(string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<GatewayListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GatewayListByResourceGroupResponse>
Promise<Models.GatewayListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<GatewayResourceDescriptionList>)
function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
- options
- RequestOptionsBase
The optional parameters
The callback
listByResourceGroup(string, ServiceCallback<GatewayResourceDescriptionList>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
The callback
listByResourceGroupNext(string, RequestOptionsBase)
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
function listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<GatewayListByResourceGroupNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.GatewayListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<GatewayResourceDescriptionList>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listByResourceGroupNext(string, ServiceCallback<GatewayResourceDescriptionList>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback
listBySubscription(RequestOptionsBase)
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?: RequestOptionsBase): Promise<GatewayListBySubscriptionResponse>Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GatewayListBySubscriptionResponse>
Promise<Models.GatewayListBySubscriptionResponse>
listBySubscription(RequestOptionsBase, ServiceCallback<GatewayResourceDescriptionList>)
function listBySubscription(options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- options
- RequestOptionsBase
The optional parameters
The callback
listBySubscription(ServiceCallback<GatewayResourceDescriptionList>)
function listBySubscription(callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
The callback
listBySubscriptionNext(string, RequestOptionsBase)
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
function listBySubscriptionNext(nextPageLink: string, options?: RequestOptionsBase): Promise<GatewayListBySubscriptionNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.GatewayListBySubscriptionNextResponse>
listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<GatewayResourceDescriptionList>)
function listBySubscriptionNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listBySubscriptionNext(string, ServiceCallback<GatewayResourceDescriptionList>)
function listBySubscriptionNext(nextPageLink: string, callback: ServiceCallback<GatewayResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback