Container Registries - Validate

服务:

Azure Spring Apps

API 版本:

2023-12-01

检查容器注册表属性是否有效。

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

URI 参数

名称	在	必需	类型	说明
containerRegistryName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	容器注册表的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	服务资源的名称。
subscriptionId	path	True	string	获取唯一标识 azure 订阅Microsoft的订阅 ID。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
credentials	True	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	容器注册表资源的凭据。

响应

名称	类型	说明
200 OK	ContainerRegistryValidateResult	成功。 响应描述容器注册表的验证结果。
202 Accepted		接受。 响应指示容器注册表属性正在验证。 标头 Location: string
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ContainerRegistries_Validate

示例请求

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

示例响应

状态代码:

200

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

状态代码:

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

定义

名称	说明
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
ContainerRegistryBasicCredentials	容器注册表资源的基本身份验证属性。
ContainerRegistryProperties	容器注册表资源有效负载。
ContainerRegistryProvisioningState	容器注册表的状态。
ContainerRegistryValidateResult	容器注册表属性的验证结果

CloudError

对象

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	服务的错误响应。

CloudErrorBody

对象

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

ContainerRegistryBasicCredentials

对象

容器注册表资源的基本身份验证属性。

名称	类型	说明
password	string	容器注册表的密码。
server	string	容器注册表的登录服务器。
type	string: BasicAuth	容器注册表凭据的凭据类型。
username	string	容器注册表的用户名。

ContainerRegistryProperties

对象

容器注册表资源有效负载。

名称	类型	说明
credentials	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	容器注册表资源的凭据。
provisioningState	ContainerRegistryProvisioningState	容器注册表的状态。

ContainerRegistryProvisioningState

枚举

容器注册表的状态。

值	说明
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ContainerRegistryValidateResult

对象

容器注册表属性的验证结果

名称	类型	说明
isValid	boolean	指示容器注册表属性是否有效
message	string	详细的验证消息。