Controleer de beschikbaarheid van de opgegeven naamruimtenaam.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability?api-version=2021-11-01
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
subscriptionId
|
path |
True
|
string
|
Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
|
|
api-version
|
query |
True
|
string
|
Client-API-versie.
|
Aanvraagbody
| Name |
Type |
Description |
|
parameters
|
CheckNameAvailability
|
Parameters voor het controleren van de beschikbaarheid van de opgegeven naamruimtenaam.
|
Antwoorden
| Name |
Type |
Description |
|
200 OK
|
CheckNameAvailabilityResult
|
Controleer of de beschikbaarheid is geretourneerd.
|
|
Other Status Codes
|
ErrorResponse
|
Relay-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.
|
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
Uw gebruikersaccount imiteren
|
Voorbeelden
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": ""
}
Definities
CheckNameAvailability
Parameters voor het controleren van de beschikbaarheid van de opgegeven naamruimtenaam.
| Name |
Type |
Description |
|
name
|
string
|
De naam van de naamruimte om te controleren op beschikbaarheid. De naam van de naamruimte mag alleen letters, cijfers en afbreekstreepjes bevatten. De naamruimte moet beginnen met een letter en moet eindigen met een letter of cijfer.
|
CheckNameAvailabilityResult
Beschrijving van de eigenschappen van de aanvraag voor de beschikbaarheid van de controlenaam.
| Name |
Type |
Description |
|
message
|
string
|
De gedetailleerde informatie over de reden die is gekoppeld aan de naamruimte.
|
|
nameAvailable
|
boolean
|
Waarde die aangeeft dat de naamruimte beschikbaar is. Retourneert true als de naamruimte beschikbaar is; anders onwaar.
|
|
reason
|
UnavailableReason
|
De reden voor het niet beschikbaar zijn van een naamruimte.
|
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name |
Type |
Description |
|
info
|
object
|
De aanvullende informatie.
|
|
type
|
string
|
Het type aanvullende informatie.
|
ErrorDetail
De foutdetails.
| Name |
Type |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
De fout aanvullende informatie.
|
|
code
|
string
|
De foutcode.
|
|
details
|
ErrorDetail[]
|
De foutdetails.
|
|
message
|
string
|
Het foutbericht.
|
|
target
|
string
|
Het foutdoel.
|
ErrorResponse
Foutreactie
| Name |
Type |
Description |
|
error
|
ErrorDetail
|
Het foutobject.
|
UnavailableReason
De reden voor het niet beschikbaar zijn van een naamruimte.
| Name |
Type |
Description |
|
InvalidName
|
string
|
|
|
NameInLockdown
|
string
|
|
|
NameInUse
|
string
|
|
|
None
|
string
|
|
|
SubscriptionIsDisabled
|
string
|
|
|
TooManyNamespaceInCurrentSubscription
|
string
|
|