Namespaces - Check Name Availability

リファレンス

Service:: Relay

API Version:: 2021-11-01

指定した名前空間名の可用性を確認します。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

要求本文

名前	型	説明
parameters	CheckNameAvailability	指定した名前空間名の可用性をチェックするためのパラメーター。

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	可用性が正常に返されたことを確認します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するリレーエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

RelayCheckNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/checkNameAvailability?api-version=2021-11-01

{
  "name": "example-RelayNamespace1321"
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.relay import RelayAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-relay
# USAGE
    python relay_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 = RelayAPI(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.namespaces.check_name_availability(
        parameters={"name": "example-RelayNamespace1321"},
    )
    print(response)


# x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.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

package armrelay_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/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json
func ExampleNamespacesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrelay.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, armrelay.CheckNameAvailability{
		Name: to.Ptr("example-RelayNamespace1321"),
	}, 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.CheckNameAvailabilityResult = armrelay.CheckNameAvailabilityResult{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armrelay.UnavailableReasonNone),
	// }
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Relay;
using Azure.ResourceManager.Relay.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json
// this example is just showing the usage of "Namespaces_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
RelayNameAvailabilityContent content = new RelayNameAvailabilityContent("example-RelayNamespace1321");
RelayNameAvailabilityResult result = await subscriptionResource.CheckRelayNamespaceNameAvailabilityAsync(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

Sample Response

Status code:: 200

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

定義

名前	説明
CheckNameAvailability	指定した名前空間名の可用性をチェックするためのパラメーター。
CheckNameAvailabilityResult	チェック名の可用性要求プロパティの説明。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
UnavailableReason	名前空間が使用できない理由。

CheckNameAvailability

指定した名前空間名の可用性をチェックするためのパラメーター。

名前	型	説明
name	string	可用性のためにチェックする名前空間名。名前空間名には、文字、数字、ハイフンのみを含めることができます。名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。

CheckNameAvailabilityResult

チェック名の可用性要求プロパティの説明。

名前	型	説明
message	string	名前空間に関連付けられている理由に関する詳細情報。
nameAvailable	boolean	名前空間を示す値を使用できます。名前空間が使用可能な場合は true を返します。それ以外の場合は false。
reason	UnavailableReason	名前空間が使用できない理由。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

UnavailableReason

名前空間が使用できない理由。

名前	型	説明
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string

Namespaces - Check Name Availability

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

RelayCheckNameAvailability

Sample Request

Sample Response

定義

CheckNameAvailability

CheckNameAvailabilityResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

UnavailableReason

その他のリソース