Compartilhar via


Subscription - Create Or Update

Cria ou atualiza a assinatura do usuário especificado para o produto especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2024-05-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2024-05-01&appType={appType}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

O nome do serviço de Gerenciamento de API.

sid
path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

appType
query

AppType

Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal do editor herdado.

notify
query

boolean

Notifique a alteração no Estado da Assinatura.

  • Se for falso, não envie nenhuma notificação por email para alteração do estado da assinatura
  • Se for true, envie uma notificação por email sobre a alteração do estado da assinatura

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
If-Match

string

ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.displayName True

string

minLength: 1
maxLength: 100

Nome da assinatura.

properties.scope True

string

Escopo como /products/{productId} ou /apis ou /apis/{apiId}.

properties.allowTracing

boolean

Determina se o rastreamento pode ser habilitado

properties.ownerId

string

Usuário (caminho da ID do usuário) para quem a assinatura está sendo criada no formulário /users/{userId}

properties.primaryKey

string

minLength: 1
maxLength: 256

Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

properties.secondaryKey

string

minLength: 1
maxLength: 256

Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

properties.state

SubscriptionState

Estado inicial da assinatura. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

Respostas

Nome Tipo Description
200 OK

SubscriptionContract

O usuário já assinou o produto.

Cabeçalhos

ETag: string

201 Created

SubscriptionContract

O usuário foi inscrito com êxito no produto.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateSubscription

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definições

Nome Description
AppType

Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal do editor herdado.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

SubscriptionContract

Detalhes da assinatura.

SubscriptionCreateParameters

Detalhes de criação de assinatura.

SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

AppType

Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal do editor herdado.

Valor Description
developerPortal

A solicitação de criação do usuário foi enviada pelo novo portal do desenvolvedor.

portal

A solicitação de criação do usuário foi enviada pelo portal do desenvolvedor herdado.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

SubscriptionContract

Detalhes da assinatura.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.allowTracing

boolean

Determina se o rastreamento está habilitado

properties.createdDate

string (date-time)

Data de criação da assinatura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.displayName

string

minLength: 0
maxLength: 100

O nome da assinatura ou nulo se a assinatura não tiver nome.

properties.endDate

string (date-time)

Data em que a assinatura foi cancelada ou expirou. A configuração é somente para fins de auditoria e a assinatura não é cancelada automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.expirationDate

string (date-time)

Data de validade da assinatura. A configuração é somente para fins de auditoria e a assinatura não expira automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.notificationDate

string (date-time)

Data de notificação de expiração da assinatura futura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.ownerId

string

O identificador de recurso do usuário do proprietário da assinatura. O valor é uma URL relativa válida no formato /users/{userId} em que {userId} é um identificador de usuário.

properties.primaryKey

string

minLength: 1
maxLength: 256

Chave primária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

properties.scope

string

Escopo como /products/{productId} ou /apis ou /apis/{apiId}.

properties.secondaryKey

string

minLength: 1
maxLength: 256

Chave secundária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

properties.startDate

string (date-time)

Data de ativação da assinatura. A configuração é somente para fins de auditoria e a assinatura não é ativada automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.state

SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

properties.stateComment

string

Comentário de assinatura opcional adicionado por um administrador quando o estado é alterado para "rejeitado".

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Detalhes de criação de assinatura.

Nome Tipo Description
properties.allowTracing

boolean

Determina se o rastreamento pode ser habilitado

properties.displayName

string

minLength: 1
maxLength: 100

Nome da assinatura.

properties.ownerId

string

Usuário (caminho da ID do usuário) para quem a assinatura está sendo criada no formulário /users/{userId}

properties.primaryKey

string

minLength: 1
maxLength: 256

Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

properties.scope

string

Escopo como /products/{productId} ou /apis ou /apis/{apiId}.

properties.secondaryKey

string

minLength: 1
maxLength: 256

Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

properties.state

SubscriptionState

Estado inicial da assinatura. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

SubscriptionState

Estado da assinatura. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs do produto, * enviada – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirado – a assinatura atingiu a data de validade e foi desativada.

Valor Description
active
cancelled
expired
rejected
submitted
suspended