Workspaces - Set Firewall Rules

Service:
Core
API-versie:
v1

Hiermee stelt u de IP-firewallregels voor de werkruimte in. Met deze API kunnen werkruimtebeheerders IP-firewallregels instellen waarmee wordt bepaald welke IP-adressen verbinding mogen maken met de werkruimte. Deze functie is momenteel beschikbaar als preview-versie.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Note

Firewallregels worden alleen afgedwongen als het netwerkcommunicatiebeleid van de werkruimte inbound.publicAccessRules.defaultAction is ingesteld op Deny. Als openbare toegang niet wordt geblokkeerd in de werkruimte, worden API-aanroepen naar deze werkruimte niet beperkt.

Note

Deze API maakt gebruik van de PUT-methode en overschrijft alle IP-firewallregels voor de werkruimte. Voer Altijd Eerst ophalen uit en geef alle IP-firewallregels op in de aanvraagbody.

toestemmingen

De aanroeper moet beheerdersrol werkruimte hebben.

Vereiste gedelegeerde bevoegdheden

Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Ja
serviceprincipal en beheerde identiteiten Ja

Interface

PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/inbound/firewall

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string (uuid)

Unieke id van de werkruimte die moet worden bijgewerkt.

Aanvraagbody

Name Type Description
rules

FirewallRule[]

Een lijst met regels waarmee IP-adressen worden gedefinieerd die zijn toegestaan voor binnenkomende toegang. Elke regel kan een naam en één IP-adres, een IP-adresbereik of een CIDR-IP-adres bevatten. Er kunnen maximaal 256 regels per werkruimte worden opgegeven.

Antwoorden

Name Type Description
200 OK

De aanvraag is voltooid en bevat geen inhoud in de hoofdtekst van het antwoord.

Kopteksten:

ETagstring - De nieuwe ETag van de firewallconfiguratie na de update. Gebruik deze waarde in de header van If-Match een volgende PUT-aanroep om optimistisch gelijktijdigheidsbeheer toe te passen.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • UnknownError: er is een fout opgetreden.

Voorbeelden

Example for setting workspace firewall rules

Voorbeeldaanvraag

PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/inbound/firewall

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

Voorbeeldrespons

Statuscode:
204 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.
FirewallRule

Definieert een firewallregel, geïdentificeerd met de naam en met één IP-adres, een IP-adresbereik of een CIDR-IP-adres als waarde.
InboundFirewallConfiguration

Dit object definieert de volledige set firewallregels voor het beheren van binnenkomende toegangsbeveiliging als onderdeel van het netwerkcommunicatiebeleid van een werkruimte. Het zorgt ervoor dat alleen expliciet geautoriseerde IP-adressen zijn toegestaan voor binnenkomende communicatie. Wanneer het object wordt verzonden via de PUT-API, wordt de bestaande IP-firewallconfiguratie voor de werkruimte gemaakt of volledig vervangen. Deze regels worden alleen afgedwongen wanneer het netwerkcommunicatiebeleid van de werkruimte inbound.publicAccessRules.defaultAction is ingesteld op Deny.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-ID die betrokken is bij het probleem.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.

FirewallRule

Object

Definieert een firewallregel, geïdentificeerd met de naam en met één IP-adres, een IP-adresbereik of een CIDR-IP-adres als waarde.

Name Type Description
displayName

string

Hiermee geeft u de naam van de regel. Weergavenamen kunnen maximaal 128 tekens lang zijn en moeten uniek zijn per werkruimte.
value

string

Hiermee geeft u de waarde van de regel op, opgegeven als één IP-adres, een IP-adresbereik of een CIDR-IP-adres.

InboundFirewallConfiguration

Object

Dit object definieert de volledige set firewallregels voor het beheren van binnenkomende toegangsbeveiliging als onderdeel van het netwerkcommunicatiebeleid van een werkruimte. Het zorgt ervoor dat alleen expliciet geautoriseerde IP-adressen zijn toegestaan voor binnenkomende communicatie. Wanneer het object wordt verzonden via de PUT-API, wordt de bestaande IP-firewallconfiguratie voor de werkruimte gemaakt of volledig vervangen. Deze regels worden alleen afgedwongen wanneer het netwerkcommunicatiebeleid van de werkruimte inbound.publicAccessRules.defaultAction is ingesteld op Deny.

Name Type Description
rules

FirewallRule[]

Een lijst met regels waarmee IP-adressen worden gedefinieerd die zijn toegestaan voor binnenkomende toegang. Elke regel kan een naam en één IP-adres, een IP-adresbereik of een CIDR-IP-adres bevatten. Er kunnen maximaal 256 regels per werkruimte worden opgegeven.