Accounts - List Sas

Serviço:: Maps Management

Versão da API:: 2023-06-01

Crie e liste um token de assinatura de acesso compartilhado de conta. Use esse token SAS para autenticação em APIs REST do Azure Maps por meio de vários SDKs do Azure Maps. Como pré-requisito para criar um token SAS.

Pré-requisitos:

Crie ou tenha uma Identidade Gerenciada Atribuída ao Usuário existente na mesma região do Azure que a conta.
Crie ou atualize uma conta do Mapa do Azure com a mesma região do Azure em que a Identidade Gerenciada Atribuída pelo Usuário é colocada.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listSas?api-version=2023-06-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da Conta do Google Maps.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
expiry	True	string	O deslocamento de data e hora de quando a validade do token expira. Por exemplo "2017-05-24T10:42:03.1567373Z". A duração máxima permitida é de 24 horas entre `start` e `expiry`.
maxRatePerSecond	True	integer (int32) minimum: 0 maximum: 500 exclusiveMinimum: True	Parâmetro obrigatório que representa a solicitação máxima desejada por segundo permitida para o token SAS fornecido. Isso não garante uma precisão perfeita nas medições, mas fornece proteções de aplicação contra abusos com eventual aplicação.
principalId	True	string	O ID principal também conhecido como ID do objeto de uma Identidade Gerenciada Atribuída ao Usuário atualmente atribuída à Conta de Mapa. Para atribuir uma Identidade Gerenciada da conta, use a operação Criar ou Atualizar uma ID de recurso de Identidade Atribuída ao Usuário.
signingKey	True	SigningKey	A chave da conta do Mapa a ser usada para assinatura. Escolher `primaryKey` ou `secondaryKey` usará as Chaves Compartilhadas da conta do Mapa e, usando `managedIdentity`, usará a chave privada renovada automaticamente para assinar a SAS.
start	True	string	O deslocamento de data e hora de quando a validade do token começa. Por exemplo "2017-05-24T10:42:03.1567373Z". A duração máxima permitida é de 24 horas entre `start` e `expiry`.
regions		string[]	Opcional, permite controlar quais locais de região têm acesso permitido às APIs REST do Azure Maps com o token SAS. Exemplo: "eastus", "westus2". Omitir esse parâmetro permitirá que todos os locais da região sejam acessíveis.

Respostas

Name	Tipo	Description
200 OK	MapsAccountSasToken	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

List Account Sas

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/listSas?api-version=2023-06-01

{
  "signingKey": "primaryKey",
  "principalId": "e917f87b-324d-4728-98ed-e31d311a7d65",
  "regions": [
    "eastus"
  ],
  "maxRatePerSecond": 500,
  "start": "2017-05-24T10:42:03.1567373Z",
  "expiry": "2017-05-24T11:42:03.1567373Z"
}

Resposta da amostra

Código de estado:: 200

{
  "accountSasToken": "accountSasToken"
}

Definições

Name	Description
AccountSasParameters	Parâmetros usados para criar um token SAS (Assinatura de Acesso Compartilhado) da conta. O controle de acesso da API REST é fornecido pela identidade e pelo acesso RBAC (Acesso Baseado em Função) do Azure Maps.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
MapsAccountSasToken	Um novo token Sas que pode ser usado para acessar as APIs REST do Google Maps e é controlado pelas permissões de identidade gerenciadas especificadas no Controle de Acesso Baseado em Função do Azure (IAM).
SigningKey	A chave da conta do Mapa a ser usada para assinatura. Escolher `primaryKey` ou `secondaryKey` usará as Chaves Compartilhadas da conta do Mapa e, usando `managedIdentity`, usará a chave privada renovada automaticamente para assinar a SAS.

AccountSasParameters

Object

Parâmetros usados para criar um token SAS (Assinatura de Acesso Compartilhado) da conta. O controle de acesso da API REST é fornecido pela identidade e pelo acesso RBAC (Acesso Baseado em Função) do Azure Maps.

Name	Tipo	Default value	Description
expiry	string		O deslocamento de data e hora de quando a validade do token expira. Por exemplo "2017-05-24T10:42:03.1567373Z". A duração máxima permitida é de 24 horas entre `start` e `expiry`.
maxRatePerSecond	integer (int32) minimum: 0 maximum: 500 exclusiveMinimum: True	500	Parâmetro obrigatório que representa a solicitação máxima desejada por segundo permitida para o token SAS fornecido. Isso não garante uma precisão perfeita nas medições, mas fornece proteções de aplicação contra abusos com eventual aplicação.
principalId	string		O ID principal também conhecido como ID do objeto de uma Identidade Gerenciada Atribuída ao Usuário atualmente atribuída à Conta de Mapa. Para atribuir uma Identidade Gerenciada da conta, use a operação Criar ou Atualizar uma ID de recurso de Identidade Atribuída ao Usuário.
regions	string[]		Opcional, permite controlar quais locais de região têm acesso permitido às APIs REST do Azure Maps com o token SAS. Exemplo: "eastus", "westus2". Omitir esse parâmetro permitirá que todos os locais da região sejam acessíveis.
signingKey	SigningKey		A chave da conta do Mapa a ser usada para assinatura. Escolher `primaryKey` ou `secondaryKey` usará as Chaves Compartilhadas da conta do Mapa e, usando `managedIdentity`, usará a chave privada renovada automaticamente para assinar a SAS.
start	string		O deslocamento de data e hora de quando a validade do token começa. Por exemplo "2017-05-24T10:42:03.1567373Z". A duração máxima permitida é de 24 horas entre `start` e `expiry`.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

MapsAccountSasToken

Object

Um novo token Sas que pode ser usado para acessar as APIs REST do Google Maps e é controlado pelas permissões de identidade gerenciadas especificadas no Controle de Acesso Baseado em Função do Azure (IAM).

Name	Tipo	Description
accountSasToken	string	O token de acesso à assinatura de acesso compartilhado.

SigningKey

Enumeração

A chave da conta do Mapa a ser usada para assinatura. Escolher primaryKey ou secondaryKey usará as Chaves Compartilhadas da conta do Mapa e, usando managedIdentity, usará a chave privada renovada automaticamente para assinar a SAS.

Valor	Description
primaryKey
secondaryKey
managedIdentity