1. Packages
  2. Azure Classic
  3. API Docs
  4. signalr
  5. ServiceNetworkAcl

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.signalr.ServiceNetworkAcl

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages the Network ACL for a SignalR service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleService = new azure.signalr.Service("example", {
        name: "example-signalr",
        location: example.location,
        resourceGroupName: example.name,
        sku: {
            name: "Standard_S1",
            capacity: 1,
        },
    });
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
        name: "example-vnet",
        resourceGroupName: example.name,
        location: example.location,
        addressSpaces: ["10.5.0.0/16"],
    });
    const exampleSubnet = new azure.network.Subnet("example", {
        name: "example-subnet",
        resourceGroupName: example.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.5.2.0/24"],
        enforcePrivateLinkEndpointNetworkPolicies: true,
    });
    const exampleEndpoint = new azure.privatelink.Endpoint("example", {
        name: "example-privateendpoint",
        resourceGroupName: example.name,
        location: example.location,
        subnetId: exampleSubnet.id,
        privateServiceConnection: {
            name: "psc-sig-test",
            isManualConnection: false,
            privateConnectionResourceId: exampleService.id,
            subresourceNames: ["signalr"],
        },
    });
    const exampleServiceNetworkAcl = new azure.signalr.ServiceNetworkAcl("example", {
        signalrServiceId: exampleService.id,
        defaultAction: "Deny",
        publicNetwork: {
            allowedRequestTypes: ["ClientConnection"],
        },
        privateEndpoints: [{
            id: exampleEndpoint.id,
            allowedRequestTypes: ["ServerConnection"],
        }],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service = azure.signalr.Service("example",
        name="example-signalr",
        location=example.location,
        resource_group_name=example.name,
        sku=azure.signalr.ServiceSkuArgs(
            name="Standard_S1",
            capacity=1,
        ))
    example_virtual_network = azure.network.VirtualNetwork("example",
        name="example-vnet",
        resource_group_name=example.name,
        location=example.location,
        address_spaces=["10.5.0.0/16"])
    example_subnet = azure.network.Subnet("example",
        name="example-subnet",
        resource_group_name=example.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.5.2.0/24"],
        enforce_private_link_endpoint_network_policies=True)
    example_endpoint = azure.privatelink.Endpoint("example",
        name="example-privateendpoint",
        resource_group_name=example.name,
        location=example.location,
        subnet_id=example_subnet.id,
        private_service_connection=azure.privatelink.EndpointPrivateServiceConnectionArgs(
            name="psc-sig-test",
            is_manual_connection=False,
            private_connection_resource_id=example_service.id,
            subresource_names=["signalr"],
        ))
    example_service_network_acl = azure.signalr.ServiceNetworkAcl("example",
        signalr_service_id=example_service.id,
        default_action="Deny",
        public_network=azure.signalr.ServiceNetworkAclPublicNetworkArgs(
            allowed_request_types=["ClientConnection"],
        ),
        private_endpoints=[azure.signalr.ServiceNetworkAclPrivateEndpointArgs(
            id=example_endpoint.id,
            allowed_request_types=["ServerConnection"],
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatelink"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/signalr"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := signalr.NewService(ctx, "example", &signalr.ServiceArgs{
    			Name:              pulumi.String("example-signalr"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku: &signalr.ServiceSkuArgs{
    				Name:     pulumi.String("Standard_S1"),
    				Capacity: pulumi.Int(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
    			Name:              pulumi.String("example-vnet"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.5.0.0/16"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
    			Name:               pulumi.String("example-subnet"),
    			ResourceGroupName:  example.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.5.2.0/24"),
    			},
    			EnforcePrivateLinkEndpointNetworkPolicies: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleEndpoint, err := privatelink.NewEndpoint(ctx, "example", &privatelink.EndpointArgs{
    			Name:              pulumi.String("example-privateendpoint"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			SubnetId:          exampleSubnet.ID(),
    			PrivateServiceConnection: &privatelink.EndpointPrivateServiceConnectionArgs{
    				Name:                        pulumi.String("psc-sig-test"),
    				IsManualConnection:          pulumi.Bool(false),
    				PrivateConnectionResourceId: exampleService.ID(),
    				SubresourceNames: pulumi.StringArray{
    					pulumi.String("signalr"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = signalr.NewServiceNetworkAcl(ctx, "example", &signalr.ServiceNetworkAclArgs{
    			SignalrServiceId: exampleService.ID(),
    			DefaultAction:    pulumi.String("Deny"),
    			PublicNetwork: &signalr.ServiceNetworkAclPublicNetworkArgs{
    				AllowedRequestTypes: pulumi.StringArray{
    					pulumi.String("ClientConnection"),
    				},
    			},
    			PrivateEndpoints: signalr.ServiceNetworkAclPrivateEndpointArray{
    				&signalr.ServiceNetworkAclPrivateEndpointArgs{
    					Id: exampleEndpoint.ID(),
    					AllowedRequestTypes: pulumi.StringArray{
    						pulumi.String("ServerConnection"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleService = new Azure.SignalR.Service("example", new()
        {
            Name = "example-signalr",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
            {
                Name = "Standard_S1",
                Capacity = 1,
            },
        });
    
        var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
        {
            Name = "example-vnet",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AddressSpaces = new[]
            {
                "10.5.0.0/16",
            },
        });
    
        var exampleSubnet = new Azure.Network.Subnet("example", new()
        {
            Name = "example-subnet",
            ResourceGroupName = example.Name,
            VirtualNetworkName = exampleVirtualNetwork.Name,
            AddressPrefixes = new[]
            {
                "10.5.2.0/24",
            },
            EnforcePrivateLinkEndpointNetworkPolicies = true,
        });
    
        var exampleEndpoint = new Azure.PrivateLink.Endpoint("example", new()
        {
            Name = "example-privateendpoint",
            ResourceGroupName = example.Name,
            Location = example.Location,
            SubnetId = exampleSubnet.Id,
            PrivateServiceConnection = new Azure.PrivateLink.Inputs.EndpointPrivateServiceConnectionArgs
            {
                Name = "psc-sig-test",
                IsManualConnection = false,
                PrivateConnectionResourceId = exampleService.Id,
                SubresourceNames = new[]
                {
                    "signalr",
                },
            },
        });
    
        var exampleServiceNetworkAcl = new Azure.SignalR.ServiceNetworkAcl("example", new()
        {
            SignalrServiceId = exampleService.Id,
            DefaultAction = "Deny",
            PublicNetwork = new Azure.SignalR.Inputs.ServiceNetworkAclPublicNetworkArgs
            {
                AllowedRequestTypes = new[]
                {
                    "ClientConnection",
                },
            },
            PrivateEndpoints = new[]
            {
                new Azure.SignalR.Inputs.ServiceNetworkAclPrivateEndpointArgs
                {
                    Id = exampleEndpoint.Id,
                    AllowedRequestTypes = new[]
                    {
                        "ServerConnection",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.signalr.Service;
    import com.pulumi.azure.signalr.ServiceArgs;
    import com.pulumi.azure.signalr.inputs.ServiceSkuArgs;
    import com.pulumi.azure.network.VirtualNetwork;
    import com.pulumi.azure.network.VirtualNetworkArgs;
    import com.pulumi.azure.network.Subnet;
    import com.pulumi.azure.network.SubnetArgs;
    import com.pulumi.azure.privatelink.Endpoint;
    import com.pulumi.azure.privatelink.EndpointArgs;
    import com.pulumi.azure.privatelink.inputs.EndpointPrivateServiceConnectionArgs;
    import com.pulumi.azure.signalr.ServiceNetworkAcl;
    import com.pulumi.azure.signalr.ServiceNetworkAclArgs;
    import com.pulumi.azure.signalr.inputs.ServiceNetworkAclPublicNetworkArgs;
    import com.pulumi.azure.signalr.inputs.ServiceNetworkAclPrivateEndpointArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .name("example-signalr")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku(ServiceSkuArgs.builder()
                    .name("Standard_S1")
                    .capacity(1)
                    .build())
                .build());
    
            var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
                .name("example-vnet")
                .resourceGroupName(example.name())
                .location(example.location())
                .addressSpaces("10.5.0.0/16")
                .build());
    
            var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
                .name("example-subnet")
                .resourceGroupName(example.name())
                .virtualNetworkName(exampleVirtualNetwork.name())
                .addressPrefixes("10.5.2.0/24")
                .enforcePrivateLinkEndpointNetworkPolicies(true)
                .build());
    
            var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()
                .name("example-privateendpoint")
                .resourceGroupName(example.name())
                .location(example.location())
                .subnetId(exampleSubnet.id())
                .privateServiceConnection(EndpointPrivateServiceConnectionArgs.builder()
                    .name("psc-sig-test")
                    .isManualConnection(false)
                    .privateConnectionResourceId(exampleService.id())
                    .subresourceNames("signalr")
                    .build())
                .build());
    
            var exampleServiceNetworkAcl = new ServiceNetworkAcl("exampleServiceNetworkAcl", ServiceNetworkAclArgs.builder()
                .signalrServiceId(exampleService.id())
                .defaultAction("Deny")
                .publicNetwork(ServiceNetworkAclPublicNetworkArgs.builder()
                    .allowedRequestTypes("ClientConnection")
                    .build())
                .privateEndpoints(ServiceNetworkAclPrivateEndpointArgs.builder()
                    .id(exampleEndpoint.id())
                    .allowedRequestTypes("ServerConnection")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleService:
        type: azure:signalr:Service
        name: example
        properties:
          name: example-signalr
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku:
            name: Standard_S1
            capacity: 1
      exampleVirtualNetwork:
        type: azure:network:VirtualNetwork
        name: example
        properties:
          name: example-vnet
          resourceGroupName: ${example.name}
          location: ${example.location}
          addressSpaces:
            - 10.5.0.0/16
      exampleSubnet:
        type: azure:network:Subnet
        name: example
        properties:
          name: example-subnet
          resourceGroupName: ${example.name}
          virtualNetworkName: ${exampleVirtualNetwork.name}
          addressPrefixes:
            - 10.5.2.0/24
          enforcePrivateLinkEndpointNetworkPolicies: true
      exampleEndpoint:
        type: azure:privatelink:Endpoint
        name: example
        properties:
          name: example-privateendpoint
          resourceGroupName: ${example.name}
          location: ${example.location}
          subnetId: ${exampleSubnet.id}
          privateServiceConnection:
            name: psc-sig-test
            isManualConnection: false
            privateConnectionResourceId: ${exampleService.id}
            subresourceNames:
              - signalr
      exampleServiceNetworkAcl:
        type: azure:signalr:ServiceNetworkAcl
        name: example
        properties:
          signalrServiceId: ${exampleService.id}
          defaultAction: Deny
          publicNetwork:
            allowedRequestTypes:
              - ClientConnection
          privateEndpoints:
            - id: ${exampleEndpoint.id}
              allowedRequestTypes:
                - ServerConnection
    

    Create ServiceNetworkAcl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServiceNetworkAcl(name: string, args: ServiceNetworkAclArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceNetworkAcl(resource_name: str,
                          args: ServiceNetworkAclArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceNetworkAcl(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          default_action: Optional[str] = None,
                          public_network: Optional[ServiceNetworkAclPublicNetworkArgs] = None,
                          signalr_service_id: Optional[str] = None,
                          private_endpoints: Optional[Sequence[ServiceNetworkAclPrivateEndpointArgs]] = None)
    func NewServiceNetworkAcl(ctx *Context, name string, args ServiceNetworkAclArgs, opts ...ResourceOption) (*ServiceNetworkAcl, error)
    public ServiceNetworkAcl(string name, ServiceNetworkAclArgs args, CustomResourceOptions? opts = null)
    public ServiceNetworkAcl(String name, ServiceNetworkAclArgs args)
    public ServiceNetworkAcl(String name, ServiceNetworkAclArgs args, CustomResourceOptions options)
    
    type: azure:signalr:ServiceNetworkAcl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ServiceNetworkAclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceNetworkAclArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceNetworkAclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceNetworkAclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceNetworkAclArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serviceNetworkAclResource = new Azure.SignalR.ServiceNetworkAcl("serviceNetworkAclResource", new()
    {
        DefaultAction = "string",
        PublicNetwork = new Azure.SignalR.Inputs.ServiceNetworkAclPublicNetworkArgs
        {
            AllowedRequestTypes = new[]
            {
                "string",
            },
            DeniedRequestTypes = new[]
            {
                "string",
            },
        },
        SignalrServiceId = "string",
        PrivateEndpoints = new[]
        {
            new Azure.SignalR.Inputs.ServiceNetworkAclPrivateEndpointArgs
            {
                Id = "string",
                AllowedRequestTypes = new[]
                {
                    "string",
                },
                DeniedRequestTypes = new[]
                {
                    "string",
                },
            },
        },
    });
    
    example, err := signalr.NewServiceNetworkAcl(ctx, "serviceNetworkAclResource", &signalr.ServiceNetworkAclArgs{
    	DefaultAction: pulumi.String("string"),
    	PublicNetwork: &signalr.ServiceNetworkAclPublicNetworkArgs{
    		AllowedRequestTypes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		DeniedRequestTypes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	SignalrServiceId: pulumi.String("string"),
    	PrivateEndpoints: signalr.ServiceNetworkAclPrivateEndpointArray{
    		&signalr.ServiceNetworkAclPrivateEndpointArgs{
    			Id: pulumi.String("string"),
    			AllowedRequestTypes: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			DeniedRequestTypes: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    })
    
    var serviceNetworkAclResource = new ServiceNetworkAcl("serviceNetworkAclResource", ServiceNetworkAclArgs.builder()
        .defaultAction("string")
        .publicNetwork(ServiceNetworkAclPublicNetworkArgs.builder()
            .allowedRequestTypes("string")
            .deniedRequestTypes("string")
            .build())
        .signalrServiceId("string")
        .privateEndpoints(ServiceNetworkAclPrivateEndpointArgs.builder()
            .id("string")
            .allowedRequestTypes("string")
            .deniedRequestTypes("string")
            .build())
        .build());
    
    service_network_acl_resource = azure.signalr.ServiceNetworkAcl("serviceNetworkAclResource",
        default_action="string",
        public_network=azure.signalr.ServiceNetworkAclPublicNetworkArgs(
            allowed_request_types=["string"],
            denied_request_types=["string"],
        ),
        signalr_service_id="string",
        private_endpoints=[azure.signalr.ServiceNetworkAclPrivateEndpointArgs(
            id="string",
            allowed_request_types=["string"],
            denied_request_types=["string"],
        )])
    
    const serviceNetworkAclResource = new azure.signalr.ServiceNetworkAcl("serviceNetworkAclResource", {
        defaultAction: "string",
        publicNetwork: {
            allowedRequestTypes: ["string"],
            deniedRequestTypes: ["string"],
        },
        signalrServiceId: "string",
        privateEndpoints: [{
            id: "string",
            allowedRequestTypes: ["string"],
            deniedRequestTypes: ["string"],
        }],
    });
    
    type: azure:signalr:ServiceNetworkAcl
    properties:
        defaultAction: string
        privateEndpoints:
            - allowedRequestTypes:
                - string
              deniedRequestTypes:
                - string
              id: string
        publicNetwork:
            allowedRequestTypes:
                - string
            deniedRequestTypes:
                - string
        signalrServiceId: string
    

    ServiceNetworkAcl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ServiceNetworkAcl resource accepts the following input properties:

    DefaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    PublicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    SignalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    PrivateEndpoints List<ServiceNetworkAclPrivateEndpoint>
    A private_endpoint block as defined below.
    DefaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    PublicNetwork ServiceNetworkAclPublicNetworkArgs
    A public_network block as defined below.
    SignalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    PrivateEndpoints []ServiceNetworkAclPrivateEndpointArgs
    A private_endpoint block as defined below.
    defaultAction String
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    publicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    signalrServiceId String
    The ID of the SignalR service. Changing this forces a new resource to be created.
    privateEndpoints List<ServiceNetworkAclPrivateEndpoint>
    A private_endpoint block as defined below.
    defaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    publicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    signalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    privateEndpoints ServiceNetworkAclPrivateEndpoint[]
    A private_endpoint block as defined below.
    default_action str
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    public_network ServiceNetworkAclPublicNetworkArgs
    A public_network block as defined below.
    signalr_service_id str
    The ID of the SignalR service. Changing this forces a new resource to be created.
    private_endpoints Sequence[ServiceNetworkAclPrivateEndpointArgs]
    A private_endpoint block as defined below.
    defaultAction String
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    publicNetwork Property Map
    A public_network block as defined below.
    signalrServiceId String
    The ID of the SignalR service. Changing this forces a new resource to be created.
    privateEndpoints List<Property Map>
    A private_endpoint block as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServiceNetworkAcl resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceNetworkAcl Resource

    Get an existing ServiceNetworkAcl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceNetworkAclState, opts?: CustomResourceOptions): ServiceNetworkAcl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_action: Optional[str] = None,
            private_endpoints: Optional[Sequence[ServiceNetworkAclPrivateEndpointArgs]] = None,
            public_network: Optional[ServiceNetworkAclPublicNetworkArgs] = None,
            signalr_service_id: Optional[str] = None) -> ServiceNetworkAcl
    func GetServiceNetworkAcl(ctx *Context, name string, id IDInput, state *ServiceNetworkAclState, opts ...ResourceOption) (*ServiceNetworkAcl, error)
    public static ServiceNetworkAcl Get(string name, Input<string> id, ServiceNetworkAclState? state, CustomResourceOptions? opts = null)
    public static ServiceNetworkAcl get(String name, Output<String> id, ServiceNetworkAclState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    PrivateEndpoints List<ServiceNetworkAclPrivateEndpoint>
    A private_endpoint block as defined below.
    PublicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    SignalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    DefaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    PrivateEndpoints []ServiceNetworkAclPrivateEndpointArgs
    A private_endpoint block as defined below.
    PublicNetwork ServiceNetworkAclPublicNetworkArgs
    A public_network block as defined below.
    SignalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    defaultAction String
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    privateEndpoints List<ServiceNetworkAclPrivateEndpoint>
    A private_endpoint block as defined below.
    publicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    signalrServiceId String
    The ID of the SignalR service. Changing this forces a new resource to be created.
    defaultAction string
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    privateEndpoints ServiceNetworkAclPrivateEndpoint[]
    A private_endpoint block as defined below.
    publicNetwork ServiceNetworkAclPublicNetwork
    A public_network block as defined below.
    signalrServiceId string
    The ID of the SignalR service. Changing this forces a new resource to be created.
    default_action str
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    private_endpoints Sequence[ServiceNetworkAclPrivateEndpointArgs]
    A private_endpoint block as defined below.
    public_network ServiceNetworkAclPublicNetworkArgs
    A public_network block as defined below.
    signalr_service_id str
    The ID of the SignalR service. Changing this forces a new resource to be created.
    defaultAction String
    The default action to control the network access when no other rule matches. Possible values are Allow and Deny.
    privateEndpoints List<Property Map>
    A private_endpoint block as defined below.
    publicNetwork Property Map
    A public_network block as defined below.
    signalrServiceId String
    The ID of the SignalR service. Changing this forces a new resource to be created.

    Supporting Types

    ServiceNetworkAclPrivateEndpoint, ServiceNetworkAclPrivateEndpointArgs

    Id string
    The ID of the Private Endpoint which is based on the SignalR service.
    AllowedRequestTypes List<string>

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    DeniedRequestTypes List<string>

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    Id string
    The ID of the Private Endpoint which is based on the SignalR service.
    AllowedRequestTypes []string

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    DeniedRequestTypes []string

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    id String
    The ID of the Private Endpoint which is based on the SignalR service.
    allowedRequestTypes List<String>

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes List<String>

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    id string
    The ID of the Private Endpoint which is based on the SignalR service.
    allowedRequestTypes string[]

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes string[]

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    id str
    The ID of the Private Endpoint which is based on the SignalR service.
    allowed_request_types Sequence[str]

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    denied_request_types Sequence[str]

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    id String
    The ID of the Private Endpoint which is based on the SignalR service.
    allowedRequestTypes List<String>

    The allowed request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes List<String>

    The denied request types for the Private Endpoint Connection. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    ServiceNetworkAclPublicNetwork, ServiceNetworkAclPublicNetworkArgs

    AllowedRequestTypes List<string>

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    DeniedRequestTypes List<string>

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    AllowedRequestTypes []string

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    DeniedRequestTypes []string

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    allowedRequestTypes List<String>

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes List<String>

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    allowedRequestTypes string[]

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes string[]

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    allowed_request_types Sequence[str]

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    denied_request_types Sequence[str]

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    allowedRequestTypes List<String>

    The allowed request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Allow, allowed_request_typescannot be set.

    deniedRequestTypes List<String>

    The denied request types for the public network. Possible values are ClientConnection, ServerConnection, RESTAPI and Trace.

    Note: When default_action is Deny, denied_request_typescannot be set.

    Note: allowed_request_types - (Optional) and denied_request_types cannot be set together.

    Import

    Network ACLs for a SignalR service can be imported using the resource id, e.g.

    $ pulumi import azure:signalr/serviceNetworkAcl:ServiceNetworkAcl example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/signalR/signalr1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi