Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Gateway

Package version

Class representing a Gateway.

Hierarchy

  • Gateway

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • 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.

    summary

    Creates or updates a gateway resource.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • gatewayResourceDescription: GatewayResourceDescription

      Description for creating a Gateway resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayCreateResponse>

    Promise<Models.GatewayCreateResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • gatewayResourceDescription: GatewayResourceDescription

      Description for creating a Gateway resource.

    • callback: msRest.ServiceCallback<GatewayResourceDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • gatewayResourceDescription: GatewayResourceDescription

      Description for creating a Gateway resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<GatewayResourceDescription>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, gatewayResourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, gatewayResourceName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, gatewayResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes the gateway resource identified by the name.

    summary

    Deletes the gateway resource.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, gatewayResourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.GatewayGetResponse>
  • get(resourceGroupName: string, gatewayResourceName: string, callback: msRest.ServiceCallback<GatewayResourceDescription>): void
  • get(resourceGroupName: string, gatewayResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescription>): void

  • Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.

    summary

    Gets the gateway resource with the given name.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayGetResponse>

    Promise<Models.GatewayGetResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • callback: msRest.ServiceCallback<GatewayResourceDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • gatewayResourceName: string

      The identity of the gateway.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<GatewayResourceDescription>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.GatewayListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void

  • Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.

    summary

    Gets all the gateway resources in a given resource group.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayListByResourceGroupResponse>

    Promise<Models.GatewayListByResourceGroupResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<GatewayResourceDescriptionList>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.GatewayListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void

  • Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.

    summary

    Gets all the gateway resources in a given resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayListByResourceGroupNextResponse>

    Promise<Models.GatewayListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<GatewayResourceDescriptionList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<GatewayResourceDescriptionList>

      The callback

    Returns void

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.GatewayListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void

  • Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.

    summary

    Gets all the gateway resources in a given subscription.

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayListBySubscriptionResponse>

    Promise<Models.GatewayListBySubscriptionResponse>

  • Parameters

    Returns void

  • Parameters

    Returns void

listBySubscriptionNext

  • listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.GatewayListBySubscriptionNextResponse>
  • listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void
  • listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescriptionList>): void

  • Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.

    summary

    Gets all the gateway resources in a given subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GatewayListBySubscriptionNextResponse>

    Promise<Models.GatewayListBySubscriptionNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<GatewayResourceDescriptionList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<GatewayResourceDescriptionList>

      The callback

    Returns void

Generated using TypeDoc