Ellenőrizze a megadott névtérnév rendelkezésre állását.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability?api-version=2021-11-01
URI-paraméterek
| Name |
In |
Kötelező |
Típus |
Description |
|
subscriptionId
|
path |
True
|
string
|
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
|
|
api-version
|
query |
True
|
string
|
Ügyfél API-verziója.
|
Kérelem törzse
| Name |
Típus |
Description |
|
parameters
|
CheckNameAvailability
|
Paraméterek a megadott névtérnév rendelkezésre állásának ellenőrzéséhez.
|
Válaszok
| Name |
Típus |
Description |
|
200 OK
|
CheckNameAvailabilityResult
|
Ellenőrizze, hogy a rendelkezésre állás sikeresen vissza van-e adva.
|
|
Other Status Codes
|
ErrorResponse
|
Relay hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.
|
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
felhasználói fiók megszemélyesítése
|
Példák
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
{
"nameAvailable": true,
"reason": "None",
"message": ""
}
Definíciók
CheckNameAvailability
Paraméterek a megadott névtérnév rendelkezésre állásának ellenőrzéséhez.
| Name |
Típus |
Description |
|
name
|
string
|
A rendelkezésre állás ellenőrzéséhez használt névtér neve. A névtér neve csak betűket, számokat és kötőjeleket tartalmazhat. A névtérnek betűvel kell kezdődnie, és betűvel vagy számmal kell végződnie.
|
CheckNameAvailabilityResult
Az ellenőrzőnév rendelkezésreállási kérelem tulajdonságainak leírása.
| Name |
Típus |
Description |
|
message
|
string
|
A névtérhez társított ok részletes információja.
|
|
nameAvailable
|
boolean
|
A névteret jelző érték elérhető. Igaz értéket ad vissza, ha a névtér elérhető; ellenkező esetben hamis.
|
|
reason
|
UnavailableReason
|
A névtér elérhetetlenségének oka.
|
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name |
Típus |
Description |
|
info
|
object
|
A további információk.
|
|
type
|
string
|
A további adattípus.
|
ErrorDetail
A hiba részletei.
| Name |
Típus |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
A hiba további információi.
|
|
code
|
string
|
A hibakód.
|
|
details
|
ErrorDetail[]
|
A hiba részletei.
|
|
message
|
string
|
A hibaüzenet.
|
|
target
|
string
|
A hiba célja.
|
ErrorResponse
Hibaválasz
| Name |
Típus |
Description |
|
error
|
ErrorDetail
|
A hibaobjektum.
|
UnavailableReason
A névtér elérhetetlenségének oka.
| Name |
Típus |
Description |
|
InvalidName
|
string
|
|
|
NameInLockdown
|
string
|
|
|
NameInUse
|
string
|
|
|
None
|
string
|
|
|
SubscriptionIsDisabled
|
string
|
|
|
TooManyNamespaceInCurrentSubscription
|
string
|
|