Class ServerIPAssignmentsResource

Server IP Assignments resource

Hierarchy

BaseResource
- ServerIPAssignmentsResource

Index

Constructors

Properties

Methods

create createDynamicIpAssignments createRdns delete getAssignableIpsOfSubnet getAssignableSubnets list request update validateId validateRequiredString

Constructors

constructor

new ServerIPAssignmentsResource(
client: any,
serverId: number,
): ServerIPAssignmentsResource
Parameters
- client: any
- serverId: number
Returns ServerIPAssignmentsResource
Overrides BaseResource.constructor
- Defined in server-extensions.ts:617

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

create

create(data: Partial<ServerIPAssignment>): Promise<ServerIPAssignment>
Parameters
- data: Partial<ServerIPAssignment>
Returns Promise<ServerIPAssignment>
- Defined in server-extensions.ts:630

createDynamicIpAssignments

createDynamicIpAssignments(data: any): Promise<void>
Parameters
- data: any
Returns Promise<void>
- Defined in server-extensions.ts:696

createRdns

createRdns(data: any): Promise<void>
Parameters
- data: any
Returns Promise<void>
- Defined in server-extensions.ts:688

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in server-extensions.ts:660

getAssignableIpsOfSubnet

getAssignableIpsOfSubnet(data: { subnetId: number }): Promise<string[]>
Parameters
- data: { subnetId: number }
Returns Promise<string[]>
- Defined in server-extensions.ts:678

getAssignableSubnets

getAssignableSubnets(): Promise<any[]>
Returns Promise<any[]>
- Defined in server-extensions.ts:669

list

list(): Promise<ServerIPAssignment[]>
Returns Promise<ServerIPAssignment[]>
- Defined in server-extensions.ts:621

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in server-extensions.ts:82

update

update(
id: number,
data: Partial<ServerIPAssignment>,
): Promise<ServerIPAssignment>
Parameters
- id: number
- data: Partial<ServerIPAssignment>
Returns Promise<ServerIPAssignment>
- Defined in server-extensions.ts:644

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in server-extensions.ts:89

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in server-extensions.ts:98