Scheduled Actions - Check Name Availability By Scope

Referência

Serviço:: Cost Management

Versão da API:: 2024-08-01

Verifica a disponibilidade e a correção do nome para uma ação agendada dentro do escopo especificado.

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
scope	path	True	string	O escopo associado às operações de ação agendadas. Isso inclui 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para escopo da Conta de Cobrança Externa e 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo de Assinatura Externa. Observação: Os Alertas do Insight só estão disponíveis no escopo da assinatura.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
name	string	O nome do recurso para o qual a disponibilidade precisa ser verificada.
type	string	O tipo de recurso.

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResponse	Resposta da disponibilidade do nome da ação agendada.
Other Status Codes	ErrorResponseWithNestedDetails	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

ScheduledActionCheckNameAvailabilityByScope

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/checkNameAvailability?api-version=2024-08-01

{
  "name": "testName",
  "type": "Microsoft.CostManagement/ScheduledActions"
}

Resposta de exemplo

Código de status:: 200

{
  "nameAvailable": true
}

Definições

Nome	Description
CheckNameAvailabilityReason	O motivo pelo qual o nome fornecido não está disponível.
CheckNameAvailabilityRequest	O corpo da solicitação de disponibilidade de verificação.
CheckNameAvailabilityResponse	O resultado da disponibilidade de verificação.
ErrorDetailsWithNestedDetails	Os detalhes do erro.
ErrorResponseWithNestedDetails	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

CheckNameAvailabilityReason

O motivo pelo qual o nome fornecido não está disponível.

Nome	Tipo	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

O corpo da solicitação de disponibilidade de verificação.

Nome	Tipo	Description
name	string	O nome do recurso para o qual a disponibilidade precisa ser verificada.
type	string	O tipo de recurso.

CheckNameAvailabilityResponse

O resultado da disponibilidade de verificação.

Nome	Tipo	Description
message	string	Motivo detalhado pelo qual o nome fornecido está disponível.
nameAvailable	boolean	Indica se o nome do recurso está disponível.
reason	CheckNameAvailabilityReason	O motivo pelo qual o nome fornecido não está disponível.

ErrorDetailsWithNestedDetails

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro.
details	ErrorDetailsWithNestedDetails[]	Os detalhes adicionais do erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponseWithNestedDetails

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome	Tipo	Description
error	ErrorDetailsWithNestedDetails	Os detalhes do erro.

Compartilhar via