Container Registries - Validate

Serviço:

Azure Spring Apps

Versão da API:

2023-12-01

Verifique se as propriedades do registro de contêiner são válidas.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}/validate?api-version=2023-12-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
containerRegistryName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	O nome do registro de contêiner.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	O nome do recurso de serviço.
subscriptionId	path	True	string	Obtém a ID da assinatura que identifica exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
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
credentials	True	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	As credenciais do recurso de registro de contêiner.

Respostas

Nome	Tipo	Description
200 OK	ContainerRegistryValidateResult	Êxito. A resposta descreve o resultado da validação do registro de contêiner.
202 Accepted		Aceitado. A resposta indica que as propriedades do registro de contêiner estão sendo validadas. Cabeçalhos Location: string
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

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

ContainerRegistries_Validate

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry/validate?api-version=2023-12-01

{
  "credentials": {
    "type": "BasicAuth",
    "server": "myServer",
    "username": "myUsername",
    "password": "myPassword"
  }
}

Java

import com.azure.resourcemanager.appplatform.models.ContainerRegistryBasicCredentials;
import com.azure.resourcemanager.appplatform.models.ContainerRegistryProperties;

/**
 * Samples for ContainerRegistries Validate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ContainerRegistries_Validate.json
     */
    /**
     * Sample code: ContainerRegistries_Validate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void containerRegistriesValidate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getContainerRegistries().validate("myResourceGroup",
            "my-service", "my-container-registry",
            new ContainerRegistryProperties().withCredentials(new ContainerRegistryBasicCredentials()
                .withServer("myServer").withUsername("myUsername").withPassword("fakeTokenPlaceholder")),
            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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python container_registries_validate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.container_registries.begin_validate(
        resource_group_name="myResourceGroup",
        service_name="my-service",
        container_registry_name="my-container-registry",
        container_registry_properties={
            "credentials": {
                "password": "myPassword",
                "server": "myServer",
                "type": "BasicAuth",
                "username": "myUsername",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Validate.json
if __name__ == "__main__":
    main()

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 armappplatform_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/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Validate.json
func ExampleContainerRegistriesClient_BeginValidate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerRegistriesClient().BeginValidate(ctx, "myResourceGroup", "my-service", "my-container-registry", armappplatform.ContainerRegistryProperties{
		Credentials: &armappplatform.ContainerRegistryBasicCredentials{
			Type:     to.Ptr("BasicAuth"),
			Password: to.Ptr("myPassword"),
			Server:   to.Ptr("myServer"),
			Username: to.Ptr("myUsername"),
		},
	}, 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.ContainerRegistryValidateResult = armappplatform.ContainerRegistryValidateResult{
	// 	IsValid: to.Ptr(false),
	// 	Message: to.Ptr("Validate container registry failed. please check the properties first."),
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Check if the container registry properties are valid.
 *
 * @summary Check if the container registry properties are valid.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Validate.json
 */
async function containerRegistriesValidate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "my-service";
  const containerRegistryName = "my-container-registry";
  const containerRegistryProperties = {
    credentials: {
      type: "BasicAuth",
      password: "myPassword",
      server: "myServer",
      username: "myUsername",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.containerRegistries.beginValidateAndWait(
    resourceGroupName,
    serviceName,
    containerRegistryName,
    containerRegistryProperties,
  );
  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

{
  "isValid": false,
  "message": "Validate container registry failed. please check the properties first."
}

Código de status:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-12-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2023-12-01

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ContainerRegistryBasicCredentials	As propriedades básicas de autenticação para o recurso de registro de contêiner.
ContainerRegistryProperties	Conteúdo do recurso do Registro de Contêiner.
ContainerRegistryProvisioningState	Estado do Registro de Contêiner.
ContainerRegistryValidateResult	Resultado da validação para propriedades do registro de contêiner

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ContainerRegistryBasicCredentials

Objeto

As propriedades básicas de autenticação para o recurso de registro de contêiner.

Nome	Tipo	Description
password	string	A senha do Registro de Contêiner.
server	string	O servidor de logon do Registro de Contêiner.
type	string: BasicAuth	O tipo de credencial das credenciais do registro de contêiner.
username	string	O nome de usuário do Registro de Contêiner.

ContainerRegistryProperties

Objeto

Conteúdo do recurso do Registro de Contêiner.

Nome	Tipo	Description
credentials	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	As credenciais do recurso de registro de contêiner.
provisioningState	ContainerRegistryProvisioningState	Estado do Registro de Contêiner.

ContainerRegistryProvisioningState

Enumeração

Estado do Registro de Contêiner.

Valor	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ContainerRegistryValidateResult

Objeto

Resultado da validação para propriedades do registro de contêiner

Nome	Tipo	Description
isValid	boolean	Indicar se as propriedades do registro de contêiner são válidas
message	string	Mensagens de validação detalhadas.