Jit Network Access Policies - Initiate

Referentie

Service:: Defender for Cloud

API-versie:: 2020-01-01

Start een JIT-toegang vanuit een specifieke Just-In-Time-beleidsconfiguratie.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}/initiate?api-version=2020-01-01

URI-parameters

Name	In	Vereist	Type	Description
ascLocation	path	True	string	De locatie waar ASC de gegevens van het abonnement opslaat. kan worden opgehaald uit Get-locaties
jitNetworkAccessPolicyInitiateType	path	True	JitNetworkAccessPolicyInitiateType	Type van de actie die moet worden uitgevoerd op het Just-In-Time-toegangsbeleid.
jitNetworkAccessPolicyName	path	True	string	Naam van een Just-In-Time-toegangsconfiguratiebeleid.
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig. Regex-patroon: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure-abonnements-id Regex-patroon: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API-versie voor de bewerking

Aanvraagbody

Name	Vereist	Type	Description
virtualMachines	True	JitNetworkAccessPolicyInitiateVirtualMachine[]	Een lijst met virtuele machines & poorten om toegang te openen voor
justification		string	De reden voor het indienen van de initieeraanvraag

Antwoorden

Name	Type	Description
202 Accepted	JitNetworkAccessRequest	Geaccepteerd
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Initiate an action on a JIT network access policy

Voorbeeldaanvraag

POST https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default/initiate?api-version=2020-01-01

{
  "virtualMachines": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
      "ports": [
        {
          "number": 3389,
          "duration": "PT1H",
          "allowedSourceAddressPrefix": "192.127.0.2"
        }
      ]
    }
  ],
  "justification": "testing a new version of the product"
}


import com.azure.resourcemanager.security.models.JitNetworkAccessPolicyInitiatePort;
import com.azure.resourcemanager.security.models.JitNetworkAccessPolicyInitiateRequest;
import com.azure.resourcemanager.security.models.JitNetworkAccessPolicyInitiateVirtualMachine;
import java.util.Arrays;

/**
 * Samples for JitNetworkAccessPolicies Initiate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/JitNetworkAccessPolicies/
     * InitiateJitNetworkAccessPolicy_example.json
     */
    /**
     * Sample code: Initiate an action on a JIT network access policy.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        initiateAnActionOnAJITNetworkAccessPolicy(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.jitNetworkAccessPolicies().initiateWithResponse("myRg1", "westeurope", "default",
            new JitNetworkAccessPolicyInitiateRequest()
                .withVirtualMachines(Arrays.asList(new JitNetworkAccessPolicyInitiateVirtualMachine().withId(
                    "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1")
                    .withPorts(Arrays.asList(new JitNetworkAccessPolicyInitiatePort().withNumber(3389)
                        .withAllowedSourceAddressPrefix("192.127.0.2")))))
                .withJustification("testing a new version of the product"),
            com.azure.core.util.Context.NONE);
    }
}

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

package armsecurity_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/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json
func ExampleJitNetworkAccessPoliciesClient_Initiate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewJitNetworkAccessPoliciesClient().Initiate(ctx, "myRg1", "westeurope", "default", armsecurity.JitNetworkAccessPolicyInitiateRequest{
		Justification: to.Ptr("testing a new version of the product"),
		VirtualMachines: []*armsecurity.JitNetworkAccessPolicyInitiateVirtualMachine{
			{
				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1"),
				Ports: []*armsecurity.JitNetworkAccessPolicyInitiatePort{
					{
						AllowedSourceAddressPrefix: to.Ptr("192.127.0.2"),
						Number:                     to.Ptr[int32](3389),
					}},
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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

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

/**
 * This sample demonstrates how to Initiate a JIT access from a specific Just-in-Time policy configuration.
 *
 * @summary Initiate a JIT access from a specific Just-in-Time policy configuration.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json
 */
