Elixir-Scaleway v0.1.7 Scaleway.SecurityGroup View Source

Manage Security groups.

Link to this section Summary

Functions

Create a security group

List all security groups

Delete a security group

Retrieves a security group by its id

Update a security group

Link to this section Functions

Link to this function create(data) View Source
create(map()) :: {:ok, HTTPoison.Response} | {:error, HTTPoison.Error}

Create a security group

Examples

iex> data = %{
  :organization => "000a115d-2852-4b0a-9ce8-47f1134ba95a",
  :name => "security-groups-01",
  :description => "Security group 01"
}
%{
  description: "Security group 01",
  name: "security-groups-01",
  organization: "000a115d-2852-4b0a-9ce8-47f1134ba95a"
}

iex> Scaleway.SecurityGroups.create(data)
Link to this function create!(data) View Source
create!(map()) :: map()
Link to this function list() View Source
list() :: {:ok, HTTPoison.Response} | {:error, HTTPoison.Error}

List all security groups.

Examples

iex> Scaleway.SecurityGroups.list
Link to this function remove(id) View Source
remove(charlist()) :: {:ok, HTTPoison.Response} | {:error, HTTPoison.Error}

Delete a security group.

Examples

iex> security_group_id = "000a115d-2852-4b1a-9ce8-47f1134ba95a"
"000a115d-2852-4b1a-9ce8-47f1134ba95a"

iex> Scaleway.SecurityGroups.delete(security_group_id)
Link to this function show(id) View Source
show(charlist()) :: {:ok, HTTPoison.Response} | {:error, HTTPoison.Error}

Retrieves a security group by its id.

Examples

iex> Scaleway.SecurityGroups.show("000a115d-2852-4b1a-9ce8-47f1134ba95a")
Link to this function update(id, data) View Source
update(charlist(), map()) ::
  {:ok, HTTPoison.Response} | {:error, HTTPoison.Error}

Update a security group.

Examples

iex> data = %{
  :organization => "000a115d-2852-4b0a-9ce8-47f1134ba95a",
  :name => "security-groups-01",
  :description => "Security group 01"
}
%{
  description: "Security group 01",
  name: "security-groups-01",
  organization: "000a115d-2852-4b0a-9ce8-47f1134ba95a"
}

iex> security_group_id = "000a115d-2852-4b1a-9ce8-47f1134ba95a"
"000a115d-2852-4b1a-9ce8-47f1134ba95a"

iex> Scaleway.SecurityGroups.update(security_group_id, data)
Link to this function update!(id, data) View Source
update!(charlist(), map()) :: map()