Scope Maps - Create

Referência

Serviço:: Container Registry

Versão da API:: 2023-01-01-preview

Cria um mapa de escopo para um registro de contêiner com os parâmetros especificados.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}?api-version=2023-01-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	O nome do registro de contêiner.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scopeMapName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9-_]*$	O nome do mapa de escopo.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.actions	True	string[]	A lista de permissões com escopo para artefatos do Registro. Por exemplo, repositórios/repositório-name/content/read, repositórios/repositório-name/metadados/write
properties.description		string	A descrição amigável do mapa de escopo.

Respostas

Nome	Tipo	Description
200 OK	ScopeMap	A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.
201 Created	ScopeMap	A solicitação foi bem-sucedida; a operação será concluída de forma assíncrona. Cabeçalhos Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou. Se qualquer um dos parâmetros de entrada for inválido, 400 (Solicitação Incorreta) serão retornados. Se a solicitação não puder ser processada devido a um conflito na solicitação, 409 (Conflito) serão retornados.

Nome

Tipo

Description

200 OK

ScopeMap

A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.

201 Created

ScopeMap

A solicitação foi bem-sucedida; a operação será concluída de forma assíncrona.

Cabeçalhos

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou. Se qualquer um dos parâmetros de entrada for inválido, 400 (Solicitação Incorreta) serão retornados. Se a solicitação não puder ser processada devido a um conflito na solicitação, 409 (Conflito) serão retornados.

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

ScopeMapCreate

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap?api-version=2023-01-01-preview

{
  "properties": {
    "description": "Developer Scopes",
    "actions": [
      "repositories/myrepository/contentWrite",
      "repositories/myrepository/delete"
    ]
  }
}

package armcontainerregistry_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/containerregistry/armcontainerregistry"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapCreate.json
func ExampleScopeMapsClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewScopeMapsClient().BeginCreate(ctx, "myResourceGroup", "myRegistry", "myScopeMap", armcontainerregistry.ScopeMap{
		Properties: &armcontainerregistry.ScopeMapProperties{
			Description: to.Ptr("Developer Scopes"),
			Actions: []*string{
				to.Ptr("repositories/myrepository/contentWrite"),
				to.Ptr("repositories/myrepository/delete")},
		},
	}, 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.ScopeMap = armcontainerregistry.ScopeMap{
	// 	Name: to.Ptr("myScopeMap"),
	// 	Type: to.Ptr("Microsoft.ContainerRegistry/registries/scopeMaps"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap"),
	// 	Properties: &armcontainerregistry.ScopeMapProperties{
	// 		Type: to.Ptr("IsUserDefined"),
	// 		Actions: []*string{
	// 			to.Ptr("repositories/myrepository/contentWrite"),
	// 			to.Ptr("repositories/myrepository/delete")},
	// 			CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-01T23:14:37.0707808Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armcontainerregistry.ProvisioningStateSucceeded),
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Creates a scope map for a container registry with the specified parameters.
 *
 * @summary Creates a scope map for a container registry with the specified parameters.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapCreate.json
 */
async function scopeMapCreate() {
  const subscriptionId =
    process.env["CONTAINERREGISTRY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERREGISTRY_RESOURCE_GROUP"] || "myResourceGroup";
  const registryName = "myRegistry";
  const scopeMapName = "myScopeMap";
  const scopeMapCreateParameters = {
    description: "Developer Scopes",
    actions: ["repositories/myrepository/contentWrite", "repositories/myrepository/delete"],
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const result = await client.scopeMaps.beginCreateAndWait(
    resourceGroupName,
    registryName,
    scopeMapName,
    scopeMapCreateParameters
  );
  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

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
  "name": "myScopeMap",
  "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
  "properties": {
    "creationDate": "2017-03-01T23:14:37.0707808Z",
    "type": "IsUserDefined",
    "actions": [
      "repositories/myrepository/contentWrite",
      "repositories/myrepository/delete"
    ],
    "provisioningState": "Succeeded"
  }
}

Código de status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
  "name": "myScopeMap",
  "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
  "properties": {
    "creationDate": "2017-03-01T23:14:37.0707808Z",
    "type": "IsUserDefined",
    "actions": [
      "repositories/myrepository/contentWrite",
      "repositories/myrepository/delete"
    ],
    "provisioningState": "Succeeded"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Uma resposta de erro do serviço registro de contêiner do Azure.
ErrorResponseBody	Uma resposta de erro do serviço registro de contêiner do Azure.
InnerErrorDescription	erro interno.
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
ProvisioningState	Estado de provisionamento do recurso.
ScopeMap	Um objeto que representa um mapa de escopo para um registro de contêiner.
SystemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorResponse

Objeto

Uma resposta de erro do serviço registro de contêiner do Azure.

Nome	Tipo	Description
error	ErrorResponseBody	Corpo de erro da API de build do Registro de Contêiner do Azure.

ErrorResponseBody

Objeto

Uma resposta de erro do serviço registro de contêiner do Azure.

Nome	Tipo	Description
code	string	código de erro.
details	InnerErrorDescription[]	uma matriz de objetos de informações de resposta de erro aninhados adicionais, conforme descrito por este contrato.
message	string	Mensagem de erro.
target	string	destino do erro específico.

InnerErrorDescription

Objeto

erro interno.

Nome	Tipo	Description
code	string	código de erro.
message	string	Mensagem de erro.
target	string	destino do erro específico.

lastModifiedByType

Enumeração

O tipo de identidade que modificou o recurso pela última vez.

Valor	Description
Application
Key
ManagedIdentity
User

ProvisioningState

Enumeração

Estado de provisionamento do recurso.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ScopeMap

Objeto

Um objeto que representa um mapa de escopo para um registro de contêiner.

Nome	Tipo	Description
id	string	A ID do recurso.
name	string	O nome do recurso.
properties.actions	string[]	A lista de permissões com escopo para artefatos do Registro. Por exemplo, repositórios/repositório-name/content/read, repositórios/repositório-name/metadados/write
properties.creationDate	string (date-time)	A data de criação do mapa de escopo.
properties.description	string	A descrição amigável do mapa de escopo.
properties.provisioningState	ProvisioningState	Estado de provisionamento do recurso.
properties.type	string	O tipo do mapa de escopo. Por exemplo, o mapa de escopo do BuildIn.
systemData	SystemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso.

SystemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da modificação de recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Scope Maps - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

ScopeMapCreate

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorResponse

ErrorResponseBody

InnerErrorDescription

lastModifiedByType

ProvisioningState

ScopeMap

SystemData