async function initiateAnActionOnAJitNetworkAccessPolicy() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "myRg1";
  const ascLocation = "westeurope";
  const jitNetworkAccessPolicyName = "default";
  const body = {
    justification: "testing a new version of the product",
    virtualMachines: [
      {
        id: "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
        ports: [
          { allowedSourceAddressPrefix: "192.127.0.2", number: 3389, endTimeUtc: new Date() },
        ],
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.jitNetworkAccessPolicies.initiate(
    resourceGroupName,
    ascLocation,
    jitNetworkAccessPolicyName,
    body,
  );
  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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json
// this example is just showing the usage of "JitNetworkAccessPolicies_Initiate" 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 JitNetworkAccessPolicyResource created on azure
// for more information of creating JitNetworkAccessPolicyResource, please refer to the document of JitNetworkAccessPolicyResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string resourceGroupName = "myRg1";
AzureLocation ascLocation = new AzureLocation("westeurope");
string jitNetworkAccessPolicyName = "default";
ResourceIdentifier jitNetworkAccessPolicyResourceId = JitNetworkAccessPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ascLocation, jitNetworkAccessPolicyName);
JitNetworkAccessPolicyResource jitNetworkAccessPolicy = client.GetJitNetworkAccessPolicyResource(jitNetworkAccessPolicyResourceId);

// invoke the operation
JitNetworkAccessPolicyInitiateContent content = new JitNetworkAccessPolicyInitiateContent(new JitNetworkAccessPolicyInitiateVirtualMachine[]
{
new JitNetworkAccessPolicyInitiateVirtualMachine(new ResourceIdentifier("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1"),new JitNetworkAccessPolicyInitiatePort[]
{
new JitNetworkAccessPolicyInitiatePort(3389,DateTimeOffset.Parse("placeholder"))
{
AllowedSourceAddressPrefix = "192.127.0.2",
}
})
})
{
    Justification = "testing a new version of the product",
};
JitNetworkAccessRequestInfo result = await jitNetworkAccessPolicy.InitiateAsync(content);

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

Voorbeeldrespons

Statuscode:: 202

{
  "virtualMachines": [
    {
      "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1",
      "ports": [
        {
          "number": 3389,
          "allowedSourceAddressPrefix": "192.127.0.2",
          "endTimeUtc": "2018-07-12T09:53:03.3658798Z",
          "status": "Initiating",
          "statusReason": "UserRequested"
        }
      ]
    }
  ],
  "startTimeUtc": "2018-07-12T08:53:03.3658798Z",
  "requestor": "barbara@contoso.com",
  "justification": "testing a new version of the product"
}

Definities

Name	Description
CloudError	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
CloudErrorBody	De foutdetails.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
JitNetworkAccessPolicyInitiatePort
JitNetworkAccessPolicyInitiateRequest
JitNetworkAccessPolicyInitiateType	Type van de actie die moet worden uitgevoerd op het Just-In-Time-toegangsbeleid.
JitNetworkAccessPolicyInitiateVirtualMachine
JitNetworkAccessRequest
JitNetworkAccessRequestPort
JitNetworkAccessRequestVirtualMachine
status	De status van de poort
statusReason	Een beschrijving van de reden waarom de `status` de waarde heeft

CloudError

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
error.code	string	De foutcode.
error.details	CloudErrorBody[]	De foutdetails.
error.message	string	Het foutbericht.
error.target	string	Het foutdoel.

CloudErrorBody

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	CloudErrorBody[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

JitNetworkAccessPolicyInitiatePort

Name	Type	Description
allowedSourceAddressPrefix	string	Bron van het toegestane verkeer. Als u dit weglaat, is de aanvraag voor het bron-IP-adres van de initieeraanvraag.
endTimeUtc	string	De tijd voor het sluiten van de aanvraag in UTC
number	integer

JitNetworkAccessPolicyInitiateRequest

Name	Type	Description
justification	string	De reden voor het indienen van de initieeraanvraag
virtualMachines	JitNetworkAccessPolicyInitiateVirtualMachine[]	Een lijst met virtuele machines & poorten om toegang te openen voor

JitNetworkAccessPolicyInitiateType

Type van de actie die moet worden uitgevoerd op het Just-In-Time-toegangsbeleid.

Name	Type	Description
initiate	string

JitNetworkAccessPolicyInitiateVirtualMachine

Name	Type	Description
id	string	Resource-id van de virtuele machine die is gekoppeld aan dit beleid
ports	JitNetworkAccessPolicyInitiatePort[]	De poorten die moeten worden geopend voor de resource met de `id`

JitNetworkAccessRequest

Name	Type	Description
justification	string	De reden voor het indienen van de initieeraanvraag
requestor	string	De identiteit van de persoon die het verzoek heeft ingediend
startTimeUtc	string	De begintijd van de aanvraag in UTC
virtualMachines	JitNetworkAccessRequestVirtualMachine[]

JitNetworkAccessRequestPort

Name	Type	Description
allowedSourceAddressPrefix	string	Wederzijds exclusief met de parameter allowedSourceAddressPrefixes. Moet een IP-adres of CIDR zijn, bijvoorbeeld '192.168.0.3' of '192.168.0.0/16'.
allowedSourceAddressPrefixes	string[]	Sluiten elkaar wederzijds uit met de parameter allowedSourceAddressPrefix.
endTimeUtc	string	De datum & tijdstip waarop de aanvraag eindigt in UTC
mappedPort	integer	De poort die is toegewezen aan de `number` van deze poort in de Azure Firewall, indien van toepassing
number	integer
status	status	De status van de poort
statusReason	statusReason	Een beschrijving van de reden waarom de `status` de waarde heeft

JitNetworkAccessRequestVirtualMachine

Name	Type	Description
id	string	Resource-id van de virtuele machine die is gekoppeld aan dit beleid
ports	JitNetworkAccessRequestPort[]	De poorten die zijn geopend voor de virtuele machine

status

De status van de poort

Name	Type	Description
Initiated	string
Revoked	string

statusReason

Een beschrijving van de reden waarom de status de waarde heeft

Name	Type	Description
Expired	string
NewerRequestInitiated	string
UserRequested	string

Delen via

Jit Network Access Policies - Initiate

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Initiate an action on a JIT network access policy

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CloudError

CloudErrorBody

ErrorAdditionalInfo

JitNetworkAccessPolicyInitiatePort

JitNetworkAccessPolicyInitiateRequest

JitNetworkAccessPolicyInitiateType

JitNetworkAccessPolicyInitiateVirtualMachine

JitNetworkAccessRequest

JitNetworkAccessRequestPort

JitNetworkAccessRequestVirtualMachine

status

statusReason

Aanvullende resources