Access Policies - Create Or Update

Serviço:

Time Series Insights

Versão da API:

2020-05-15

Crie ou atualize uma política de acesso no ambiente especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accessPolicyName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nome da política de acesso.
environmentName	path	True	string	O nome do ambiente do Time Series Insights associado ao grupo de recursos especificado.
resourceGroupName	path	True	string	Nome de um grupo de recursos do Azure.
subscriptionId	path	True	string	ID da Assinatura do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.description	string	Uma descrição da política de acesso.
properties.principalObjectId	string	A objectId da entidade de segurança no Azure Active Directory.
properties.roles	AccessPolicyRole[]	A lista de funções que a entidade de segurança recebe no ambiente.

Respostas

Nome	Tipo	Description
200 OK	AccessPolicyResource	A definição da política de acesso existente foi atualizada com êxito.
201 Created	AccessPolicyResource	A política de acesso foi criada com êxito.
Other Status Codes	CloudError	HTTP 400 (Solicitação Incorreta): o corpo da solicitação de política de acesso fornecida é inválido; Consulte o código de erro e a mensagem na resposta para obter detalhes.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

AccessPoliciesCreate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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"
  }
}

Código de status:

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"
  }
}

Definições

Nome	Description
AccessPolicyCreateOrUpdateParameters
AccessPolicyResource	Uma política de acesso é usada para conceder aos usuários e aplicativos acesso ao ambiente. As funções são atribuídas a entidades de serviço no Azure Active Directory. Essas funções definem as ações que a entidade de segurança pode executar por meio das APIs do plano de dados do Time Series Insights.
AccessPolicyRole	A lista de funções que a entidade de segurança recebe no ambiente.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

AccessPolicyCreateOrUpdateParameters

Objeto

Nome	Tipo	Description
properties.description	string	Uma descrição da política de acesso.
properties.principalObjectId	string	A objectId da entidade de segurança no Azure Active Directory.
properties.roles	AccessPolicyRole[]	A lista de funções que a entidade de segurança recebe no ambiente.

AccessPolicyResource

Objeto

Uma política de acesso é usada para conceder aos usuários e aplicativos acesso ao ambiente. As funções são atribuídas a entidades de serviço no Azure Active Directory. Essas funções definem as ações que a entidade de segurança pode executar por meio das APIs do plano de dados do Time Series Insights.

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.description	string	Uma descrição da política de acesso.
properties.principalObjectId	string	A objectId da entidade de segurança no Azure Active Directory.
properties.roles	AccessPolicyRole[]	A lista de funções que a entidade de segurança recebe no ambiente.
type	string	Tipo de recurso

AccessPolicyRole

Enumeração

A lista de funções que a entidade de segurança recebe no ambiente.

Valor	Description
Contributor
Reader

CloudError

Objeto

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

CloudErrorBody

Objeto

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).