Sprawdzanie dostępności nazwy
Sprawdza, czy nazwa usługi CommunicationService jest prawidłowa i nie jest jeszcze używana.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2020-08-20
Parametry identyfikatora URI
| Nazwa |
W |
Wymagane |
Typ |
Opis |
|
subscriptionId
|
path |
True
|
string
|
Identyfikator subskrypcji docelowej.
|
|
api-version
|
query |
True
|
string
|
Wersja interfejsu API do użycia dla tej operacji.
|
Treść żądania
| Nazwa |
Wymagane |
Typ |
Opis |
|
name
|
True
|
string
|
Nazwa usługi communicationService do zweryfikowania. np. "my-CommunicationService-name-here"
|
|
type
|
True
|
string
|
Typ zasobu. Powinna być zawsze "Microsoft.Communication/CommunicationServices".
|
Odpowiedzi
| Nazwa |
Typ |
Opis |
|
200 OK
|
NameAvailability
|
Sukces. Odpowiedź opisuje dostępność nazwy.
|
|
Other Status Codes
|
ErrorResponse
|
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.
|
Przykłady
Check name availability available
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"nameAvailable": true,
"reason": "NameAvailable",
"message": "Requested name is available for the requested type"
}
Check name availability unavailable
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Requested name is unavailable for the requested type"
}
Definicje
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa |
Typ |
Opis |
|
info
|
object
|
Dodatkowe informacje.
|
|
type
|
string
|
Dodatkowy typ informacji.
|
ErrorDetail
Szczegóły błędu.
| Nazwa |
Typ |
Opis |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Dodatkowe informacje o błędzie.
|
|
code
|
string
|
Kod błędu.
|
|
details
|
ErrorDetail[]
|
Szczegóły błędu.
|
|
message
|
string
|
Komunikat o błędzie.
|
|
target
|
string
|
Element docelowy błędu.
|
ErrorResponse
Odpowiedź na błąd
NameAvailability
Wynik żądania sprawdzania dostępności nazwy. Zawiera flagę i możliwą przyczynę niepowodzenia.
| Nazwa |
Typ |
Opis |
|
message
|
string
|
Komunikat operacji.
|
|
nameAvailable
|
boolean
|
Wskazuje, czy nazwa jest dostępna, czy nie.
|
|
reason
|
string
|
Przyczyna dostępności. Wymagane, jeśli nazwa jest niedostępna.
|
NameAvailabilityParameters
Dane POST-ed do akcji nameAvailability
| Nazwa |
Typ |
Opis |
|
name
|
string
|
Nazwa usługi communicationService do zweryfikowania. np. "my-CommunicationService-name-here"
|
|
type
|
string
|
Typ zasobu. Powinna być zawsze "Microsoft.Communication/CommunicationServices".
|