IotDpsResource interface
Interface représentant un IotDpsResource.
Méthodes
| begin |
Créez ou mettez à jour les métadonnées du service d’approvisionnement. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du service d’approvisionnement et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le service d’approvisionnement. |
| begin |
Créez ou mettez à jour les métadonnées du service d’approvisionnement. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du service d’approvisionnement et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le service d’approvisionnement. |
| begin |
Créer ou mettre à jour l’état d’une connexion de point de terminaison privé avec le nom spécifié |
| begin |
Créer ou mettre à jour l’état d’une connexion de point de terminaison privé avec le nom spécifié |
| begin |
Supprime le service d’approvisionnement. |
| begin |
Supprime le service d’approvisionnement. |
| begin |
Supprimer la connexion de point de terminaison privé avec le nom spécifié |
| begin |
Supprimer la connexion de point de terminaison privé avec le nom spécifié |
| begin |
Mettez à jour les balises d’un service d’approvisionnement existant. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate |
| begin |
Mettez à jour les balises d’un service d’approvisionnement existant. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate |
| check |
Vérifiez si un nom de service d’approvisionnement est disponible. Cela valide si le nom est valide de manière syntactique et si le nom est utilisable |
| get(string, string, Iot |
Obtenez les métadonnées du service d’approvisionnement sans clés SAP. |
| get |
Obtient l’état d’une opération longue, telle que la création, la mise à jour ou la suppression d’un service d’approvisionnement. |
| get |
Obtenir les propriétés de connexion de point de terminaison privé |
| get |
Obtenir la ressource de liaison privée spécifiée pour le service d’approvisionnement donné |
| list |
Obtenez la liste de tous les services d’approvisionnement dans le groupe de ressources donné. |
| list |
Répertoriez tous les services d’approvisionnement pour un ID d’abonnement donné. |
| list |
Répertoriez les clés primaires et secondaires d’un service d’approvisionnement. |
| list |
Répertorier les clés primaires et secondaires pour un nom de clé spécifique |
| list |
Répertorier les propriétés de connexion de point de terminaison privé |
| list |
Répertorier les ressources de liaison privée pour le service d’approvisionnement donné |
| list |
Obtient la liste des références SKU et des niveaux valides pour un service d’approvisionnement. |
Détails de la méthode
beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Créez ou mettez à jour les métadonnées du service d’approvisionnement. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du service d’approvisionnement et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le service d’approvisionnement.
function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- provisioningServiceName
-
string
Nom du service d’approvisionnement à créer ou à mettre à jour.
- iotDpsDescription
- ProvisioningServiceDescription
Description du service d’approvisionnement à créer ou à mettre à jour.
Paramètres d’options.
Retours
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
Créez ou mettez à jour les métadonnées du service d’approvisionnement. Le modèle habituel de modification d’une propriété consiste à récupérer les métadonnées du service d’approvisionnement et les métadonnées de sécurité, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le service d’approvisionnement.
function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- provisioningServiceName
-
string
Nom du service d’approvisionnement à créer ou à mettre à jour.
- iotDpsDescription
- ProvisioningServiceDescription
Description du service d’approvisionnement à créer ou à mettre à jour.
Paramètres d’options.
Retours
Promise<ProvisioningServiceDescription>
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Créer ou mettre à jour l’état d’une connexion de point de terminaison privé avec le nom spécifié
function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- privateEndpointConnectionName
-
string
Nom de la connexion de point de terminaison privé
- privateEndpointConnection
- PrivateEndpointConnection
Connexion de point de terminaison privé avec des propriétés mises à jour
Paramètres d’options.
Retours
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
Créer ou mettre à jour l’état d’une connexion de point de terminaison privé avec le nom spécifié
function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- privateEndpointConnectionName
-
string
Nom de la connexion de point de terminaison privé
- privateEndpointConnection
- PrivateEndpointConnection
Connexion de point de terminaison privé avec des propriétés mises à jour
Paramètres d’options.
Retours
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
Supprime le service d’approvisionnement.
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement à supprimer.
- resourceGroupName
-
string
Identificateur du groupe de ressources.
Paramètres d’options.
Retours
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)
Supprime le service d’approvisionnement.
function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement à supprimer.
- resourceGroupName
-
string
Identificateur du groupe de ressources.
Paramètres d’options.
Retours
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Supprimer la connexion de point de terminaison privé avec le nom spécifié
function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- privateEndpointConnectionName
-
string
Nom de la connexion de point de terminaison privé
Paramètres d’options.
Retours
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
Supprimer la connexion de point de terminaison privé avec le nom spécifié
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- privateEndpointConnectionName
-
string
Nom de la connexion de point de terminaison privé
Paramètres d’options.
Retours
Promise<PrivateEndpointConnection>
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Mettez à jour les balises d’un service d’approvisionnement existant. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate
function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- provisioningServiceName
-
string
Nom du service d’approvisionnement à créer ou à mettre à jour.
- provisioningServiceTags
- TagsResource
Mise à jour des informations de balise à définir dans l’instance du service d’approvisionnement.
Paramètres d’options.
Retours
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
Mettez à jour les balises d’un service d’approvisionnement existant. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- provisioningServiceName
-
string
Nom du service d’approvisionnement à créer ou à mettre à jour.
- provisioningServiceTags
- TagsResource
Mise à jour des informations de balise à définir dans l’instance du service d’approvisionnement.
Paramètres d’options.
Retours
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
Vérifiez si un nom de service d’approvisionnement est disponible. Cela valide si le nom est valide de manière syntactique et si le nom est utilisable
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>Paramètres
- argumentsParam
- OperationInputs
Définissez le paramètre de nom dans la structure OperationInputs sur le nom du service d’approvisionnement à vérifier.
Paramètres d’options.
Retours
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
Obtenez les métadonnées du service d’approvisionnement sans clés SAP.
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement à récupérer.
- resourceGroupName
-
string
Nom du groupe de ressources.
- options
- IotDpsResourceGetOptionalParams
Paramètres d’options.
Retours
Promise<ProvisioningServiceDescription>
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)
Obtient l’état d’une opération longue, telle que la création, la mise à jour ou la suppression d’un service d’approvisionnement.
function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>Paramètres
- operationId
-
string
ID d’opération correspondant à l’opération de longue durée. Utilisez cette option pour interroger l’état.
- resourceGroupName
-
string
Identificateur du groupe de ressources.
- provisioningServiceName
-
string
Nom du service d’approvisionnement sur lequel l’opération s’exécute.
- asyncinfo
-
string
En-tête asynchrone utilisé pour interroger l’état de l’opération, obtenu lors de la création de l’opération de longue durée.
Paramètres d’options.
Retours
Promise<AsyncOperationResult>
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)
Obtenir les propriétés de connexion de point de terminaison privé
function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- privateEndpointConnectionName
-
string
Nom de la connexion de point de terminaison privé
Paramètres d’options.
Retours
Promise<PrivateEndpointConnection>
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)
Obtenir la ressource de liaison privée spécifiée pour le service d’approvisionnement donné
function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
- groupId
-
string
Nom de la ressource de liaison privée
Paramètres d’options.
Retours
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
Obtenez la liste de tous les services d’approvisionnement dans le groupe de ressources donné.
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Paramètres
- resourceGroupName
-
string
Identificateur du groupe de ressources.
Paramètres d’options.
Retours
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
Répertoriez tous les services d’approvisionnement pour un ID d’abonnement donné.
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>Paramètres
Paramètres d’options.
Retours
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
Répertoriez les clés primaires et secondaires d’un service d’approvisionnement.
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement pour lequel obtenir les clés d’accès partagé.
- resourceGroupName
-
string
nom du groupe de ressources
Paramètres d’options.
Retours
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
Répertorier les clés primaires et secondaires pour un nom de clé spécifique
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement.
- keyName
-
string
Nom de clé logique pour lequel obtenir les valeurs de clé.
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
Paramètres d’options.
Retours
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
Répertorier les propriétés de connexion de point de terminaison privé
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
Paramètres d’options.
Retours
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
Répertorier les ressources de liaison privée pour le service d’approvisionnement donné
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient le service d’approvisionnement.
- resourceName
-
string
Nom du service d’approvisionnement.
Paramètres d’options.
Retours
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
Obtient la liste des références SKU et des niveaux valides pour un service d’approvisionnement.
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>Paramètres
- provisioningServiceName
-
string
Nom du service d’approvisionnement.
- resourceGroupName
-
string
Nom du groupe de ressources.
Paramètres d’options.