Container Registries - Validate

Service:

Azure Spring Apps

API-versie:

2023-12-01

Controleer of de eigenschappen van het containerregister geldig zijn.

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

URI-parameters

Name	In	Vereist	Type	Description
containerRegistryName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	De naam van het containerregister.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	De naam van de serviceresource.
subscriptionId	path	True	string	Hiermee haalt u de abonnements-id op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
credentials	True	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	De referenties van de containerregisterresource.

Antwoorden

Name	Type	Description
200 OK	ContainerRegistryValidateResult	Succes. In het antwoord wordt het validatieresultaat van het containerregister beschreven.
202 Accepted		Geaccepteerd. Het antwoord geeft aan dat de eigenschappen van het containerregister worden geverifieerd. Kopteksten Location: string
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

ContainerRegistries_Validate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
ContainerRegistryBasicCredentials	De basisverificatie-eigenschappen voor de containerregisterresource.
ContainerRegistryProperties	Nettolading van containerregisterresources.
ContainerRegistryProvisioningState	Status van het containerregister.
ContainerRegistryValidateResult	Validatieresultaat voor eigenschappen van containerregister

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

ContainerRegistryBasicCredentials

Object

De basisverificatie-eigenschappen voor de containerregisterresource.

Name	Type	Description
password	string	Het wachtwoord van het Container Registry.
server	string	De aanmeldingsserver van het Container Registry.
type	string: BasicAuth	Het referentietype van de referenties van het containerregister.
username	string	De gebruikersnaam van het Container Registry.

ContainerRegistryProperties

Object

Nettolading van containerregisterresources.

Name	Type	Description
credentials	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	De referenties van de containerregisterresource.
provisioningState	ContainerRegistryProvisioningState	Status van het containerregister.

ContainerRegistryProvisioningState

Opsomming

Status van het containerregister.

Waarde	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ContainerRegistryValidateResult

Object

Validatieresultaat voor eigenschappen van containerregister

Name	Type	Description
isValid	boolean	Geef aan of de eigenschappen van het containerregister geldig zijn
message	string	Gedetailleerde validatieberichten.