IpFirewallRules | @azure/arm-synapse

Interface representing a IpFirewallRules.

Hierarchy

IpFirewallRules

Implemented by

IpFirewallRulesImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, ruleName: string, ipFirewallRuleInfo: IpFirewallRuleInfo, options?: IpFirewallRulesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IpFirewallRulesCreateOrUpdateResponse>, IpFirewallRulesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/ipFirewallRules.ts:47
Creates or updates a firewall rule

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- ruleName: string
  
  The IP firewall rule name
- ipFirewallRuleInfo: IpFirewallRuleInfo
  
  IP firewall rule properties
- Optional options: IpFirewallRulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<IpFirewallRulesCreateOrUpdateResponse>, IpFirewallRulesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, ruleName: string, ipFirewallRuleInfo: IpFirewallRuleInfo, options?: IpFirewallRulesCreateOrUpdateOptionalParams): Promise<IpFirewallRulesCreateOrUpdateResponse>

- Defined in operationsInterfaces/ipFirewallRules.ts:67
Creates or updates a firewall rule

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- ruleName: string
  
  The IP firewall rule name
- ipFirewallRuleInfo: IpFirewallRuleInfo
  
  IP firewall rule properties
- Optional options: IpFirewallRulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<IpFirewallRulesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesDeleteOptionalParams): Promise<PollerLike<PollOperationState<IpFirewallRulesDeleteResponse>, IpFirewallRulesDeleteResponse>>

- Defined in operationsInterfaces/ipFirewallRules.ts:81
Deletes a firewall rule

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- ruleName: string
  
  The IP firewall rule name
- Optional options: IpFirewallRulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<IpFirewallRulesDeleteResponse>, IpFirewallRulesDeleteResponse>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesDeleteOptionalParams): Promise<IpFirewallRulesDeleteResponse>

- Defined in operationsInterfaces/ipFirewallRules.ts:99
Deletes a firewall rule

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- ruleName: string
  
  The IP firewall rule name
- Optional options: IpFirewallRulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<IpFirewallRulesDeleteResponse>

beginReplaceAll

beginReplaceAll(resourceGroupName: string, workspaceName: string, request: ReplaceAllIpFirewallRulesRequest, options?: IpFirewallRulesReplaceAllOptionalParams): Promise<PollerLike<PollOperationState<IpFirewallRulesReplaceAllResponse>, IpFirewallRulesReplaceAllResponse>>

- Defined in operationsInterfaces/ipFirewallRules.ts:125
Replaces firewall rules

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- request: ReplaceAllIpFirewallRulesRequest
  
  Replace all IP firewall rules request
- Optional options: IpFirewallRulesReplaceAllOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<IpFirewallRulesReplaceAllResponse>, IpFirewallRulesReplaceAllResponse>>

beginReplaceAllAndWait

beginReplaceAllAndWait(resourceGroupName: string, workspaceName: string, request: ReplaceAllIpFirewallRulesRequest, options?: IpFirewallRulesReplaceAllOptionalParams): Promise<IpFirewallRulesReplaceAllResponse>

- Defined in operationsInterfaces/ipFirewallRules.ts:143
Replaces firewall rules

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- request: ReplaceAllIpFirewallRulesRequest
  
  Replace all IP firewall rules request
- Optional options: IpFirewallRulesReplaceAllOptionalParams
  
  The options parameters.
Returns Promise<IpFirewallRulesReplaceAllResponse>

get

get(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesGetOptionalParams): Promise<IpFirewallRulesGetResponse>

- Defined in operationsInterfaces/ipFirewallRules.ts:112
Get a firewall rule

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- ruleName: string
  
  The IP firewall rule name
- Optional options: IpFirewallRulesGetOptionalParams
  
  The options parameters.
Returns Promise<IpFirewallRulesGetResponse>

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: IpFirewallRulesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<IpFirewallRuleInfo>

- Defined in operationsInterfaces/ipFirewallRules.ts:34
Returns a list of firewall rules

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: IpFirewallRulesListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<IpFirewallRuleInfo>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

ruleName: string

ipFirewallRuleInfo: IpFirewallRuleInfo

Optional options: IpFirewallRulesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<IpFirewallRulesCreateOrUpdateResponse>, IpFirewallRulesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

ruleName: string

ipFirewallRuleInfo: IpFirewallRuleInfo

Optional options: IpFirewallRulesCreateOrUpdateOptionalParams

Returns Promise<IpFirewallRulesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

ruleName: string

Optional options: IpFirewallRulesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<IpFirewallRulesDeleteResponse>, IpFirewallRulesDeleteResponse>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

ruleName: string

Optional options: IpFirewallRulesDeleteOptionalParams

Returns Promise<IpFirewallRulesDeleteResponse>

beginReplaceAll

Parameters

resourceGroupName: string

workspaceName: string

request: ReplaceAllIpFirewallRulesRequest

Optional options: IpFirewallRulesReplaceAllOptionalParams

Returns Promise<PollerLike<PollOperationState<IpFirewallRulesReplaceAllResponse>, IpFirewallRulesReplaceAllResponse>>

beginReplaceAllAndWait

Parameters

resourceGroupName: string

workspaceName: string

request: ReplaceAllIpFirewallRulesRequest

Optional options: IpFirewallRulesReplaceAllOptionalParams

Returns Promise<IpFirewallRulesReplaceAllResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

ruleName: string

Optional options: IpFirewallRulesGetOptionalParams

Returns Promise<IpFirewallRulesGetResponse>

listByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

Optional options: IpFirewallRulesListByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<IpFirewallRuleInfo>