Kontrollerar att resursnamnet är giltigt och inte redan används.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability?api-version=2024-03-01
URI-parametrar
| Name |
I |
Obligatorisk |
Typ |
Description |
|
location
|
path |
True
|
string
|
regionen
|
|
subscriptionId
|
path |
True
|
string
uuid
|
ID för målprenumerationen. Värdet måste vara ett UUID.
|
|
api-version
|
query |
True
|
string
|
Den API-version som ska användas för den här åtgärden.
|
Begärandetext
| Name |
Obligatorisk |
Typ |
Description |
|
name
|
True
|
string
|
Resursnamnet som ska verifieras. t.ex. "my-resource-name"
|
|
type
|
True
|
string
|
Resurstypen. Kan vara "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" eller "Microsoft.SignalRService/WebPubSub/replicas"
|
Svar
| Name |
Typ |
Description |
|
200 OK
|
NameAvailability
|
Åtgärden lyckades. Svaret beskriver namntillgängligheten.
|
|
Other Status Codes
|
ErrorResponse
|
Felsvar som beskriver varför åtgärden misslyckades.
|
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name |
Description |
|
user_impersonation
|
personifiera ditt användarkonto
|
Exempel
WebPubSub_CheckNameAvailability
Exempelbegäran
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
Exempelsvar
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "The name is already taken. Please try a different name."
}
Definitioner
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name |
Typ |
Description |
|
info
|
object
|
Ytterligare information.
|
|
type
|
string
|
Den ytterligare informationstypen.
|
ErrorDetail
Felinformationen.
| Name |
Typ |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Ytterligare information om felet.
|
|
code
|
string
|
Felkoden.
|
|
details
|
ErrorDetail[]
|
Felinformationen.
|
|
message
|
string
|
Felmeddelandet.
|
|
target
|
string
|
Felmålet.
|
ErrorResponse
Felsvar
NameAvailability
Resultatet av begäran om att kontrollera namntillgängligheten. Den innehåller en flagga och möjliga orsaker till fel.
| Name |
Typ |
Description |
|
message
|
string
|
Meddelandet om åtgärden.
|
|
nameAvailable
|
boolean
|
Anger om namnet är tillgängligt eller inte.
|
|
reason
|
string
|
Orsaken till tillgängligheten. Krävs om namnet inte är tillgängligt.
|
NameAvailabilityParameters
Data POST-ed till åtgärden nameAvailability
| Name |
Typ |
Description |
|
name
|
string
|
Resursnamnet som ska verifieras. t.ex. "my-resource-name"
|
|
type
|
string
|
Resurstypen. Kan vara "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" eller "Microsoft.SignalRService/WebPubSub/replicas"
|