Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. signalr
  5. ServiceNetworkAcl

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.signalr.ServiceNetworkAcl

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages the Network ACL for a SignalR service.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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={
        "allowed_request_types": ["string"],
        "denied_request_types": ["string"],
    },
    signalr_service_id="string",
    private_endpoints=[{
        "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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure