Поделиться через

Создание регистрации

  • Статья

 

Создает новую регистрацию. С помощью этого метода создается идентификатор регистрации, который в дальнейшем можно использовать для извлечения, обновления и удаления этой регистрации.

Запрос

Метод URI запроса Версия HTTP
POST https://{namespace}.servicebus.Windows.NET/{NotificationHub}/registrations/?API-Version=2015-01 HTTP/1.1

Заголовки запроса

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса Описание
Content-Type application/atom+xml;type=entry;charset=utf-8
Авторизация Маркер создается, как указано в общий доступ подпись проверки подлинности с Служебная шина, или Служебная шина проверки подлинности и авторизации с помощью Microsoft Azure Active Directory Access Control (также называется Access Control Service или ACS).
x-ms-version 2015-01

Текст запроса

Запись Atom с описанием, внедренным в содержимое. Ниже приведено несколько примеров.

Собственная регистрация для службы уведомлений Windows.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <WindowsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> </WindowsRegistrationDescription> </content> </entry>

Примечание

Tags Элемент не является обязательным.

Шаблонная регистрация для службы уведомлений Windows.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <WindowsTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> <BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate> <WnsHeaders> <WnsHeader> <Header>X-WNS-Type</Header> <Value>wns/tile</Value> </WnsHeader> <WnsHeader> <Header>X-WNS-Tag</Header> <Value>myTag</Value> </WnsHeader> </WnsHeaders> </WindowsTemplateRegistrationDescription> </content> </entry>

Примечание

BodyTemplate Является обязательным, как X-WNS-Type заголовка.

Собственная регистрация для службы push-уведомлений Apple.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <AppleRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <DeviceToken>{DeviceToken}</DeviceToken> </AppleRegistrationDescription> </content> </entry>

Примечание

Tags Элемент не является обязательным.

Шаблонная регистрация для службы push-уведомлений Apple.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <AppleTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <DeviceToken>{DeviceToken}</DeviceToken> <BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate> <Expiry>{Template for Expiry in }</Expiry> </AppleTemplateRegistrationDescription> </content> </entry>

Примечание

BodyTemplate Элемент является обязательным.Expiry является необязательным.

Собственная регистрация для службы Google Cloud Messaging.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <GcmRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId> </GcmRegistrationDescription> </content> </entry>

Примечание

Tags Элемент не является обязательным.

Шаблонная регистрация для службы Google Cloud Messaging.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <GcmTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <GcmRegistrationId>{GCM Registration Id}</GcmRegistrationId> <BodyTemplate><![CDATA[ {BodyTemplate}]]></BodyTemplate> </GcmTemplateRegistrationDescription> </content> </entry>

Примечание

BodyTemplate Элемент является обязательным.

Собственная регистрация для службы push-уведомлений Майкрософт.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <MpnsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> </MpnsRegistrationDescription> </content> </entry>

Примечание

Tags Элемент не является обязательным.

Шаблонная регистрация для службы push-уведомлений Майкрософт.

<?xml version="1.0" encoding="utf-8"?> <entry xmlns="http://www.w3.org/2005/Atom"> <content type="application/xml"> <MpnsTemplateRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> <BodyTemplate><![CDATA[{Template for the body}]]></BodyTemplate> <MpnsHeaders> <MpnsHeader> <Header>X-WindowsPhone-Target</Header> <Value>toast</Value> </MpnsHeader> <MpnsHeader> <Header>X-NotificationClass</Header> <Value>[batching interval]</Value> </MpnsHeader> </MpnsHeaders> </MpnsTemplateRegistrationDescription> </content> </entry>

Примечание

BodyTemplate Является обязательным, как X-WindowsPhone-Target заголовка.

Ответ

Ответ включает код состояния HTTP и набор заголовков ответа.

Коды ответа

код Описание
201 Регистрация успешно создана.
400 Недопустимый текст запроса. Не удалось создать регистрацию, поскольку используется неправильный формат запроса.
401 Ошибка авторизации. Неверный ключ доступа.
403 Превышена квота. Слишком много регистраций в этом пространстве имен. Регистрация не создана.
403 Запрос отклонен, поскольку частота выполнения операций регистрации слишком высока.

Сведения о кодах состояния см. в разделе коды состояний и ошибок.

Заголовки ответа

Заголовок ответа Описание
Тип содержимого application/atom+xml;type=entry;charset=utf-8
ETag {ненадежный ETag}

Текст ответа

При успешном выполнение возвращается проверенная запись Atom. Это включает элементы, доступные только для чтения, такие как ETag, RegistrationId, и ExpirationTime. Например:

<entry> <id>https://{tenant}.servicebus.windows.net/{NotificationHub}/registrations/{registrationId}</id> <title type="text"> /{NotificationHub}/registrations/{registrationId}</title> <updated>2012-08-17T17:32:00Z</updated> <metadata:etag>{weak Etag}</metadata:etag> <content type="application/xml"> <WindowsRegistrationDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.microsoft.com/netservices/2010/10/servicebus/connect"> <ETag>{ETag}</ETag> <ExpirationTime>2012-07-16T19:20+01:00</ExpirationTime> <RegistrationId>{RegistrationId}</RegistrationId> <Tags>myTag, myOtherTag</Tags> <ChannelUri>{ChannelUri}</ChannelUri> </WindowsRegistrationDescription> </content> </entry>