MeshNetwork | @azure/servicefabric

Class representing a MeshNetwork.

Hierarchy

MeshNetwork

Index

Constructors

constructor

Methods

Constructors

constructor

new MeshNetwork(client: ServiceFabricClientContext): MeshNetwork

- Defined in operations/meshNetwork.ts:19
Create a MeshNetwork.

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

Methods

createOrUpdate

createOrUpdate(networkResourceName: string, networkResourceDescription: NetworkResourceDescription, options?: msRest.RequestOptionsBase): Promise<Models.MeshNetworkCreateOrUpdateResponse>
createOrUpdate(networkResourceName: string, networkResourceDescription: NetworkResourceDescription, callback: msRest.ServiceCallback<NetworkResourceDescription>): void
createOrUpdate(networkResourceName: string, networkResourceDescription: NetworkResourceDescription, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NetworkResourceDescription>): void

- Defined in operations/meshNetwork.ts:39
Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.

summary

Creates or updates a Network resource.

Parameters
- networkResourceName: string
  
  The identity of the network.
- networkResourceDescription: NetworkResourceDescription
  
  Description for creating a Network resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshNetworkCreateOrUpdateResponse>

Promise<Models.MeshNetworkCreateOrUpdateResponse>
- Defined in operations/meshNetwork.ts:45
Parameters
- networkResourceName: string
  
  The identity of the network.
- networkResourceDescription: NetworkResourceDescription
  
  Description for creating a Network resource.
- callback: msRest.ServiceCallback<NetworkResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshNetwork.ts:52
Parameters
- networkResourceName: string
  
  The identity of the network.
- networkResourceDescription: NetworkResourceDescription
  
  Description for creating a Network resource.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<NetworkResourceDescription>
  
  The callback
Returns void

deleteMethod

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

- Defined in operations/meshNetwork.ts:101
Deletes the Network resource identified by the name.

summary

Deletes the Network resource.

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

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

get

get(networkResourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.MeshNetworkGetResponse>
get(networkResourceName: string, callback: msRest.ServiceCallback<NetworkResourceDescription>): void
get(networkResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NetworkResourceDescription>): void

- Defined in operations/meshNetwork.ts:72
Gets the information about the Network resource with the given name. The information include the description and other properties of the Network.

summary

Gets the Network resource with the given name.

Parameters
- networkResourceName: string
  
  The identity of the network.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshNetworkGetResponse>

Promise<Models.MeshNetworkGetResponse>
- Defined in operations/meshNetwork.ts:77
Parameters
- networkResourceName: string
  
  The identity of the network.
- callback: msRest.ServiceCallback<NetworkResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshNetwork.ts:83
Parameters
- networkResourceName: string
  
  The identity of the network.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<NetworkResourceDescription>
  
  The callback
Returns void

list

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

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

summary

Lists all the network resources.

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

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ServiceFabricClientContext

Returns MeshNetwork

Methods

createOrUpdate

Parameters

networkResourceName: string

networkResourceDescription: NetworkResourceDescription

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshNetworkCreateOrUpdateResponse>

Parameters

networkResourceName: string

networkResourceDescription: NetworkResourceDescription

callback: msRest.ServiceCallback<NetworkResourceDescription>

Returns void

Parameters

networkResourceName: string

networkResourceDescription: NetworkResourceDescription

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<NetworkResourceDescription>

Returns void

deleteMethod

Parameters

networkResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

networkResourceName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

networkResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

networkResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshNetworkGetResponse>

Parameters

networkResourceName: string

callback: msRest.ServiceCallback<NetworkResourceDescription>

Returns void

Parameters

networkResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<NetworkResourceDescription>

Returns void

list

Parameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshNetworkListResponse>

Parameters

callback: msRest.ServiceCallback<PagedNetworkResourceDescriptionList>

Returns void

Parameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<PagedNetworkResourceDescriptionList>

Returns void