Connected Environments - Check Name Availability

Hizmet:

Azure Container Apps

API Sürümü:

2025-07-01

ConnectedEnvironmentName kaynağının kullanılabilirliğini denetler.
connectedEnvironmentName kaynağının kullanılabilir olup olmadığını denetler.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability?api-version=2025-07-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
connectedEnvironmentName	path	True	string	Yönetilen ortamın adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
name	string	Kullanılabilirliğinin denetlenmesi gereken kaynağın adı.
type	string	Kaynağın türü.

Yanıtlar

Name	Tür	Description
200 OK	CheckNameAvailabilityResponse	Success
Other Status Codes	DefaultErrorResponse	Hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Certificates_CheckNameAvailability

Örnek isteği

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/checkNameAvailability?api-version=2025-07-01

{
  "name": "testcertificatename",
  "type": "Microsoft.App/connectedEnvironments/certificates"
}

Java

import com.azure.resourcemanager.appcontainers.models.CheckNameAvailabilityRequest;

/**
 * Samples for ConnectedEnvironments CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/app/resource-manager/Microsoft.App/ContainerApps/stable/2025-07-01/examples/
     * ConnectedEnvironmentsCertificates_CheckNameAvailability.json
     */
    /**
     * Sample code: Certificates_CheckNameAvailability.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void
        certificatesCheckNameAvailability(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.connectedEnvironments()
            .checkNameAvailabilityWithResponse("examplerg", "testcontainerenv", new CheckNameAvailabilityRequest()
                .withName("testcertificatename").withType("Microsoft.App/connectedEnvironments/certificates"),
                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 azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python connected_environments_certificates_check_name_availability.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 = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.connected_environments.check_name_availability(
        resource_group_name="examplerg",
        connected_environment_name="testcontainerenv",
        check_name_availability_request={
            "name": "testcertificatename",
            "type": "Microsoft.App/connectedEnvironments/certificates",
        },
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/ContainerApps/stable/2025-07-01/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.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 armappcontainers_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/appcontainers/armappcontainers/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b2965096067d6f8374b5485b0568fd36e7c9d099/specification/app/resource-manager/Microsoft.App/ContainerApps/stable/2025-07-01/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json
func ExampleConnectedEnvironmentsClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectedEnvironmentsClient().CheckNameAvailability(ctx, "examplerg", "testcontainerenv", armappcontainers.CheckNameAvailabilityRequest{
		Name: to.Ptr("testcertificatename"),
		Type: to.Ptr("Microsoft.App/connectedEnvironments/certificates"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.CheckNameAvailabilityResponse = armappcontainers.CheckNameAvailabilityResponse{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armappcontainers.CheckNameAvailabilityReason("None")),
	// }
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/ContainerApps/stable/2025-07-01/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json
// this example is just showing the usage of "ConnectedEnvironments_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppConnectedEnvironmentResource created on azure
// for more information of creating ContainerAppConnectedEnvironmentResource, please refer to the document of ContainerAppConnectedEnvironmentResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "examplerg";
string connectedEnvironmentName = "testcontainerenv";
ResourceIdentifier containerAppConnectedEnvironmentResourceId = ContainerAppConnectedEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, connectedEnvironmentName);
ContainerAppConnectedEnvironmentResource containerAppConnectedEnvironment = client.GetContainerAppConnectedEnvironmentResource(containerAppConnectedEnvironmentResourceId);

// invoke the operation
ContainerAppNameAvailabilityContent content = new ContainerAppNameAvailabilityContent
{
    Name = "testcertificatename",
    ResourceType = new ResourceType("Microsoft.App/connectedEnvironments/certificates"),
};
ContainerAppNameAvailabilityResult result = await containerAppConnectedEnvironment.CheckNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Örnek yanıt

Durum kodu:

200

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Tanımlar

Name	Description
CheckNameAvailabilityReason	Verilen ismin mevcut olmamasının nedeni.
CheckNameAvailabilityRequest	Kullanılabilirlik isteği gövdesini denetleyin.
CheckNameAvailabilityResponse	Kullanılabilirlik durumunu denetleme sonucu.
DefaultErrorResponse	App Service hata yanıtı.
Details	Ayrıntılar veya hata
Error	Hata modeli.

CheckNameAvailabilityReason

Listeleme

Verilen ismin mevcut olmamasının nedeni.

Değer	Description
Invalid
AlreadyExists

CheckNameAvailabilityRequest

Object

Kullanılabilirlik isteği gövdesini denetleyin.

Name	Tür	Description
name	string	Kullanılabilirliğinin denetlenmesi gereken kaynağın adı.
type	string	Kaynağın türü.

CheckNameAvailabilityResponse

Object

Kullanılabilirlik durumunu denetleme sonucu.

Name	Tür	Description
message	string	Verilen adın neden mevcut olduğunun ayrıntılı nedeni.
nameAvailable	boolean	Kaynak adının kullanılabilir olup olmadığını gösterir.
reason	CheckNameAvailabilityReason	Verilen ismin mevcut olmamasının nedeni.

DefaultErrorResponse

Object

App Service hata yanıtı.

Name	Tür	Description
error	Error	Hata modeli.

Details

Object

Ayrıntılar veya hata

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

Error

Object

Hata modeli.

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
details	Details[]	Ayrıntılar veya hata
innererror	string	Hata ayıklamak için daha fazla bilgi.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.