Capacities - Update

Service:: Power BI Embedded

Version d'API:: 2021-01-01

Met à jour l’état actuel de la capacité dédiée spécifiée.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}?api-version=2021-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dedicatedCapacityName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Nom de la capacité dédiée. Il doit s’agir d’un minimum de 3 caractères et d’un maximum de 63.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
sku	CapacitySku	Référence SKU de la ressource de capacité dédiée.
tags	object	Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

Réponses

Nom	Type	Description
200 OK	DedicatedCapacity	L’opération Azure s’est terminée avec succès.
202 Accepted	DedicatedCapacity	La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

DedicatedCapacity

L’opération Azure s’est terminée avec succès.

202 Accepted

DedicatedCapacity

La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.

En-têtes

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Update capacity parameters

Update capacity to Generation 2

Update capacity parameters

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    }
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "name": "azsdktest",
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "systemData": {
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "createdBy": "user1",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Code d’état:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

{
  "name": "azsdktest",
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "systemData": {
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "createdBy": "user1",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Update capacity to Generation 2

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "properties": {
    "mode": "Gen2"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "name": "azsdktest",
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "systemData": {
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "createdBy": "user1",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Code d’état:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

{
  "name": "azsdktest",
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "systemData": {
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "createdBy": "user1",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Définitions

Nom	Description
CapacityProvisioningState	État actuel du déploiement de la ressource Dédiée PowerBI. ProvisioningState consiste à indiquer les états d’approvisionnement des ressources.
CapacitySku	Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource de capacité dédiée PowerBI.
CapacitySkuTier	Nom du niveau tarifaire Azure auquel la référence SKU s’applique.
createdByType	Type d’identité qui a créé la ressource.
DedicatedCapacity	Représente une instance d’une ressource de capacité dédiée.
DedicatedCapacityAdministrators	Tableau d’identités utilisateur d’administrateur
DedicatedCapacityUpdateParameters	Spécification de la demande d’approvisionnement
Error	Objet d’erreur.
ErrorResponse	Objet d’erreur
Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
State	État actuel de la ressource Dédiée PowerBI. L’état consiste à indiquer plus d’états en dehors du provisionnement des ressources.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CapacityProvisioningState

Énumération

État actuel du déploiement de la ressource Dédiée PowerBI. ProvisioningState consiste à indiquer les états d’approvisionnement des ressources.

Valeur	Description
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

CapacitySku

Object

Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource de capacité dédiée PowerBI.

Nom	Type	Description
capacity	integer (int32)	Capacité de la référence SKU.
name	string	Nom du niveau de référence SKU.
tier	CapacitySkuTier	Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

CapacitySkuTier

Énumération

Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

Valeur	Description
PBIE_Azure
Premium
AutoPremiumHost

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DedicatedCapacity

Object

Représente une instance d’une ressource de capacité dédiée.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.friendlyName	string	Nom de la capacité
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
properties.provisioningState	CapacityProvisioningState	État actuel du déploiement de la ressource Dédiée PowerBI. ProvisioningState consiste à indiquer les états d’approvisionnement des ressources.
properties.state	State	État actuel de la ressource Dédiée PowerBI. L’état consiste à indiquer plus d’états en dehors du provisionnement des ressources.
properties.tenantId	string	ID de locataire pour la capacité. Utilisé pour créer une capacité Pro Plus.
sku	CapacitySku	Référence SKU de la ressource de capacité dédiée PowerBI.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DedicatedCapacityAdministrators

Object

Tableau d’identités utilisateur d’administrateur

Nom	Type	Description
members	string[]	Tableau d’identités utilisateur d’administrateur.

DedicatedCapacityUpdateParameters

Object

Spécification de la demande d’approvisionnement

Nom	Type	Description
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.friendlyName	string	Nom de la capacité
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
properties.tenantId	string	ID de locataire pour la capacité. Utilisé pour créer une capacité Pro Plus.
sku	CapacitySku	Référence SKU de la ressource de capacité dédiée.
tags	object	Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

Object

Objet d’erreur

Nom	Type	Description
error	Error	Objet d’erreur.

Mode

Énumération

Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus

Valeur	Description
Gen1
Gen2

State

Énumération

État actuel de la ressource Dédiée PowerBI. L’état consiste à indiquer plus d’états en dehors du provisionnement des ressources.

Valeur	Description
Deleting
Succeeded
Failed
Paused
Suspended
Provisioning
Updating
Suspending
Pausing
Resuming
Preparing
Scaling

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Capacities - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Update capacity parameters

Exemple de requête

Exemple de réponse

Update capacity to Generation 2

Exemple de requête

Exemple de réponse

Définitions

CapacityProvisioningState

CapacitySku

CapacitySkuTier

createdByType

DedicatedCapacity

DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

Error

ErrorResponse

Mode

State

systemData