Ip Firewall Rules - Replace All

Riferimento

Servizio:: Synapse

Versione API:: 2021-06-01

Sostituisce le regole del firewall

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/replaceAllIpFirewallRules?api-version=2021-06-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
workspaceName	path	True	string	Nome dell'area di lavoro.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
ipFirewallRules	<string, IpFirewallRuleProperties>	Proprietà della regola del firewall IP

Risposte

Nome	Tipo	Descrizione
200 OK	ReplaceAllFirewallRulesOperationResponse	Va bene
202 Accepted		Accettato
Other Status Codes	ErrorResponse

Esempio

Replace all IP firewall rules in a workspace

Esempio di richiesta

POST https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/replaceAllIpFirewallRules?api-version=2021-06-01

{
  "ipFirewallRules": {
    "ExampleFirewallRule": {
      "startIpAddress": "10.0.0.0",
      "endIpAddress": "10.0.0.254"
    },
    "AnotherExampleFirewallRule": {
      "startIpAddress": "10.0.1.0",
      "endIpAddress": "10.0.1.254"
    }
  }
}


import com.azure.resourcemanager.synapse.fluent.models.IpFirewallRuleProperties;
import com.azure.resourcemanager.synapse.models.ReplaceAllIpFirewallRulesRequest;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for IpFirewallRules ReplaceAll.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.
     * json
     */
    /**
     * Sample code: Replace all IP firewall rules in a workspace.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void replaceAllIPFirewallRulesInAWorkspace(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.ipFirewallRules().replaceAll("ExampleResourceGroup", "ExampleWorkspace",
            new ReplaceAllIpFirewallRulesRequest().withIpFirewallRules(mapOf("AnotherExampleFirewallRule",
                new IpFirewallRuleProperties().withEndIpAddress("10.0.1.254").withStartIpAddress("10.0.1.0"),
                "ExampleFirewallRule",
                new IpFirewallRuleProperties().withEndIpAddress("10.0.0.254").withStartIpAddress("10.0.0.0"))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python replace_all_ip_firewall_rules.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="01234567-89ab-4def-0123-456789abcdef",
    )

    response = client.ip_firewall_rules.begin_replace_all(
        resource_group_name="ExampleResourceGroup",
        workspace_name="ExampleWorkspace",
        request={
            "ipFirewallRules": {
                "AnotherExampleFirewallRule": {"endIpAddress": "10.0.1.254", "startIpAddress": "10.0.1.0"},
                "ExampleFirewallRule": {"endIpAddress": "10.0.0.254", "startIpAddress": "10.0.0.0"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.json
func ExampleIPFirewallRulesClient_BeginReplaceAll() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIPFirewallRulesClient().BeginReplaceAll(ctx, "ExampleResourceGroup", "ExampleWorkspace", armsynapse.ReplaceAllIPFirewallRulesRequest{
		IPFirewallRules: map[string]*armsynapse.IPFirewallRuleProperties{
			"AnotherExampleFirewallRule": {
				EndIPAddress:   to.Ptr("10.0.1.254"),
				StartIPAddress: to.Ptr("10.0.1.0"),
			},
			"ExampleFirewallRule": {
				EndIPAddress:   to.Ptr("10.0.0.254"),
				StartIPAddress: to.Ptr("10.0.0.0"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplaceAllFirewallRulesOperationResponse = armsynapse.ReplaceAllFirewallRulesOperationResponse{
	// 	OperationID: to.Ptr("00000000-1111-4444-2222-333333333333"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Replaces firewall rules
 *
 * @summary Replaces firewall rules
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.json
 */
async function replaceAllIPFirewallRulesInAWorkspace() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "01234567-89ab-4def-0123-456789abcdef";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "ExampleResourceGroup";
  const workspaceName = "ExampleWorkspace";
  const request = {
    ipFirewallRules: {
      anotherExampleFirewallRule: {
        endIpAddress: "10.0.1.254",
        startIpAddress: "10.0.1.0",
      },
      exampleFirewallRule: {
        endIpAddress: "10.0.0.254",
        startIpAddress: "10.0.0.0",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.ipFirewallRules.beginReplaceAllAndWait(
    resourceGroupName,
    workspaceName,
    request
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Net;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.json
// this example is just showing the usage of "IpFirewallRules_ReplaceAll" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseWorkspaceResource created on azure
// for more information of creating SynapseWorkspaceResource, please refer to the document of SynapseWorkspaceResource
string subscriptionId = "01234567-89ab-4def-0123-456789abcdef";
string resourceGroupName = "ExampleResourceGroup";
string workspaceName = "ExampleWorkspace";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// invoke the operation
ReplaceAllIPFirewallRulesContent content = new ReplaceAllIPFirewallRulesContent
{
    IPFirewallRules =
    {
    ["AnotherExampleFirewallRule"] = new SynapseIPFirewallRuleProperties
    {
    EndIPAddress = IPAddress.Parse("10.0.1.254"),
    StartIPAddress = IPAddress.Parse("10.0.1.0"),
    },
    ["ExampleFirewallRule"] = new SynapseIPFirewallRuleProperties
    {
    EndIPAddress = IPAddress.Parse("10.0.0.254"),
    StartIPAddress = IPAddress.Parse("10.0.0.0"),
    }
    },
};
ArmOperation<ReplaceAllFirewallRulesOperationResult> lro = await synapseWorkspace.ReplaceAllIpFirewallRuleAsync(WaitUntil.Completed, content);
ReplaceAllFirewallRulesOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "operationId": "00000000-1111-4444-2222-333333333333"
}

Codice di stato:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Synapse/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2021-06-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Synapse/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2021-06-01

Codice di stato:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
IpFirewallRuleProperties	Proprietà della regola del firewall IP
ProvisioningState	Stato del provisioning delle risorse
ReplaceAllFirewallRulesOperationResponse	Operazione esistente per la sostituzione delle regole del firewall
ReplaceAllIpFirewallRulesRequest	Sostituire tutte le richieste di regole del firewall IP

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IpFirewallRuleProperties

Object

Proprietà della regola del firewall IP

Nome	Tipo	Descrizione
endIpAddress	string	Indirizzo IP finale della regola del firewall. Deve essere formato IPv4. Deve essere maggiore o uguale a startIpAddress
provisioningState	ProvisioningState	Stato del provisioning delle risorse
startIpAddress	string	Indirizzo IP iniziale della regola del firewall. Deve essere formato IPv4

ProvisioningState

Enumerazione

Stato del provisioning delle risorse

Valore	Descrizione
DeleteError
Deleting
Failed
Provisioning
Succeeded

ReplaceAllFirewallRulesOperationResponse

Object

Operazione esistente per la sostituzione delle regole del firewall

Nome	Tipo	Descrizione
operationId	string	ID operazione

ReplaceAllIpFirewallRulesRequest

Object

Sostituire tutte le richieste di regole del firewall IP

Nome	Tipo	Descrizione
ipFirewallRules	<string, IpFirewallRuleProperties>	Proprietà della regola del firewall IP