IotDpsResource interface

Пакет:

@azure/arm-deviceprovisioningservices

Интерфейс, представляющий IotDpsResource.

Методы

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Создайте или обновите метаданные службы подготовки. Обычный шаблон изменения свойства — получить метаданные службы подготовки и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления службы подготовки.
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Создайте или обновите метаданные службы подготовки. Обычный шаблон изменения свойства — получить метаданные службы подготовки и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления службы подготовки.
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Создание или обновление состояния подключения частной конечной точки с указанным именем
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Создание или обновление состояния подключения частной конечной точки с указанным именем
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)	Удаляет службу подготовки.
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)	Удаляет службу подготовки.
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Удаление подключения частной конечной точки с указанным именем
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Удаление подключения частной конечной точки с указанным именем
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Обновите теги существующей службы подготовки. для обновления других полей используйте метод CreateOrUpdate
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Обновите теги существующей службы подготовки. для обновления других полей используйте метод CreateOrUpdate
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)	Проверьте, доступно ли имя службы подготовки. Это позволит проверить, является ли имя синтаксически допустимым и если имя доступно для использования.
get(string, string, IotDpsResourceGetOptionalParams)	Получение метаданных службы подготовки без ключей SAS.
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)	Возвращает состояние длительной операции, например создание, обновление или удаление службы подготовки.
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)	Получение свойств подключения к частной конечной точке
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)	Получение указанного ресурса приватного канала для данной службы подготовки
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)	Получите список всех служб подготовки в данной группе ресурсов.
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)	Список всех служб подготовки для заданного идентификатора подписки.
listKeys(string, string, IotDpsResourceListKeysOptionalParams)	Вывод списка первичных и вторичных ключей для службы подготовки.
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)	Вывод списка первичных и вторичных ключей для определенного имени ключа
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)	Перечисление свойств подключения к частной конечной точке
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)	Вывод списка ресурсов приватного канала для данной службы подготовки
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)	Возвращает список допустимых номеров SKU и уровней для службы подготовки.

Сведения о методе

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Создайте или обновите метаданные службы подготовки. Обычный шаблон изменения свойства — получить метаданные службы подготовки и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления службы подготовки.

function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Параметры

resourceGroupName

string

Идентификатор группы ресурсов.

provisioningServiceName

string

Имя службы подготовки для создания или обновления.

iotDpsDescription

ProvisioningServiceDescription

Описание службы подготовки для создания или обновления.

options

IotDpsResourceCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Создайте или обновите метаданные службы подготовки. Обычный шаблон изменения свойства — получить метаданные службы подготовки и метаданные безопасности, а затем объединить их с измененными значениями в новом тексте для обновления службы подготовки.

function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Параметры

resourceGroupName

string

Идентификатор группы ресурсов.

provisioningServiceName

string

Имя службы подготовки для создания или обновления.

iotDpsDescription

ProvisioningServiceDescription

Описание службы подготовки для создания или обновления.

options

IotDpsResourceCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ProvisioningServiceDescription>

beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Создание или обновление состояния подключения частной конечной точки с указанным именем

function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

privateEndpointConnectionName

string

Имя подключения к частной конечной точке

privateEndpointConnection

PrivateEndpointConnection

Подключение частной конечной точки с обновленными свойствами

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Создание или обновление состояния подключения частной конечной точки с указанным именем

function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

privateEndpointConnectionName

string

Имя подключения к частной конечной точке

privateEndpointConnection

PrivateEndpointConnection

Подключение частной конечной точки с обновленными свойствами

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PrivateEndpointConnection>

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Удаляет службу подготовки.

function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Параметры

provisioningServiceName

string

Имя службы подготовки для удаления.

resourceGroupName

string

Идентификатор группы ресурсов.

options

IotDpsResourceDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Удаляет службу подготовки.

function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>

Параметры

provisioningServiceName

string

Имя службы подготовки для удаления.

resourceGroupName

string

Идентификатор группы ресурсов.

options

IotDpsResourceDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Удаление подключения частной конечной точки с указанным именем

