Access Policies - Create Or Update

Tjänst:

Time Series Insights

API-version:

2020-05-15

Skapa eller uppdatera en åtkomstprincip i den angivna miljön.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies/{accessPolicyName}?api-version=2020-05-15

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accessPolicyName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Namnet på åtkomstprincipen.
environmentName	path	True	string	Namnet på time series insights-miljön som är associerad med den angivna resursgruppen.
resourceGroupName	path	True	string	Namnet på en Azure-resursgrupp.
subscriptionId	path	True	string	Azure-prenumerations-ID.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.

Begärandetext

Name	Typ	Description
properties.description	string	En beskrivning av åtkomstprincipen.
properties.principalObjectId	string	ObjectId för huvudkontot i Azure Active Directory.
properties.roles	AccessPolicyRole[]	Listan över roller som huvudnamnet tilldelas i miljön.

Svar

Name	Typ	Description
200 OK	AccessPolicyResource	Den befintliga åtkomstprincipdefinitionen har uppdaterats.
201 Created	AccessPolicyResource	Åtkomstprincipen har skapats.
Other Status Codes	CloudError	HTTP 400 (felaktig begäran): Begärandetexten för den angivna åtkomstprincipen är ogiltig. Mer information finns i felkoden och meddelandet i svaret.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

AccessPoliciesCreate

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/accessPolicies/ap1?api-version=2020-05-15

{
  "properties": {
    "principalObjectId": "aGuid",
    "roles": [
      "Reader"
    ],
    "description": "some description"
  }
}

Java

import com.azure.resourcemanager.timeseriesinsights.models.AccessPolicyRole;
import java.util.Arrays;

/**
 * Samples for AccessPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/
     * AccessPoliciesCreate.json
     */
    /**
     * Sample code: AccessPoliciesCreate.
     * 
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void
        accessPoliciesCreate(com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.accessPolicies().define("ap1").withExistingEnvironment("rg1", "env1").withPrincipalObjectId("aGuid")
            .withDescription("some description").withRoles(Arrays.asList(AccessPolicyRole.READER)).create();
    }
}

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

Go

package armtimeseriesinsights_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/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json
func ExampleAccessPoliciesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccessPoliciesClient().CreateOrUpdate(ctx, "rg1", "env1", "ap1", armtimeseriesinsights.AccessPolicyCreateOrUpdateParameters{
		Properties: &armtimeseriesinsights.AccessPolicyResourceProperties{
			Description:       to.Ptr("some description"),
			PrincipalObjectID: to.Ptr("aGuid"),
			Roles: []*armtimeseriesinsights.AccessPolicyRole{
				to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader)},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.AccessPolicyResource = armtimeseriesinsights.AccessPolicyResource{
	// 	Name: to.Ptr("ap1"),
	// 	Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/AccessPolicies"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1"),
	// 	Properties: &armtimeseriesinsights.AccessPolicyResourceProperties{
	// 		Description: to.Ptr("some description"),
	// 		PrincipalObjectID: to.Ptr("aGuid"),
	// 		Roles: []*armtimeseriesinsights.AccessPolicyRole{
	// 			to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader)},
	// 		},
	// 	}
}

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

Exempelsvar

Statuskod:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1",
  "name": "ap1",
  "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies",
  "properties": {
    "principalObjectId": "aGuid",
    "roles": [
      "Reader"
    ],
    "description": "some description"
  }
}

Statuskod:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1",
  "name": "ap1",
  "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies",
  "properties": {
    "principalObjectId": "aGuid",
    "roles": [
      "Reader"
    ],
    "description": "some description"
  }
}

Definitioner

Name	Description
AccessPolicyCreateOrUpdateParameters
AccessPolicyResource	En åtkomstprincip används för att ge användare och program åtkomst till miljön. Roller tilldelas till tjänstens huvudnamn i Azure Active Directory. Dessa roller definierar de åtgärder som huvudkontot kan utföra via TIME Series Insights-api:er för dataplanet.
AccessPolicyRole	Listan över roller som huvudnamnet tilldelas i miljön.
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.

AccessPolicyCreateOrUpdateParameters

Objekt

Name	Typ	Description
properties.description	string	En beskrivning av åtkomstprincipen.
properties.principalObjectId	string	ObjectId för huvudkontot i Azure Active Directory.
properties.roles	AccessPolicyRole[]	Listan över roller som huvudnamnet tilldelas i miljön.

AccessPolicyResource

Objekt

En åtkomstprincip används för att ge användare och program åtkomst till miljön. Roller tilldelas till tjänstens huvudnamn i Azure Active Directory. Dessa roller definierar de åtgärder som huvudkontot kan utföra via TIME Series Insights-api:er för dataplanet.

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.description	string	En beskrivning av åtkomstprincipen.
properties.principalObjectId	string	ObjectId för huvudkontot i Azure Active Directory.
properties.roles	AccessPolicyRole[]	Listan över roller som huvudnamnet tilldelas i miljön.
type	string	Resurstyp

AccessPolicyRole

Uppräkning

Listan över roller som huvudnamnet tilldelas i miljön.

Värde	Description
Reader
Contributor

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).