Class SecurityGroupService

constructor

• new SecurityGroupService(sdk: SDKInterface): SecurityGroupService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns SecurityGroupService

$type

create

• create(
      request: CreateSecurityGroupRequest,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecurityGroupRequest,
      metadata: Metadata,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest
  • metadata: Metadata

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecurityGroupRequest,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecurityGroupRequest,
      metadata: Metadata,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest
  • metadata: Metadata

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

  Creates a new security group with the specified configuration.

  Parameters

  • request: CreateSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSecurityGroupRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteSecurityGroupRequest,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecurityGroupRequest,
      metadata: Metadata,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest
  • metadata: Metadata

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecurityGroupRequest,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecurityGroupRequest,
      metadata: Metadata,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest
  • metadata: Metadata

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

  Deletes a security group by its ID.

  Parameters

  • request: DeleteSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSecurityGroupRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListSecurityGroupsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<SecurityGroup>

  Calls the filter method.

  Parameters

  • request: ListSecurityGroupsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<SecurityGroup>

• filter(
      request: ListSecurityGroupsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<SecurityGroup>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListSecurityGroupsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<SecurityGroup>

get

• get(
      request: GetSecurityGroupRequest,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

• get(
      request: GetSecurityGroupRequest,
      metadata: Metadata,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest
  • metadata: Metadata

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

• get(
      request: GetSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

• get(
      request: GetSecurityGroupRequest,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

• get(
      request: GetSecurityGroupRequest,
      metadata: Metadata,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest
  • metadata: Metadata

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

• get(
      request: GetSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecurityGroupRequest, SecurityGroup>

  Retrieves a security group by its ID.

  Parameters

  • request: GetSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecurityGroupRequest, SecurityGroup>

getByName

• getByName(
      request: GetSecurityGroupByNameRequest,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

• getByName(
      request: GetSecurityGroupByNameRequest,
      metadata: Metadata,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest
  • metadata: Metadata

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

• getByName(
      request: GetSecurityGroupByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

• getByName(
      request: GetSecurityGroupByNameRequest,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

• getByName(
      request: GetSecurityGroupByNameRequest,
      metadata: Metadata,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest
  • metadata: Metadata

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

• getByName(
      request: GetSecurityGroupByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecurityGroupByNameRequest, SecurityGroup>

  Retrieves a security group by its name within a specified parent.

  Parameters

  • request: GetSecurityGroupByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecurityGroupByNameRequest, SecurityGroup>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListSecurityGroupsRequest,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

• list(
      request: ListSecurityGroupsRequest,
      metadata: Metadata,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest
  • metadata: Metadata

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

• list(
      request: ListSecurityGroupsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

• list(
      request: ListSecurityGroupsRequest,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

• list(
      request: ListSecurityGroupsRequest,
      metadata: Metadata,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest
  • metadata: Metadata

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

• list(
      request: ListSecurityGroupsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups within a specified parent.

  Parameters

  • request: ListSecurityGroupsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecurityGroupsRequest, ListSecurityGroupsResponse>

listAggregated

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

• listAggregated(
      request: ListAggregatedSecurityGroupsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

  Lists security groups across regions for the specified parent.

  Parameters

  • request: ListAggregatedSecurityGroupsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedSecurityGroupsRequest, ListSecurityGroupsResponse>

listByNetwork

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
      metadata: Metadata,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest
  • metadata: Metadata

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
      metadata: Metadata,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest
  • metadata: Metadata

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

• listByNetwork(
      request: ListSecurityGroupsByNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

  Lists security groups in a specified network.

  Parameters

  • request: ListSecurityGroupsByNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecurityGroupsByNetworkRequest, ListSecurityGroupsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdateSecurityGroupRequest,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecurityGroupRequest,
      metadata: Metadata,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest
  • metadata: Metadata

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecurityGroupRequest,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecurityGroupRequest,
      metadata: Metadata,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest
  • metadata: Metadata

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecurityGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>

  Updates an existing security group with new configuration parameters.

  Parameters

  • request: UpdateSecurityGroupRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSecurityGroupRequest, Operation<GetOperationRequest>>