IotDpsResource interface

Balíček:

@azure/arm-deviceprovisioningservices

Rozhraní představující IotDpsResource.

Metody

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Vytvořte nebo aktualizujte metadata služby zřizování. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat služby zřizování a metadat zabezpečení a jejich následná kombinace s upravenými hodnotami v novém textu za účelem aktualizace služby zřizování.
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Vytvořte nebo aktualizujte metadata služby zřizování. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat služby zřizování a metadat zabezpečení a jejich následná kombinace s upravenými hodnotami v novém textu za účelem aktualizace služby zřizování.
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Vytvoření nebo aktualizace stavu připojení privátního koncového bodu se zadaným názvem
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Vytvoření nebo aktualizace stavu připojení privátního koncového bodu se zadaným názvem
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)	Odstraní službu zřizování.
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)	Odstraní službu zřizování.
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Odstranění připojení privátního koncového bodu se zadaným názvem
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Odstranění připojení privátního koncového bodu se zadaným názvem
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Aktualizujte značky existující služby zřizování. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Aktualizace značek existující služby zřizování Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)	Zkontrolujte, jestli je k dispozici název služby zřizování. Tím se ověří, jestli je název syntakticky platný a jestli je použitelný.
get(string, string, IotDpsResourceGetOptionalParams)	Získejte metadata služby zřizování bez klíčů SAS.
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)	Získá stav dlouhotrvající operace, jako je vytvoření, aktualizace nebo odstranění služby zřizování.
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)	Získání vlastností připojení privátního koncového bodu
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)	Získání zadaného prostředku privátního propojení pro danou službu zřizování
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)	Získejte seznam všech služeb zřizování v dané skupině prostředků.
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)	Vypíše všechny služby zřizování pro dané ID předplatného.
listKeys(string, string, IotDpsResourceListKeysOptionalParams)	Uveďte seznam primárních a sekundárních klíčů pro službu zřizování.
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)	Výpis primárních a sekundárních klíčů pro konkrétní název klíče
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)	Výpis vlastností připojení privátního koncového bodu
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)	Výpis prostředků privátního propojení pro danou službu zřizování
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)	Získá seznam platných skladových položek a úrovní pro službu zřizování.

Podrobnosti metody

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby zřizování. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat služby zřizování a metadat zabezpečení a jejich následná kombinace s upravenými hodnotami v novém textu za účelem aktualizace služby zřizování.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

provisioningServiceName

string

Název služby zřizování, která se má vytvořit nebo aktualizovat.

iotDpsDescription

ProvisioningServiceDescription

Popis služby zřizování, která se má vytvořit nebo aktualizovat.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parametry možností

Návraty

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

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby zřizování. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat služby zřizování a metadat zabezpečení a jejich následná kombinace s upravenými hodnotami v novém textu za účelem aktualizace služby zřizování.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

provisioningServiceName

string

Název služby zřizování, která se má vytvořit nebo aktualizovat.

iotDpsDescription

ProvisioningServiceDescription

Popis služby zřizování, která se má vytvořit nebo aktualizovat.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parametry možností

Návraty

Promise<ProvisioningServiceDescription>

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

Vytvoření nebo aktualizace stavu připojení privátního koncového bodu se zadaným názvem

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

privateEndpointConnectionName

string

Název připojení privátního koncového bodu

privateEndpointConnection

PrivateEndpointConnection

Připojení privátního koncového bodu s aktualizovanými vlastnostmi

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parametry možností

Návraty

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

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

Vytvoření nebo aktualizace stavu připojení privátního koncového bodu se zadaným názvem

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

privateEndpointConnectionName

string

Název připojení privátního koncového bodu

privateEndpointConnection

PrivateEndpointConnection

Připojení privátního koncového bodu s aktualizovanými vlastnostmi

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parametry možností

Návraty

Promise<PrivateEndpointConnection>

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Odstraní službu zřizování.

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

Parametry

provisioningServiceName

string

Název služby zřizování, která se má odstranit.

resourceGroupName

string

Identifikátor skupiny prostředků.

options

IotDpsResourceDeleteOptionalParams

Parametry možností

Návraty

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

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Odstraní službu zřizování.

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

Parametry

provisioningServiceName

string

Název služby zřizování, která se má odstranit.

resourceGroupName

string

Identifikátor skupiny prostředků.

options

IotDpsResourceDeleteOptionalParams

Parametry možností

Návraty

Promise<void>

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Odstranění připojení privátního koncového bodu se zadaným názvem

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

