Share via


Accounts - Create Or Update

Creates or updates an Azure Video Indexer account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}?api-version=2025-04-01

URI Parameters

Name In Required Type Description
accountName
path True

string

minLength: 3
maxLength: 50
pattern: ^[A-Za-z0-9-]+$

The name of the Azure Video Indexer account.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
location True

string

The geo-location where the resource lives

identity

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

properties.accountId

string

The account's data-plane ID. This can be set only when connecting an existing classic account

properties.openAiServices

OpenAiServicesForPutRequest

The openAi services details

properties.privateEndpointConnections

PrivateEndpointConnection[]

List of private endpoint connections associated with the account.

properties.publicNetworkAccess

PublicNetworkAccess

Whether or not public network access is allowed for the account.

properties.storageServices

StorageServicesForPutRequest

The storage services details

tags

object

Resource tags.

Responses

Name Type Description
200 OK

Account

The resource was successfully updated.

201 Created

Account

The resource was successfully created.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Connect classic account to arm account using system assigned Mi
Connect classic account to arm account using user assigned Mi
Create or update account with system assigned Mi
Create or update account with user assigned Mi

Connect classic account to arm account using system assigned Mi

Sample request

PUT https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer?api-version=2025-04-01

{
  "location": "NorthEurope",
  "properties": {
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    }
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Connect classic account to arm account using user assigned Mi

Sample request

PUT https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer?api-version=2025-04-01

{
  "location": "NorthEurope",
  "properties": {
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}
    }
  }
}

Sample response

{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      }
    }
  }
}
{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      }
    }
  }
}

Create or update account with system assigned Mi

Sample request

PUT https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer?api-version=2025-04-01

{
  "location": "NorthEurope",
  "properties": {
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms"
    }
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Create or update account with user assigned Mi

Sample request

PUT https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer?api-version=2025-04-01

{
  "location": "NorthEurope",
  "properties": {
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2"
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {},
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {}
    }
  }
}

Sample response

{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer",
  "name": "contosto-videoanalyzer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      },
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      }
    }
  }
}
{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer",
  "name": "contoso-videoindexer",
  "location": "NorthEurope",
  "type": "Microsoft.VideoIndexer/accounts",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contoso-videoindexer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi"
    },
    "openAiServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2"
    },
    "totalSecondsIndexed": 0,
    "totalMinutesIndexed": 0,
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      },
      "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": {
        "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726",
        "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed"
      }
    }
  }
}

Definitions

Name Description
Account

An Azure Video Indexer account.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

OpenAiServicesForPutRequest

The openAi services details

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The private endpoint connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

provisioningState

Gets the status of the account at the time the operation was called.

PublicNetworkAccess

Whether or not public network access is allowed for the account.

StorageServicesForPutRequest

The storage services details

systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

User assigned identity properties

Account

An Azure Video Indexer account.

Name Type Default value Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.accountId

string

00000000-0000-0000-0000-000000000000

The account's data-plane ID. This can be set only when connecting an existing classic account

properties.accountName

string

The account's name

properties.openAiServices

OpenAiServicesForPutRequest

The openAi services details

properties.privateEndpointConnections

PrivateEndpointConnection[]

List of private endpoint connections associated with the account.

properties.provisioningState

provisioningState

Gets the status of the account at the time the operation was called.

properties.publicNetworkAccess

PublicNetworkAccess

Whether or not public network access is allowed for the account.

properties.storageServices

StorageServicesForPutRequest

The storage services details

properties.tenantId

string

The account's tenant id

properties.totalMinutesIndexed

integer (int64)

An integer representing the total minutes that have been indexed on the account

properties.totalSecondsIndexed

integer (int32)

An integer representing the total seconds that have been indexed on the account

systemData

systemData

The system meta data relating to this resource.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name Type Description
principalId

string (uuid)

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId

string (uuid)

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identities
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OpenAiServicesForPutRequest

The openAi services details

Name Type Description
resourceId

string (arm-id)

The openAi services resource id

userAssignedIdentity

string

The user assigned identity to be used to grant permissions

PrivateEndpoint

The private endpoint resource.

Name Type Description
id

string

The ARM identifier for private endpoint.

PrivateEndpointConnection

The private endpoint connection resource.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

The name of the resource

properties.groupIds

string[]

The group ids for the private endpoint resource.

properties.privateEndpoint

PrivateEndpoint

The private endpoint resource.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection resource.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Value Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Value Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionsRequired

string

A message indicating if changes on the service provider require any updates on the consumer.

description

string

The reason for approval/rejection of the connection.

status

PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

provisioningState

Gets the status of the account at the time the operation was called.

Value Description
Succeeded
Failed
Canceled
Accepted
Provisioning
Deleting

PublicNetworkAccess

Whether or not public network access is allowed for the account.

Value Description
Enabled
Disabled

StorageServicesForPutRequest

The storage services details

Name Type Description
resourceId

string (arm-id)

The storage services resource id

userAssignedIdentity

string

The user assigned identity to be used to grant permissions

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentity

User assigned identity properties

Name Type Description
clientId

string (uuid)

The client ID of the assigned identity.

principalId

string (uuid)

The principal ID of the assigned identity.