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 參數

名稱	位於	必要	類型	Description
containerRegistryName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	容器登錄的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	服務資源的名稱。
subscriptionId	path	True	string	取得可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶標識碼。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
credentials	True	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	容器登錄資源的認證。

回應

名稱	類型	Description
200 OK	ContainerRegistryValidateResult	成功。 回應描述容器登錄的驗證結果。
202 Accepted		接受。 回應表示容器登錄屬性正在驗證。 標題 Location: string
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
ContainerRegistryBasicCredentials	容器登錄資源的基本驗證屬性。
ContainerRegistryProperties	容器登錄資源承載。
ContainerRegistryProvisioningState	Container Registry 的狀態。
ContainerRegistryValidateResult	容器登錄屬性的驗證結果

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	來自服務的錯誤回應。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

ContainerRegistryBasicCredentials

Object

容器登錄資源的基本驗證屬性。

名稱	類型	Description
password	string	Container Registry 的密碼。
server	string	Container Registry 的登入伺服器。
type	string: BasicAuth	容器登錄認證的認證類型。
username	string	Container Registry 的用戶名稱。

ContainerRegistryProperties

Object

容器登錄資源承載。

名稱	類型	Description
credentials	ContainerRegistryCredentials: ContainerRegistryBasicCredentials	容器登錄資源的認證。
provisioningState	ContainerRegistryProvisioningState	Container Registry 的狀態。

ContainerRegistryProvisioningState

列舉型別

Container Registry 的狀態。

值	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ContainerRegistryValidateResult

Object

容器登錄屬性的驗證結果

名稱	類型	Description
isValid	boolean	指出容器登錄屬性是否有效
message	string	詳細的驗證訊息。