openapi_client.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi

All URIs are relative to /dataservice

Method	HTTP request	Description
create_policy_definition4	POST /template/policy/definition/hubandspoke
delete_policy_definition4	DELETE /template/policy/definition/hubandspoke/{id}
edit_multiple_policy_definition4	PUT /template/policy/definition/hubandspoke/multiple/{id}
edit_policy_definition4	PUT /template/policy/definition/hubandspoke/{id}
get_definitions4	GET /template/policy/definition/hubandspoke
get_policy_definition4	GET /template/policy/definition/hubandspoke/{id}
preview_policy_definition4	POST /template/policy/definition/hubandspoke/preview
preview_policy_definition_by_id4	GET /template/policy/definition/hubandspoke/preview/{id}
save_policy_definition_in_bulk4	PUT /template/policy/definition/hubandspoke/bulk

create_policy_definition4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_definition4()

Create policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.create_policy_definition4(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->create_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy definition	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_policy_definition4

delete_policy_definition4(id)

Delete policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_instance.delete_policy_definition4(id)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->delete_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_multiple_policy_definition4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_multiple_policy_definition4(id)

Edit multiple policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.edit_multiple_policy_definition4(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_multiple_policy_definition4: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.edit_multiple_policy_definition4(id, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_multiple_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy definition	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_policy_definition4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_definition4(id)

Edit a policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.edit_policy_definition4(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_policy_definition4: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.edit_policy_definition4(id, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->edit_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy definition	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_definitions4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_definitions4()

Get policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_definitions4()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->get_definitions4: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_policy_definition4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_policy_definition4(id)

Get a specific policy definitions

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_policy_definition4(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->get_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_definition4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition4()

Preview policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.preview_policy_definition4(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->preview_policy_definition4: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy definition	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_definition_by_id4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_definition_by_id4(id)

Preview policy definition

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.preview_policy_definition_by_id4(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->preview_policy_definition_by_id4: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

save_policy_definition_in_bulk4

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} save_policy_definition_in_bulk4()

Create/Edit policy definitions in bulk

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_hub_and_spoke_definition_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_hub_and_spoke_definition_builder_api.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy definition (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.save_policy_definition_in_bulk4(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicyHubAndSpokeDefinitionBuilderApi->save_policy_definition_in_bulk4: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy definition	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md

Latest commit

History

ConfigurationPolicyHubAndSpokeDefinitionBuilderApi.md

File metadata and controls

openapi_client.ConfigurationPolicyHubAndSpokeDefinitionBuilderApi

create_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_multiple_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_definitions4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

preview_policy_definition4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

preview_policy_definition_by_id4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

save_policy_definition_in_bulk4

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details