Class API

constructor

• new API(client): VPC.v1.API

• Parameters

  • client: Client

  Returns VPC.v1.API

Static ReadonlyLOCALITIES

createPrivateNetwork

• createPrivateNetwork(request?): Promise<VPC.v1.PrivateNetwork>

• Create a Private Network. Create a new Private Network. Once created, you can attach Scaleway resources in the same Availability Zone.

  Parameters

  • request: Readonly<VPC.v1.CreatePrivateNetworkRequest> = {}

    The request CreatePrivateNetworkRequest

  Returns Promise<VPC.v1.PrivateNetwork>

  A Promise of PrivateNetwork

deletePrivateNetwork

• deletePrivateNetwork(request): Promise<void>

• Delete a Private Network. Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it.

  Parameters

  • request: Readonly<VPC.v1.DeletePrivateNetworkRequest>

    The request DeletePrivateNetworkRequest

  Returns Promise<void>

getPrivateNetwork

• getPrivateNetwork(request): Promise<VPC.v1.PrivateNetwork>

• Get a Private Network. Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object.

  Parameters

  • request: Readonly<VPC.v1.GetPrivateNetworkRequest>

    The request GetPrivateNetworkRequest

  Returns Promise<VPC.v1.PrivateNetwork>

  A Promise of PrivateNetwork

listPrivateNetworks

• listPrivateNetworks(request?): Promise<VPC.v1.ListPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC.v1.PrivateNetwork[], void, void>);
      all: (() => Promise<VPC.v1.PrivateNetwork[]>);
  }

• List Private Networks. List existing Private Networks in a specified Availability Zone. By default, the Private Networks returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<VPC.v1.ListPrivateNetworksRequest> = {}

    The request ListPrivateNetworksRequest

  Returns Promise<VPC.v1.ListPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<VPC.v1.PrivateNetwork[], void, void>);
      all: (() => Promise<VPC.v1.PrivateNetwork[]>);
  }

  A Promise of ListPrivateNetworksResponse

updatePrivateNetwork

• updatePrivateNetwork(request): Promise<VPC.v1.PrivateNetwork>

• Update Private Network. Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID.

  Parameters

  • request: Readonly<VPC.v1.UpdatePrivateNetworkRequest>

    The request UpdatePrivateNetworkRequest

  Returns Promise<VPC.v1.PrivateNetwork>

  A Promise of PrivateNetwork