crayon python sdk
v1.0.0
Este projeto é um SDK para a API Cloudiq do Crayon que pode ser usada em scripts e aplicativos Python. Fornece uma interface simples para autenticar com a API usando OAuth2. Pode ser usado para criar inquilinos, criar assinaturas de licenciamento e monitorar o faturamento. Qualquer coisa que possa ser feita no portal Cloud-IQ pode ser automatizada usando este pacote.
Inclui vários esquema de dados pré-configurado e métodos de API. Blocos de dados personalizados podem ser publicados na API como dicionários de Python. Métodos de repouso: Get, Post, Patch, Put e Excluir podem ser chamados com um terminal de API e dicionário de dados como argumentos.
pip install crayon-cloudiq-sdk
Como criar credenciais de clientes da API da Cloud-IQ
Crie um novo script python
Importar a classe Cloudiq
from cloudiq import CloudIQ
Inicialize uma instância da classe Cloudiq com credenciais de usuário válidas:
from cloudiq import CloudIQ
CLIENT_ID = xxxxxxx-xxxx-xxxx-xxxx-xxxxxx
CLIENT_SECRET = xxxxxxx-xxxx-xxxx-xxxx-xxxxxx
USERNAME = "[email protected]"
PASSWORD = "Password123456"
crayon_api = CloudIQ(CLIENT_ID,CLIENT_SECRET,USERNAME,PASSWORD)
A maneira preferida de importar credenciais é através das variáveis ENV.
from os import getenv
from cloudiq import CloudIQ
CLIENT_ID = getenv('CLIENT_ID')
CLIENT_SECRET = getenv('CLIENT_SECRET')
USERNAME = getenv('CLOUDIQ_USER')
PASSWORD = getenv('CLOUDIQ_PW')
crayon_api = CloudIQ(CLIENT_ID,CLIENT_SECRET,USERNAME,PASSWORD)
As variáveis ENV podem ser definidas usando vários métodos, incluindo injeção, se estiver usando contêineres e pipelines ou através de um gerente de segredos, como o Azure Keyvault. Para defini -los em um sistema local usando o Bash, execute os seguintes comandos:
export CLIENT_ID="xxxxxxx-xxxx-xxxx-xxxx-xxxxxx"
export CLIENT_SECRET="xxxxxxx-xxxx-xxxx-xxxx-xxxxxx"
export USERNAME="[email protected]"
export PASSWORD="Password123456"
Um método alternativo é usar um arquivo config.ini contendo as credenciais e recuperá -las usando o módulo ConfigParser.
import configparser
from cloudiq import CloudIQ
# Parse configuration file
try:
config = configparser.ConfigParser()
config.read('config.ini')
ID = config['CRAYON_API']['ID']
SECRET = config['CRAYON_API']['SECRET']
USER = config['CRAYON_API']['USER']
PASS = config['CRAYON_API']['PASS']
except configparser.Error:
print("Configuration Error...config.ini not found")
exit()
except KeyError:
print("Configuration Error...configuration not found in config.ini")
exit()
crayon_api = CloudIQ(CLIENT_ID,CLIENT_SECRET,USERNAME,PASSWORD)
Consulte Exemplos Pasta para demos de autenticação usando pipelines ConfigParser, Env e Azure DevOps
Os dados retornados pela API são salvos em um objeto de resposta (exceto para GetToken e ValdateToken). O objeto de resposta contém valores como o status_code, cabeçalhos, cookies e o texto retornado pela chamada da API.
Para retornar os dados JSON da resposta da resposta Response.json () Método
Para retornar o código de status, use a resposta.status_code variável
Todas as chamadas de API bem -sucedidas retornam 200 OK , 201 criadas ou 204 sem conteúdo
A maioria das respostas de erro também fornece uma mensagem de erro detalhada em formato JSON
Se você receber um erro de 500, a carga útil do esquema de dados provavelmente será o problema. Pode ser formatado incorretamente ou ausente campos necessários.
Lembre -se de lidar com os status de erro ao escrever automações
response = crayon_api.me()
if(int(response.status_code) == 200):
# Handle JSON data
print(response.json())
else:
# Handle Error
print(response.status_code)
exit(1)
Para uma explicação completa dos campos dentro de um objeto de resposta, revise as informações nos seguintes links:
Documentação da classe Official Requests.Response: https://docs.python-requests.org/en/latest/api/#requests.pressonse
Escolas W3: https://www.w3schools.com/python/ref_requests_Response.asp
Faça um teste de teste não autenticado para a API
response = crayon_api.ping()
print(response,json())
Obtenha informações sobre o usuário atualmente autenticado
response = crayon_api.me()
print(response.json())
Faça uma solicitação GET RAW:
# retrieves all products in the Azure Active Directory product family within Org 123456
params = {
'OrganizationId': 123456,
'Include.ProductFamilyNames': 'Azure Active Directory'
}
# make a GET request to https://api.crayon.com/api/v1/AgreementProducts
response = crayon_api.get("https://api.crayon.com/api/v1/AgreementProducts",params)
print(response.json())
Os dados podem ser enviados à API como um objeto de dicionário Python padrão
Recuperar um token de autorização válido:
response = crayon_api.getToken()
print(response)
Crie um inquilino usando o esquema CustomerTenantDetailed:
# Set Unique Tenant Variables
tenant_name = "tenant_name"
domain_prefix = "domain_prefix"
# Initialize Tenant and Agreement objects
tenant = crayon_api.CustomerTenantDetailed(
tenant_name=tenant_name,
domain_prefix=domain_prefix,
org_id=111111,
org_name="Fake Org",
invoice_profile_id=80408, # Default
contact_firstname="First",
contact_lastname="Last",
contact_email="[email protected]",
contact_phone="5555555555",
address_firstname="First",
address_lastname="Last",
address_address="75 NoWhere Lane",
address_city="Boston",
address_countrycode="US",
address_region="MA",
address_zipcode="02109"
)
agreement = crayon_api.CustomerTenantAgreement(
firstname="First",
lastname="Last",
phone_number="5555555555",
email="[email protected]"
)
#Create New Tenant
new_tenant = crayon_api.createTenant(tenant.tenant)
print(new_tenant.json())
# Agree to Microsoft Customer Agreement
tenant_id = new_tenant["Tenant"]["Id"]
agreement = crayon_api.createTenantAgreement(tenant_id,agreement.agreement)
print(agreement.json())
Compre uma licença da Microsoft para um inquilino usando o esquema Subscription Dettailed:
tenant_id=123456
# Create Subscription objects
azure_subscription = crayon_api.SubscriptionDetailed(
name="Azure P2 Subscription",
tenant_id=tenant_id,
part_number="CFQ7TTC0LFK5:0001",
quantity=1,
billing_cycle=1,
duration="P1M"
)
# Create Azure P2 Subscription
subscription = crayon_api.createSubscription(azure_subscription.subscription)
print(subscription.json)
from cloudiq import CloudIQ
help(CloudIQ)
