IotDpsResource interface
Schnittstelle, die eine IotDpsResource darstellt.
Methoden
| begin |
Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten des Bereitstellungsdiensts und die Sicherheitsmetadaten abzurufen und diese dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den Bereitstellungsdienst zu aktualisieren. |
| begin |
Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten des Bereitstellungsdiensts und die Sicherheitsmetadaten abzurufen und diese dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den Bereitstellungsdienst zu aktualisieren. |
| begin |
Erstellen oder Aktualisieren des Status einer privaten Endpunktverbindung mit dem angegebenen Namen |
| begin |
Erstellen oder Aktualisieren des Status einer privaten Endpunktverbindung mit dem angegebenen Namen |
| begin |
Löscht den Bereitstellungsdienst. |
| begin |
Löscht den Bereitstellungsdienst. |
| begin |
Löschen einer privaten Endpunktverbindung mit dem angegebenen Namen |
| begin |
Löschen einer privaten Endpunktverbindung mit dem angegebenen Namen |
| begin |
Aktualisieren Sie die Tags eines vorhandenen Bereitstellungsdiensts. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode |
| begin |
Aktualisieren Sie die Tags eines vorhandenen Bereitstellungsdiensts. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode |
| check |
Überprüfen Sie, ob ein Bereitstellungsdienstname verfügbar ist. Dadurch wird überprüft, ob der Name syntaktisch gültig ist und ob der Name verwendbar ist. |
| get(string, string, Iot |
Rufen Sie die Metadaten des Bereitstellungsdiensts ohne SAS-Schlüssel ab. |
| get |
Ruft den Status eines Vorgangs mit langer Ausführung ab, z. B. erstellen, aktualisieren oder löschen eines Bereitstellungsdiensts. |
| get |
Abrufen von Verbindungseigenschaften für private Endpunkte |
| get |
Abrufen der angegebenen Private Link-Ressource für den angegebenen Bereitstellungsdienst |
| list |
Rufen Sie eine Liste aller Bereitstellungsdienste in der angegebenen Ressourcengruppe ab. |
| list |
Listet alle Bereitstellungsdienste für eine bestimmte Abonnement-ID auf. |
| list |
Listen Sie die primären und sekundären Schlüssel für einen Bereitstellungsdienst auf. |
| list |
Auflisten von Primär- und Sekundärschlüsseln für einen bestimmten Schlüsselnamen |
| list |
Auflisten von Verbindungseigenschaften für private Endpunkte |
| list |
Auflisten von Private Link-Ressourcen für den angegebenen Bereitstellungsdienst |
| list |
Ruft die Liste der gültigen SKUs und Ebenen für einen Bereitstellungsdienst ab. |
Details zur Methode
beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten des Bereitstellungsdiensts und die Sicherheitsmetadaten abzurufen und diese dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den Bereitstellungsdienst zu aktualisieren.
function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parameter
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
- provisioningServiceName
-
string
Name des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
- iotDpsDescription
- ProvisioningServiceDescription
Beschreibung des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
Die Optionsparameter.
Gibt zurück
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten des Bereitstellungsdiensts und die Sicherheitsmetadaten abzurufen und diese dann mit den geänderten Werten in einem neuen Textkörper zu kombinieren, um den Bereitstellungsdienst zu aktualisieren.
function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parameter
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
- provisioningServiceName
-
string
Name des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
- iotDpsDescription
- ProvisioningServiceDescription
Beschreibung des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
Die Optionsparameter.
Gibt zurück
Promise<ProvisioningServiceDescription>
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Erstellen oder Aktualisieren des Status einer privaten Endpunktverbindung mit dem angegebenen Namen
function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- privateEndpointConnectionName
-
string
Der Name der verbindung mit dem privaten Endpunkt
- privateEndpointConnection
- PrivateEndpointConnection
Die Verbindung des privaten Endpunkts mit aktualisierten Eigenschaften
Die Optionsparameter.
Gibt zurück
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Erstellen oder Aktualisieren des Status einer privaten Endpunktverbindung mit dem angegebenen Namen
function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- privateEndpointConnectionName
-
string
Der Name der verbindung mit dem privaten Endpunkt
- privateEndpointConnection
- PrivateEndpointConnection
Die Verbindung des privaten Endpunkts mit aktualisierten Eigenschaften
Die Optionsparameter.
Gibt zurück
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
Löscht den Bereitstellungsdienst.
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameter
- provisioningServiceName
-
string
Name des zu löschenden Bereitstellungsdiensts.
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
Die Optionsparameter.
Gibt zurück
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)
Löscht den Bereitstellungsdienst.
function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>Parameter
- provisioningServiceName
-
string
Name des zu löschenden Bereitstellungsdiensts.
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
Die Optionsparameter.
Gibt zurück
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Löschen einer privaten Endpunktverbindung mit dem angegebenen Namen
function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- privateEndpointConnectionName
-
string
Der Name der verbindung mit dem privaten Endpunkt
Die Optionsparameter.
Gibt zurück
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Löschen einer privaten Endpunktverbindung mit dem angegebenen Namen
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- privateEndpointConnectionName
-
string
Der Name der verbindung mit dem privaten Endpunkt
Die Optionsparameter.
Gibt zurück
Promise<PrivateEndpointConnection>
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Aktualisieren Sie die Tags eines vorhandenen Bereitstellungsdiensts. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode
function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Parameter
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
- provisioningServiceName
-
string
Name des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
- provisioningServiceTags
- TagsResource
Die Taginformationen wurden aktualisiert, um sie in der Bereitstellungsdienstinstanz festzulegen.
Die Optionsparameter.
Gibt zurück
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Aktualisieren Sie die Tags eines vorhandenen Bereitstellungsdiensts. Um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode
function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>Parameter
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
- provisioningServiceName
-
string
Name des zu erstellenden oder zu aktualisierenden Bereitstellungsdiensts.
- provisioningServiceTags
- TagsResource
Die Taginformationen wurden aktualisiert, um sie in der Bereitstellungsdienstinstanz festzulegen.
Die Optionsparameter.
Gibt zurück
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
Überprüfen Sie, ob ein Bereitstellungsdienstname verfügbar ist. Dadurch wird überprüft, ob der Name syntaktisch gültig ist und ob der Name verwendbar ist.
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>Parameter
- argumentsParam
- OperationInputs
Legen Sie den name-Parameter in der Struktur OperationInputs auf den Namen des zu überprüfenden Bereitstellungsdiensts fest.
Die Optionsparameter.
Gibt zurück
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
Rufen Sie die Metadaten des Bereitstellungsdiensts ohne SAS-Schlüssel ab.
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>Parameter
- provisioningServiceName
-
string
Name des abzurufenden Bereitstellungsdiensts.
- resourceGroupName
-
string
Ressourcengruppenname
- options
- IotDpsResourceGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<ProvisioningServiceDescription>
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)
Ruft den Status eines Vorgangs mit langer Ausführung ab, z. B. erstellen, aktualisieren oder löschen eines Bereitstellungsdiensts.
function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>Parameter
- operationId
-
string
Vorgangs-ID, die dem vorgang mit langer Ausführungsdauer entspricht. Verwenden Sie diese Option, um den Status abzufragen.
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
- provisioningServiceName
-
string
Name des Bereitstellungsdiensts, auf dem der Vorgang ausgeführt wird.
- asyncinfo
-
string
Asynchroner Header, der verwendet wird, um den Status des Vorgangs abzufragen, der beim Erstellen des Vorgangs mit langer Ausführung abgerufen wird.
Die Optionsparameter.
Gibt zurück
Promise<AsyncOperationResult>
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)
Abrufen von Verbindungseigenschaften für private Endpunkte
function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- privateEndpointConnectionName
-
string
Der Name der verbindung mit dem privaten Endpunkt
Die Optionsparameter.
Gibt zurück
Promise<PrivateEndpointConnection>
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)
Abrufen der angegebenen Private Link-Ressource für den angegebenen Bereitstellungsdienst
function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
- groupId
-
string
Der Name der Private Link-Ressource
Die Optionsparameter.
Gibt zurück
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
Rufen Sie eine Liste aller Bereitstellungsdienste in der angegebenen Ressourcengruppe ab.
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parameter
- resourceGroupName
-
string
Ressourcengruppenbezeichner.
Die Optionsparameter.
Gibt zurück
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
Listet alle Bereitstellungsdienste für eine bestimmte Abonnement-ID auf.
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Parameter
Die Optionsparameter.
Gibt zurück
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
Listen Sie die primären und sekundären Schlüssel für einen Bereitstellungsdienst auf.
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>Parameter
- provisioningServiceName
-
string
Der Name des Bereitstellungsdiensts, für den die freigegebenen Zugriffsschlüssel abgerufen werden sollen.
- resourceGroupName
-
string
Ressourcengruppenname
Die Optionsparameter.
Gibt zurück
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
Auflisten von Primär- und Sekundärschlüsseln für einen bestimmten Schlüsselnamen
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>Parameter
- provisioningServiceName
-
string
Name des Bereitstellungsdiensts.
- keyName
-
string
Name des logischen Schlüssels, für den Schlüsselwerte abgerufen werden sollen.
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
Die Optionsparameter.
Gibt zurück
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
Auflisten von Verbindungseigenschaften für private Endpunkte
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
Die Optionsparameter.
Gibt zurück
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
Auflisten von Private Link-Ressourcen für den angegebenen Bereitstellungsdienst
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe, die den Bereitstellungsdienst enthält.
- resourceName
-
string
Der Name des Bereitstellungsdiensts.
Die Optionsparameter.
Gibt zurück
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
Ruft die Liste der gültigen SKUs und Ebenen für einen Bereitstellungsdienst ab.
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>Parameter
- provisioningServiceName
-
string
Name des Bereitstellungsdiensts.
- resourceGroupName
-
string
Name der Ressourcengruppe
Die Optionsparameter.