IotDpsResource interface
Interfejs reprezentujący element IotDpsResource.
Metody
Szczegóły metody
beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Utwórz lub zaktualizuj metadane usługi aprowizacji. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych usługi aprowizacji i metadanych zabezpieczeń, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania usługi aprowizacji.
function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do utworzenia lub zaktualizowania.
- iotDpsDescription
- ProvisioningServiceDescription
Opis usługi aprowizacji w celu utworzenia lub zaktualizowania.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Utwórz lub zaktualizuj metadane usługi aprowizacji. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych usługi aprowizacji i metadanych zabezpieczeń, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania usługi aprowizacji.
function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do utworzenia lub zaktualizowania.
- iotDpsDescription
- ProvisioningServiceDescription
Opis usługi aprowizacji w celu utworzenia lub zaktualizowania.
Parametry opcji.
Zwraca
Promise<ProvisioningServiceDescription>
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Tworzenie lub aktualizowanie stanu połączenia prywatnego punktu końcowego z określoną nazwą
function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- privateEndpointConnectionName
-
string
Nazwa połączenia prywatnego punktu końcowego
- privateEndpointConnection
- PrivateEndpointConnection
Połączenie prywatnego punktu końcowego ze zaktualizowanymi właściwościami
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Tworzenie lub aktualizowanie stanu połączenia prywatnego punktu końcowego z określoną nazwą
function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- privateEndpointConnectionName
-
string
Nazwa połączenia prywatnego punktu końcowego
- privateEndpointConnection
- PrivateEndpointConnection
Połączenie prywatnego punktu końcowego ze zaktualizowanymi właściwościami
Parametry opcji.
Zwraca
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
Usuwa usługę Provisioning Service.
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do usunięcia.
- resourceGroupName
-
string
Identyfikator grupy zasobów.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)
Usuwa usługę Provisioning Service.
function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do usunięcia.
- resourceGroupName
-
string
Identyfikator grupy zasobów.
Parametry opcji.
Zwraca
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Usuwanie połączenia prywatnego punktu końcowego z określoną nazwą
function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- privateEndpointConnectionName
-
string
Nazwa połączenia prywatnego punktu końcowego
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Usuwanie połączenia prywatnego punktu końcowego z określoną nazwą
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- privateEndpointConnectionName
-
string
Nazwa połączenia prywatnego punktu końcowego
Parametry opcji.
Zwraca
Promise<PrivateEndpointConnection>
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Aktualizowanie tagów istniejącej usługi aprowizacji. aby zaktualizować inne pola, użyj metody CreateOrUpdate
function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do utworzenia lub zaktualizowania.
- provisioningServiceTags
- TagsResource
Zaktualizowano informacje o tagach, aby ustawić je w wystąpieniu usługi aprowizacji.
Parametry opcji.
Zwraca
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Aktualizowanie tagów istniejącej usługi aprowizacji. aby zaktualizować inne pola, użyj metody CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do utworzenia lub zaktualizowania.
- provisioningServiceTags
- TagsResource
Zaktualizowano informacje o tagach, aby ustawić je w wystąpieniu usługi aprowizacji.
Parametry opcji.
Zwraca
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
Sprawdź, czy nazwa usługi aprowizacji jest dostępna. Spowoduje to sprawdzenie, czy nazwa jest prawidłowa składniowo i czy nazwa może być używana
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>Parametry
- argumentsParam
- OperationInputs
Ustaw parametr name w strukturze OperationInputs na nazwę usługi aprowizacji, aby sprawdzić.
Parametry opcji.
Zwraca
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
Pobieranie metadanych usługi aprowizacji bez kluczy SAS.
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji do pobrania.
- resourceGroupName
-
string
Nazwa grupy zasobów.
- options
- IotDpsResourceGetOptionalParams
Parametry opcji.
Zwraca
Promise<ProvisioningServiceDescription>
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)
Pobiera stan długotrwałej operacji, takiej jak tworzenie, aktualizowanie lub usuwanie usługi aprowizacji.
function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>Parametry
- operationId
-
string
Identyfikator operacji odpowiadający długotrwałej operacji. Użyj tego polecenia, aby sondować stan.
- resourceGroupName
-
string
Identyfikator grupy zasobów.
- provisioningServiceName
-
string
Nazwa usługi aprowizacji, na którym jest uruchomiona operacja.
- asyncinfo
-
string
Nagłówek asynchroniczny używany do sondowania stanu operacji uzyskany podczas tworzenia długotrwałej operacji.
Parametry opcji.
Zwraca
Promise<AsyncOperationResult>
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)
Pobieranie właściwości połączenia prywatnego punktu końcowego
function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- privateEndpointConnectionName
-
string
Nazwa połączenia prywatnego punktu końcowego
Parametry opcji.
Zwraca
Promise<PrivateEndpointConnection>
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)
Pobieranie określonego zasobu łącza prywatnego dla danej usługi aprowizacji
function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
- groupId
-
string
Nazwa zasobu łącza prywatnego
Parametry opcji.
Zwraca
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
Pobierz listę wszystkich usług aprowizacji w danej grupie zasobów.
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parametry
- resourceGroupName
-
string
Identyfikator grupy zasobów.
Parametry opcji.
Zwraca
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
Wyświetl listę wszystkich usług aprowizacji dla danego identyfikatora subskrypcji.
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parametry
Parametry opcji.
Zwraca
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
Wyświetl listę kluczy podstawowych i pomocniczych dla usługi aprowizacji.
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji w celu pobrania kluczy dostępu współużytkowanego.
- resourceGroupName
-
string
nazwa grupy zasobów
Parametry opcji.
Zwraca
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
Wyświetlanie listy kluczy podstawowych i pomocniczych dla określonej nazwy klucza
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji.
- keyName
-
string
Nazwa klucza logicznego w celu pobrania wartości klucza.
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
Parametry opcji.
Zwraca
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
Wyświetlanie listy właściwości połączenia prywatnego punktu końcowego
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
Parametry opcji.
Zwraca
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
Wyświetlanie listy zasobów łącza prywatnego dla danej usługi aprowizacji
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów, która zawiera usługę aprowizacji.
- resourceName
-
string
Nazwa usługi aprowizacji.
Parametry opcji.
Zwraca
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
Pobiera listę prawidłowych jednostek SKU i warstw dla usługi aprowizacji.
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>Parametry
- provisioningServiceName
-
string
Nazwa usługi aprowizacji.
- resourceGroupName
-
string
Nazwa grupy zasobów.
Parametry opcji.