Creare una coda

Importante

Questa API è obsoleta e ritirata a partire dal 11/1/2021 e non deve più essere usata.

Questa operazione consente di creare una nuova coda. Dopo la creazione, il manifesto delle risorse della coda non può essere modificato. Questa operazione è idempotente. Se si ripete la chiamata di creazione dopo che è stata creata una coda con lo stesso nome, verrà generato un messaggio di errore di conflitto 409.

Richiesta

Metodo URI richiesta Versione HTTP
PUT https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/{Namespace}/Queues/{Queue Path} HTTP/1.1

Intestazioni richiesta

Nella seguente tabella vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta Descrizione
Content-Type application/xml;type=entry;charset=utf-8
x-ms-version 2012-03-01

La richiesta richiede anche un certificato client. Questo certificato deve corrispondere a quello caricato per la sottoscrizione specifica.

Corpo della richiesta

Nella tabella seguente vengono descritti gli elementi chiave del corpo della richiesta:

Nome proprietà Tipo Obbligatoria Descrizione
MaxQueueSizeInMegaBytes Unsigned Integer Necessario Questo parametro specifica le dimensioni massime della coda in megabyte. Qualsiasi tentativo di accodamento di un messaggio che causa l'esito negativo della coda per il superamento di questo valore. Per il calcolo di questo valore viene considerato solo il contenuto utente. Può essere impostato in fase di creazione della coda e in fase di esecuzione:

- Intervallo: 1-5*1024.

- Impostazione predefinita: 1*1024.
QueueSizeinBytes Unsigned Integer Sola lettura. Non necessario in fase di creazione. Questo parametro riflettei byte effettivi attualmente occupati dai messaggi nella coda rispetto alla quota della coda.

Intervallo: 0 –MaxTopicSizeinMegaBytes
QueueDepth Unsigned Integer Di sola lettura. Non necessario in fase di creazione. Questo parametro mostra il numero di messaggi attualmente nella coda.
DefaultMessageTimeToLive Datetime XML Facoltativo, il valore predefinito è 14 giorni. In base al fatto che l'invio di messaggi non recapitabili sia abilitato, se un messaggio è stato archiviato nella coda per più del tempo specificato, viene automaticamente spostato nella coda dei messaggi non recapitabili o eliminato. Questo valore viene sovrascritto dalla durata TTL specificata per il messaggio se tale durata è inferiore a quella specificata per la coda. Questo valore non può essere modificato dopo la creazione della coda:

- Intervallo: 1 secondo - 14 giorni.

- Impostazione predefinita: 14 giorni.
LockDuration Datetime XML Facoltativo, il valore predefinito è 30 secondi. Questa impostazione determina l'intervallo di tempo, in secondi, durante il quale un messaggio deve essere bloccato per consentire l'elaborazione da parte di un ricevitore. Trascorso questo intervallo di tempo, il messaggio viene sbloccato ed è disponibile per il ricevitore successivo. Può essere impostata solo al momento della creazione della coda:

- Intervallo: 0-5 minuti indica che il messaggio non è bloccato.

- Impostazione predefinita: 30 secondi.
RequiresSession Boolean Facoltativo Può essere impostata solo al momento della creazione della coda. Se è impostato su true, la coda è in grado di supportare la sessione e solo l'oggetto SessionReceiver è supportato. Le code con riconoscimento della sessione non sono supportate tramite REST.

- Impostazione predefinita: False.
RequiresDuplicateDetection Boolean Facoltativo Può essere impostata solo al momento della creazione della coda.

- Valore predefinito per la coda durevole: false.
EnableDeadLetteringOnMessageExpiration Boolean Facoltativo Può essere impostata solo al momento della creazione della coda.

- Impostazione predefinita: false.

Questo campo determina il modo in cui il bus di servizio gestisce un messaggio con un TTL scaduto. Se true e un messaggio scade, il bus di servizio sposta il messaggio dalla coda nella coda secondaria dei messaggi non recapitabili della coda. Se è false, il messaggio viene eliminato definitivamente dalla coda.
DuplicateDetectionHistoryTimeWindow Intervallo di tempo facoltativo. Proprietà che specifica l'intervallo di tempo durante il quale il bus di servizio rileva la duplicazione dei messaggi.

- Intervallo: 1 secondo-7 giorni.

- Impostazione predefinita: 10 minuti.
Status string Di sola lettura. Non necessario in fase di creazione. I possibili valori sono i seguenti:

  • Attivo
  • Creating
  • Deleting
  • ReceiveDisabled
  • SendDisabled
  • Disabled
  • Ridenominazione
  • Restoring
  • Sconosciuto

Risposta

Nella risposta sono inclusi un codice di stato HTTP e un set di intestazioni per la risposta.

Codici di risposta

Nota

Se si crea una coda con un nome contenente caratteri speciali o codificati, ad esempio, "test?Name=value&", codificato come "test%3FName%3Dvalue%26", viene generata un'eccezione di richiesta non valida (400).

Codice Descrizione
201 La coda è stata creata.
400 Corpo della richiesta non valido.
401 Errore di autorizzazione.
403 Quota superata, coda non creata.
409 La coda specificata esiste già oppure il percorso specificato è già occupato.
500 Errore interno.

Per informazioni sui codici di stato, vedere Codici di stato e di errore.

Intestazioni della risposta

Nessuno.

Corpo della risposta

Viene restituita la descrizione della coda. È possibile che alcune proprietà della descrizione, se mancanti nella richiesta PUT, contengano valori predefiniti.