Sprawdza, czy nazwa zasobu jest prawidłowa i nie jest jeszcze używana.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability?api-version=2024-03-01
Parametry identyfikatora URI
| Nazwa |
W |
Wymagane |
Typ |
Opis |
|
location
|
path |
True
|
string
|
region
|
|
subscriptionId
|
path |
True
|
string
uuid
|
Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
|
|
api-version
|
query |
True
|
string
|
Wersja interfejsu API do użycia dla tej operacji.
|
Treść żądania
| Nazwa |
Wymagane |
Typ |
Opis |
|
name
|
True
|
string
|
Nazwa zasobu do zweryfikowania. np. "my-resource-name"
|
|
type
|
True
|
string
|
Typ zasobu. Może to być "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" lub "Microsoft.SignalRService/WebPubSub/replicas"
|
Odpowiedzi
| Nazwa |
Typ |
Opis |
|
200 OK
|
NameAvailability
|
Powodzenie. Odpowiedź opisuje dostępność nazwy.
|
|
Other Status Codes
|
ErrorResponse
|
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.
|
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa |
Opis |
|
user_impersonation
|
personifikacja konta użytkownika
|
Przykłady
WebPubSub_CheckNameAvailability
Przykładowe żądanie
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/checkNameAvailability?api-version=2024-03-01
{
"type": "Microsoft.SignalRService/WebPubSub",
"name": "myWebPubSubService"
}
import com.azure.resourcemanager.webpubsub.models.NameAvailabilityParameters;
/**
* Samples for WebPubSub CheckNameAvailability.
*/
public final class Main {
/*
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/
* WebPubSub_CheckNameAvailability.json
*/
/**
* Sample code: WebPubSub_CheckNameAvailability.
*
* @param manager Entry point to WebPubSubManager.
*/
public static void webPubSubCheckNameAvailability(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
manager.webPubSubs()
.checkNameAvailabilityWithResponse("eastus", new NameAvailabilityParameters()
.withType("Microsoft.SignalRService/WebPubSub").withName("myWebPubSubService"),
com.azure.core.util.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
from azure.identity import DefaultAzureCredential
from azure.mgmt.webpubsub import WebPubSubManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-webpubsub
# USAGE
python web_pub_sub_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 = WebPubSubManagementClient(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.web_pub_sub.check_name_availability(
location="eastus",
parameters={"name": "myWebPubSubService", "type": "Microsoft.SignalRService/WebPubSub"},
)
print(response)
# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_CheckNameAvailability.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 armwebpubsub_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/webpubsub/armwebpubsub"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7189fb57f69468c56df76f9a4d68dd9ff04ab100/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_CheckNameAvailability.json
func ExampleClient_CheckNameAvailability() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armwebpubsub.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClient().CheckNameAvailability(ctx, "eastus", armwebpubsub.NameAvailabilityParameters{
Name: to.Ptr("myWebPubSubService"),
Type: to.Ptr("Microsoft.SignalRService/WebPubSub"),
}, 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.NameAvailability = armwebpubsub.NameAvailability{
// Message: to.Ptr("The name is already taken. Please try a different name."),
// NameAvailable: to.Ptr(false),
// Reason: to.Ptr("AlreadyExists"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Checks that the resource name is valid and is not already in use.
*
* @summary Checks that the resource name is valid and is not already in use.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_CheckNameAvailability.json
*/
async function webPubSubCheckNameAvailability() {
const subscriptionId =
process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const location = "eastus";
const parameters = {
name: "myWebPubSubService",
type: "Microsoft.SignalRService/WebPubSub",
};
const credential = new DefaultAzureCredential();
const client = new WebPubSubManagementClient(credential, subscriptionId);
const result = await client.webPubSub.checkNameAvailability(location, parameters);
console.log(result);
}
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": "The name is already taken. Please try a different name."
}
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 zasobu do zweryfikowania. np. "my-resource-name"
|
|
type
|
string
|
Typ zasobu. Może to być "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" lub "Microsoft.SignalRService/WebPubSub/replicas"
|