MeshGateway | @azure/servicefabric

Class representing a MeshGateway.

Hierarchy

MeshGateway

Index

Constructors

constructor

Methods

Constructors

constructor

new MeshGateway(client: ServiceFabricClientContext): MeshGateway

- Defined in operations/meshGateway.ts:19
Create a MeshGateway.

Parameters
- client: ServiceFabricClientContext
  
  Reference to the service client.
Returns MeshGateway

Methods

createOrUpdate

createOrUpdate(gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, options?: msRest.RequestOptionsBase): Promise<Models.MeshGatewayCreateOrUpdateResponse>
createOrUpdate(gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, callback: msRest.ServiceCallback<GatewayResourceDescription>): void
createOrUpdate(gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<GatewayResourceDescription>): void

- Defined in operations/meshGateway.ts:39
Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.

summary

Creates or updates a Gateway resource.

Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- gatewayResourceDescription: GatewayResourceDescription
  
  Description for creating a Gateway resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshGatewayCreateOrUpdateResponse>

Promise<Models.MeshGatewayCreateOrUpdateResponse>
- Defined in operations/meshGateway.ts:45
Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- gatewayResourceDescription: GatewayResourceDescription
  
  Description for creating a Gateway resource.
- callback: msRest.ServiceCallback<GatewayResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshGateway.ts:52
Parameters
- 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(gatewayResourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(gatewayResourceName: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(gatewayResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/meshGateway.ts:101
Deletes the Gateway resource identified by the name.

summary

Deletes the Gateway resource.

Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/meshGateway.ts:106
Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/meshGateway.ts:112
Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

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

- Defined in operations/meshGateway.ts:72
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
- gatewayResourceName: string
  
  The identity of the gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshGatewayGetResponse>

Promise<Models.MeshGatewayGetResponse>
- Defined in operations/meshGateway.ts:77
Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- callback: msRest.ServiceCallback<GatewayResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshGateway.ts:83
Parameters
- gatewayResourceName: string
  
  The identity of the gateway.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<GatewayResourceDescription>
  
  The callback
Returns void

list

list(options?: msRest.RequestOptionsBase): Promise<Models.MeshGatewayListResponse>
list(callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>): void
list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>): void

- Defined in operations/meshGateway.ts:130
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.

summary

Lists all the gateway resources.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshGatewayListResponse>

Promise<Models.MeshGatewayListResponse>
- Defined in operations/meshGateway.ts:134
Parameters
- callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>
  
  The callback
Returns void
- Defined in operations/meshGateway.ts:139
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ServiceFabricClientContext

Returns MeshGateway

Methods

createOrUpdate

Parameters

gatewayResourceName: string

gatewayResourceDescription: GatewayResourceDescription

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshGatewayCreateOrUpdateResponse>

Parameters

gatewayResourceName: string

gatewayResourceDescription: GatewayResourceDescription

callback: msRest.ServiceCallback<GatewayResourceDescription>

Returns void

Parameters

gatewayResourceName: string

gatewayResourceDescription: GatewayResourceDescription

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<GatewayResourceDescription>

Returns void

deleteMethod

Parameters

gatewayResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

gatewayResourceName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

gatewayResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

gatewayResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshGatewayGetResponse>

Parameters

gatewayResourceName: string

callback: msRest.ServiceCallback<GatewayResourceDescription>

Returns void

Parameters

gatewayResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<GatewayResourceDescription>

Returns void

list

Parameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshGatewayListResponse>

Parameters

callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>

Returns void

Parameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<PagedGatewayResourceDescriptionList>

Returns void