function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

privateEndpointConnectionName

string

Имя подключения к частной конечной точке

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Удаление подключения частной конечной точки с указанным именем

function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

privateEndpointConnectionName

string

Имя подключения к частной конечной точке

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PrivateEndpointConnection>

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Обновите теги существующей службы подготовки. для обновления других полей используйте метод CreateOrUpdate

function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Параметры

resourceGroupName

string

Идентификатор группы ресурсов.

provisioningServiceName

string

Имя службы подготовки для создания или обновления.

provisioningServiceTags

TagsResource

Обновлены сведения о теге, которые необходимо задать в экземпляр службы подготовки.

options

IotDpsResourceUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Обновите теги существующей службы подготовки. для обновления других полей используйте метод CreateOrUpdate

function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Параметры

resourceGroupName

string

Идентификатор группы ресурсов.

provisioningServiceName

string

Имя службы подготовки для создания или обновления.

provisioningServiceTags

TagsResource

Обновлены сведения о теге, которые необходимо задать в экземпляр службы подготовки.

options

IotDpsResourceUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ProvisioningServiceDescription>

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Проверьте, доступно ли имя службы подготовки. Это позволит проверить, является ли имя синтаксически допустимым и если имя доступно для использования.

function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>

Параметры

argumentsParam

OperationInputs

Задайте параметр имени в структуре OperationInputs именем проверяемой службы подготовки.

options

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<NameAvailabilityInfo>

get(string, string, IotDpsResourceGetOptionalParams)

Получение метаданных службы подготовки без ключей SAS.

function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>

Параметры

provisioningServiceName

string

Имя службы подготовки для получения.

resourceGroupName

string

Имя группы ресурсов.

options

IotDpsResourceGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ProvisioningServiceDescription>

getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)

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

function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>

Параметры

operationId

string

Идентификатор операции, соответствующий длительной операции. Используйте это для опроса состояния.

resourceGroupName

string

Идентификатор группы ресурсов.

provisioningServiceName

string

Имя службы подготовки, в которую выполняется операция.

asyncinfo

string

Асинхронный заголовок, используемый для опроса состояния операции, полученного при создании длительной операции.

options

IotDpsResourceGetOperationResultOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<AsyncOperationResult>

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Получение свойств подключения к частной конечной точке

function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

privateEndpointConnectionName

string

Имя подключения к частной конечной точке

options

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PrivateEndpointConnection>

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Получение указанного ресурса приватного канала для данной службы подготовки

function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

groupId

string

Имя ресурса приватного канала

options

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<GroupIdInformation>

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Получите список всех служб подготовки в данной группе ресурсов.

function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

Параметры

resourceGroupName

string

Идентификатор группы ресурсов.

options

IotDpsResourceListByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

Список всех служб подготовки для заданного идентификатора подписки.

function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

Параметры

options

IotDpsResourceListBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

Вывод списка первичных и вторичных ключей для службы подготовки.

function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

Параметры

provisioningServiceName

string

Имя службы подготовки для получения ключей общего доступа.

resourceGroupName

string

Имя группы ресурсов

options

IotDpsResourceListKeysOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

Вывод списка первичных и вторичных ключей для определенного имени ключа

function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

Параметры

provisioningServiceName

string

Имя службы подготовки.

keyName

string

Имя логического ключа для получения значений ключей.

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

options

IotDpsResourceListKeysForKeyNameOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

Перечисление свойств подключения к частной конечной точке

function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

options

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

Вывод списка ресурсов приватного канала для данной службы подготовки

function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>

Параметры

resourceGroupName

string

Имя группы ресурсов, содержащей службу подготовки.

resourceName

string

Имя службы подготовки.

options

IotDpsResourceListPrivateLinkResourcesOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<PrivateLinkResources>

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Возвращает список допустимых номеров SKU и уровней для службы подготовки.

function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>

Параметры

provisioningServiceName

string

Имя службы подготовки.

resourceGroupName

string

Имя группы ресурсов.

options

IotDpsResourceListValidSkusOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>