Beschikbaarheid van naam controleren
Controleert of de CommunicationService-naam geldig is en nog niet in gebruik is.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
subscriptionId
|
path |
True
|
string
|
De id van het doelabonnement.
|
|
api-version
|
query |
True
|
string
|
De API-versie die voor deze bewerking moet worden gebruikt.
|
Aanvraagbody
| Name |
Vereist |
Type |
Description |
|
name
|
True
|
string
|
De CommunicationService-naam die moet worden gevalideerd. bijvoorbeeld'my-CommunicationService-name-here'
|
|
type
|
True
|
string
|
Het resourcetype. Moet altijd Microsoft.Communication/CommunicationServices zijn.
|
Antwoorden
| Name |
Type |
Description |
|
200 OK
|
NameAvailability
|
Succes. In het antwoord wordt de beschikbaarheid van de naam beschreven.
|
|
Other Status Codes
|
ErrorResponse
|
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.
|
Voorbeelden
Check name availability available
Voorbeeldaanvraag
POST https://management.azure.com/subscriptions/12345/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20
{
"type": "Microsoft.Communication/CommunicationServices",
"name": "MyCommunicationService"
}
import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.NameAvailabilityParameters;
/** Samples for CommunicationService CheckNameAvailability. */
public final class Main {
/*
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
*/
/**
* Sample code: Check name availability available.
*
* @param manager Entry point to CommunicationManager.
*/
public static void checkNameAvailabilityAvailable(
com.azure.resourcemanager.communication.CommunicationManager manager) {
manager
.communicationServices()
.checkNameAvailabilityWithResponse(
new NameAvailabilityParameters()
.withType("Microsoft.Communication/CommunicationServices")
.withName("MyCommunicationService"),
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
package armcommunication_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/communication/armcommunication"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
func ExampleServiceClient_CheckNameAvailability() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armcommunication.NewServiceClient("12345", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckNameAvailability(ctx,
&armcommunication.ServiceClientCheckNameAvailabilityOptions{NameAvailabilityParameters: &armcommunication.NameAvailabilityParameters{
Name: to.Ptr("MyCommunicationService"),
Type: to.Ptr("Microsoft.Communication/CommunicationServices"),
},
})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Checks that the CommunicationService name is valid and is not already in use.
*
* @summary Checks that the CommunicationService name is valid and is not already in use.
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityAvailable.json
*/
async function checkNameAvailabilityAvailable() {
const subscriptionId = "12345";
const nameAvailabilityParameters = {
name: "MyCommunicationService",
type: "Microsoft.Communication/CommunicationServices",
};
const options = {
nameAvailabilityParameters,
};
const credential = new DefaultAzureCredential();
const client = new CommunicationServiceManagementClient(credential, subscriptionId);
const result = await client.communicationService.checkNameAvailability(options);
console.log(result);
}
checkNameAvailabilityAvailable().catch(console.error);
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Voorbeeldrespons
{
"nameAvailable": true,
"reason": "NameAvailable",
"message": "Requested name is available for the requested type"
}
Check name availability unavailable
Voorbeeldaanvraag
POST https://management.azure.com/subscriptions/12345/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20
{
"type": "Microsoft.Communication/CommunicationServices",
"name": "MyCommunicationService"
}
import com.azure.core.util.Context;
import com.azure.resourcemanager.communication.models.NameAvailabilityParameters;
/** Samples for CommunicationService CheckNameAvailability. */
public final class Main {
/*
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityUnavailable.json
*/
/**
* Sample code: Check name availability unavailable.
*
* @param manager Entry point to CommunicationManager.
*/
public static void checkNameAvailabilityUnavailable(
com.azure.resourcemanager.communication.CommunicationManager manager) {
manager
.communicationServices()
.checkNameAvailabilityWithResponse(
new NameAvailabilityParameters()
.withType("Microsoft.Communication/CommunicationServices")
.withName("MyCommunicationService"),
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
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Checks that the CommunicationService name is valid and is not already in use.
*
* @summary Checks that the CommunicationService name is valid and is not already in use.
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/checkNameAvailabilityUnavailable.json
*/
async function checkNameAvailabilityUnavailable() {
const subscriptionId = "12345";
const nameAvailabilityParameters = {
name: "MyCommunicationService",
type: "Microsoft.Communication/CommunicationServices",
};
const options = {
nameAvailabilityParameters,
};
const credential = new DefaultAzureCredential();
const client = new CommunicationServiceManagementClient(credential, subscriptionId);
const result = await client.communicationService.checkNameAvailability(options);
console.log(result);
}
checkNameAvailabilityUnavailable().catch(console.error);
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Voorbeeldrespons
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Requested name is unavailable for the requested type"
}
Definities
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name |
Type |
Description |
|
info
|
object
|
De aanvullende informatie.
|
|
type
|
string
|
Het extra informatietype.
|
ErrorDetail
De foutdetails.
| Name |
Type |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
De fout bevat 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.
|
NameAvailability
Resultaat van de aanvraag om de beschikbaarheid van de naam te controleren. Het bevat een vlag en mogelijke reden van fout.
| Name |
Type |
Description |
|
message
|
string
|
Het bericht van de bewerking.
|
|
nameAvailable
|
boolean
|
Geeft aan of de naam beschikbaar is of niet.
|
|
reason
|
string
|
De reden van de beschikbaarheid. Vereist als de naam niet beschikbaar is.
|
NameAvailabilityParameters
Gegevens die zijn verzonden naar de actie NameAvailability
| Name |
Type |
Description |
|
name
|
string
|
De CommunicationService-naam die moet worden gevalideerd. bijvoorbeeld'my-CommunicationService-name-here'
|
|
type
|
string
|
Het resourcetype. Moet altijd Microsoft.Communication/CommunicationServices zijn.
|