Class NetworkAcls

Index

Constructors

constructor

new NetworkAcls(_options: NetworkAcls.Options): NetworkAcls
Parameters
- _options: NetworkAcls.Options
Returns NetworkAcls

Methods

list

list(
request?: Management.ListNetworkAclsRequestParameters,
requestOptions?: NetworkAcls.RequestOptions,
): Promise<Page<NetworkAclsResponseContent>>
Get all access control list entries for your client.
Parameters
- request: Management.ListNetworkAclsRequestParameters = {}
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns Promise<Page<NetworkAclsResponseContent>>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.networkAcls.list()
```

create

create(
request: Management.CreateNetworkAclRequestContent,
requestOptions?: NetworkAcls.RequestOptions,
): HttpResponsePromise<void>
Create a new access control list for your client.
Parameters
- request: Management.CreateNetworkAclRequestContent
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError
Example
```
await client.networkAcls.create({
        description: "description",
        active: true,
        priority: 1.1,
        rule: {
            action: {},
            scope: "management"
        }
    })
```

get

get(
id: string,
requestOptions?: NetworkAcls.RequestOptions,
): HttpResponsePromise<GetNetworkAclsResponseContent>
Get a specific access control list entry for your client.
Parameters
- id: string
  The id of the access control list to retrieve.
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetNetworkAclsResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.networkAcls.get("id")
```

set

set(
    id: string,
    request: Management.SetNetworkAclRequestContent,
    requestOptions?: NetworkAcls.RequestOptions,
): HttpResponsePromise<SetNetworkAclsResponseContent>
Update existing access control list for your client.
Parameters
- id: string
  The id of the ACL to update.
- request: Management.SetNetworkAclRequestContent
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetNetworkAclsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.networkAcls.set("id", {
        description: "description",
        active: true,
        priority: 1.1,
        rule: {
            action: {},
            scope: "management"
        }
    })
```

delete

delete(
id: string,
requestOptions?: NetworkAcls.RequestOptions,
): HttpResponsePromise<void>
Delete existing access control list for your client.
Parameters
- id: string
  The id of the ACL to delete
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.networkAcls.delete("id")
```

update

update(
    id: string,
    request?: Management.UpdateNetworkAclRequestContent,
    requestOptions?: NetworkAcls.RequestOptions,
): HttpResponsePromise<UpdateNetworkAclResponseContent>
Update existing access control list for your client.
Parameters
- id: string
  The id of the ACL to update.
- request: Management.UpdateNetworkAclRequestContent = {}
- OptionalrequestOptions: NetworkAcls.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateNetworkAclResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.networkAcls.update("id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: NetworkAcls.Options

Class NetworkAcls

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns NetworkAcls

Methods

list

Parameters

Returns Promise<Page<NetworkAclsResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetNetworkAclsResponseContent>

Throws

Throws

Throws

Throws

Example

set

Parameters

Returns HttpResponsePromise<SetNetworkAclsResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateNetworkAclResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options