privateEndpointConnectionName

string

Název připojení privátního koncového bodu

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parametry možností

Návraty

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

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Odstranění připojení privátního koncového bodu se zadaným názvem

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

privateEndpointConnectionName

string

Název připojení privátního koncového bodu

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parametry možností

Návraty

Promise<PrivateEndpointConnection>

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Aktualizujte značky existující služby zřizování. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

provisioningServiceName

string

Název služby zřizování, která se má vytvořit nebo aktualizovat.

provisioningServiceTags

TagsResource

Aktualizace informací o značkách pro nastavení do instance služby zřizování

options

IotDpsResourceUpdateOptionalParams

Parametry možností.

Návraty

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

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Aktualizace značek existující služby zřizování Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

provisioningServiceName

string

Název služby zřizování, která se má vytvořit nebo aktualizovat.

provisioningServiceTags

TagsResource

Aktualizace informací o značkách pro nastavení do instance služby zřizování

options

IotDpsResourceUpdateOptionalParams

Parametry možností.

Návraty

Promise<ProvisioningServiceDescription>

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Zkontrolujte, jestli je k dispozici název služby zřizování. Tím se ověří, jestli je název syntakticky platný a jestli je použitelný.

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

Parametry

argumentsParam

OperationInputs

Nastavte parametr name ve struktuře OperationInputs na název služby zřizování, který chcete zkontrolovat.

options

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Parametry možností.

Návraty

Promise<NameAvailabilityInfo>

get(string, string, IotDpsResourceGetOptionalParams)

Získejte metadata služby zřizování bez klíčů SAS.

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

Parametry

provisioningServiceName

string

Název služby zřizování, která se má načíst.

resourceGroupName

string

Název skupiny prostředků.

options

IotDpsResourceGetOptionalParams

Parametry možností.

Návraty

Promise<ProvisioningServiceDescription>

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

Získá stav dlouhotrvající operace, jako je vytvoření, aktualizace nebo odstranění služby zřizování.

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

Parametry

operationId

string

ID operace odpovídající dlouhotrvající operaci. Pomocí této možnosti se můžete dotazovat na stav.

resourceGroupName

string

Identifikátor skupiny prostředků.

provisioningServiceName

string

Název služby zřizování, ve které je operace spuštěná.

asyncinfo

string

Asynchronní hlavička použitá k dotazování na stav operace získaná při vytváření dlouhotrvající operace.

options

IotDpsResourceGetOperationResultOptionalParams

Parametry možností.

Návraty

Promise<AsyncOperationResult>

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Získání vlastností připojení privátního koncového bodu

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

privateEndpointConnectionName

string

Název připojení privátního koncového bodu

options

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Parametry možností.

Návraty

Promise<PrivateEndpointConnection>

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Získání zadaného prostředku privátního propojení pro danou službu zřizování

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

groupId

string

Název prostředku privátního propojení

options

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Parametry možností.

Návraty

Promise<GroupIdInformation>

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Získejte seznam všech služeb zřizování v dané skupině prostředků.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

options

IotDpsResourceListByResourceGroupOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

Vypíše všechny služby zřizování pro dané ID předplatného.

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

Parametry

options

IotDpsResourceListBySubscriptionOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

Uveďte seznam primárních a sekundárních klíčů pro službu zřizování.

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

Parametry

provisioningServiceName

string

Název služby zřizování, pro který se mají získat sdílené přístupové klíče.

resourceGroupName

string

název skupiny prostředků

options

IotDpsResourceListKeysOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

Výpis primárních a sekundárních klíčů pro konkrétní název klíče

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

Parametry

provisioningServiceName

string

Název služby zřizování.

keyName

string

Název logického klíče, pro který se mají získat hodnoty klíče.

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

options

IotDpsResourceListKeysForKeyNameOptionalParams

Parametry možností.

Návraty

Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

Výpis vlastností připojení privátního koncového bodu

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

options

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Parametry možností.

Návraty

Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

Výpis prostředků privátního propojení pro danou službu zřizování

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje službu zřizování.

resourceName

string

Název služby zřizování.

options

IotDpsResourceListPrivateLinkResourcesOptionalParams

Parametry možností.

Návraty

Promise<PrivateLinkResources>

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Získá seznam platných skladových položek a úrovní pro službu zřizování.

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

Parametry

provisioningServiceName

string

Název služby zřizování.

resourceGroupName

string

Název skupiny prostředků.

options

IotDpsResourceListValidSkusOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>